git.m6w6.name Git - awesomized/libmemcached/blob - docs/Makefile.am

   1 # This file generates all of man/html pages that we use for documentation.
   2 #
   3 # When hacking this file you need to know that we take .pod files and turn
   4 # them into .pop files. .pop files are 1=1 for man pages, but one .pod
   5 # file may generate many .pop files.
   6 #
   7 #    -Brian
   8 #
   9 #
  10 CLEANFILES= *.1 *.3 *.html *.pop
  11
  12 AUTO_PAGES= \
  13         memcached_increment \
  14         memcached_increment_with_initial \
  15         memcached_decrement \
  16         memcached_decrement_with_initial
  17
  18 SET_PAGES= \
  19            memcached_set \
  20            memcached_set_by_key \
  21            memcached_cas \
  22            memcached_cas_by_key \
  23            memcached_replace \
  24            memcached_replace_by_key \
  25            memcached_add memcached_add_by_key \
  26            memcached_prepend \
  27            memcached_prepend_by_key \
  28            memcached_append \
  29            memcached_append_by_key
  30
  31 CREATE_PAGES= \
  32              memcached_create \
  33              memcached_free \
  34              memcached_clone
  35
  36 DELETE_PAGES= \
  37               memcached_delete \
  38               memcached_delete_by_key
  39
  40 GET_PAGES= \
  41            memcached_get \
  42            memcached_get_by_key \
  43            memcached_fetch_result \
  44            memcached_fetch_execute \
  45            memcached_mget \
  46            memcached_mget_by_key \
  47            memcached_mget_execute \
  48            memcached_mget_execute_by_key \
  49            memcached_fetch
  50
  51 RESULT_PAGES= \
  52               memcached_result_cas \
  53               memcached_result_create \
  54               memcached_result_flags \
  55               memcached_result_free \
  56               memcached_result_key_length \
  57               memcached_result_key_value \
  58               memcached_result_length \
  59               memcached_result_st \
  60               memcached_result_value
  61
  62
  63 SERVER_PAGES= \
  64               memcached_server_count \
  65               memcached_server_list \
  66               memcached_server_add \
  67               memcached_server_add_unix_socket \
  68               memcached_server_push
  69
  70 SERVER_ST_PAGES= \
  71                  memcached_server_list_free \
  72                  memcached_server_list_count \
  73                  memcached_server_list_append \
  74                  memcached_servers_parse
  75
  76 HTML_FILES= \
  77             hashkit_create.html \
  78             hashkit_functions.html \
  79             hashkit_value.html \
  80             libmemcached_examples.html \
  81             libmemcached.html \
  82             libmemcachedutil.html \
  83             memcached_analyze.html \
  84             memcached_auto.html \
  85             memcached_behavior.html \
  86             memcached_callback.html \
  87             memcached_create.html \
  88             memcached_delete.html \
  89             memcached_dump.html \
  90             memcached_flush_buffers.html \
  91             memcached_flush.html \
  92             memcached_generate_hash_value.html \
  93             memcached_get.html \
  94             memcached_memory_allocators.html \
  95             memcached_pool.html \
  96             memcached_quit.html \
  97             memcached_result_st.html \
  98             memcached_servers.html \
  99             memcached_server_st.html \
 100             memcached_set.html \
 101             memcached_stats.html \
 102             memcached_strerror.html \
 103             memcached_user_data.html \
 104             memcached_verbosity.html \
 105             memcached_version.html \
 106             memcapable.html \
 107             memcat.html \
 108             memcp.html \
 109             memdump.html \
 110             memerror.html \
 111             memflush.html \
 112             memrm.html \
 113             memslap.html \
 114             memstat.html
 115
 116 EXTRA_DIST = \
 117           hashkit_create.pod \
 118           hashkit_functions.pod \
 119           hashkit_value.pod \
 120           libmemcached.pod \
 121           libmemcached_examples.pod \
 122           libmemcachedutil.pod \
 123           memcached_analyze.pod \
 124           memcached_auto.pod \
 125           memcached_behavior.pod \
 126           memcached_callback.pod \
 127           memcached_create.pod \
 128           memcached_delete.pod \
 129           memcached_dump.pod \
 130           memcached_flush.pod \
 131           memcached_flush_buffers.pod \
 132           memcached_generate_hash_value.pod \
 133           memcached_get.pod \
 134           memcached_memory_allocators.pod \
 135           memcached_pool.pod \
 136           memcached_quit.pod \
 137           memcached_server_st.pod \
 138           memcached_servers.pod \
 139           memcached_set.pod \
 140           memcached_stats.pod \
 141           memcached_strerror.pod \
 142           memcached_user_data.pod \
 143           memcached_verbosity.pod \
 144           memcached_version.pod \
 145           memcapable.pod \
 146           memcat.pod \
 147           memcp.pod \
 148           memdump.pod \
 149           memerror.pod \
 150           memflush.pod \
 151           memrm.pod \
 152           memslap.pod \
 153           memstat.pod
 154
 155 man_MANS = ${set_} \
 156           libmemcached.3 \
 157           libmemcached_examples.3 \
 158           memcached_add.3 \
 159           memcached_add_by_key.3 \
 160           memcached_analyze.3 \
 161           memcached_append.3 \
 162           memcached_append_by_key.3 \
 163           memcached_behavior_get.3 \
 164           memcached_behavior_set.3 \
 165           memcached_callback_get.3 \
 166           memcached_callback_set.3 \
 167           memcached_cas.3 \
 168           memcached_cas_by_key.3 \
 169           memcached_clone.3 \
 170           memcached_create.3 \
 171           memcached_decrement.3 \
 172           memcached_decrement_with_initial.3 \
 173           memcached_delete.3 \
 174           memcached_delete_by_key.3 \
 175           memcached_dump.3 \
 176           memcached_fetch.3 \
 177           memcached_fetch_execute.3 \
 178           memcached_fetch_result.3 \
 179           memcached_flush_buffers.3 \
 180           memcached_free.3 \
 181           memcached_generate_hash_value.3 \
 182           memcached_get.3 \
 183           memcached_get_by_key.3 \
 184           memcached_get_memory_allocators.3 \
 185           memcached_get_user_data.3 \
 186           memcached_increment.3 \
 187           memcached_increment_with_initial.3 \
 188           memcached_lib_version.3 \
 189           memcached_mget.3 \
 190           memcached_mget_by_key.3 \
 191           memcached_mget_execute.3  \
 192           memcached_mget_execute_by_key.3  \
 193           memcached_prepend.3 \
 194           memcached_prepend_by_key.3 \
 195           memcached_quit.3 \
 196           memcached_replace.3 \
 197           memcached_replace_by_key.3 \
 198           memcached_server_add.3 \
 199           memcached_server_count.3 \
 200           memcached_server_list.3 \
 201           memcached_server_list_append.3 \
 202           memcached_server_list_count.3 \
 203           memcached_server_list_free.3 \
 204           memcached_server_push.3 \
 205           memcached_servers_parse.3 \
 206           memcached_set.3 \
 207           memcached_set_by_key.3 \
 208           memcached_set_memory_allocators.3 \
 209           memcached_set_user_data.3 \
 210           memcached_stat.3 \
 211           memcached_stat_get_keys.3 \
 212           memcached_stat_get_value.3 \
 213           memcached_stat_servername.3 \
 214           memcached_strerror.3 \
 215           memcached_verbosity.3 \
 216           memcached_version.3 \
 217           memcapable.1 \
 218           memcat.1 \
 219           memcp.1 \
 220           memdump.1 \
 221           memerror.1 \
 222           memflush.1 \
 223           memrm.1 \
 224           memslap.1 \
 225           memstat.1
 226
 227 if BUILD_LIBMEMCACHEDUTIL
 228 man_MANS+= \
 229           libmemcachedutil.3 \
 230           memcached_pool_behavior_set.3 \
 231           memcached_pool_behavior_get.3 \
 232           memcached_pool_create.3 \
 233           memcached_pool_destroy.3 \
 234           memcached_pool_push.3 \
 235           memcached_pool_pop.3
 236 endif
 237
 238
 239 ${CREATE_PAGES}:
 240         @rm -f $@.pop
 241         ln -s ${top_srcdir}/docs/memcached_create.pod ${top_builddir}/docs/$@.pop
 242
 243 ${SET_PAGES}:
 244         @rm -f $@.pop
 245         ln -s ${top_srcdir}/docs/memcached_set.pod ${top_builddir}/docs/$@.pop
 246
 247 ${DELETE_PAGES}:
 248         @rm -f $@.pop
 249         ln -s ${top_srcdir}/docs/memcached_delete.pod ${top_builddir}/docs/$@.pop
 250
 251 ${AUTO_PAGES}:
 252         @rm -f $@.pop
 253         ln -s ${top_srcdir}/docs/memcached_auto.pod ${top_builddir}/docs/$@.pop
 254
 255 ${GET_PAGES}:
 256         @rm -f $@.pop
 257         ln -s ${top_srcdir}/docs/memcached_get.pod ${top_builddir}/docs/$@.pop
 258
 259 ${SERVER_PAGES}:
 260         @rm -f $@.pop
 261         ln -s ${top_srcdir}/docs/memcached_servers.pod ${top_builddir}/docs/$@.pop
 262
 263 ${SERVER_ST_PAGES}:
 264         @rm -f $@.pop
 265         ln -s ${top_srcdir}/docs/memcached_server_st.pod ${top_builddir}/docs/$@.pop
 266
 267 ${GENERIC_PAGES}:
 268         @rm -f $@.pop
 269         ln -s ${top_srcdir}/docs/$@.pod ${top_builddir}/docs/$@.pop
 270
 271 GENERIC_PAGES= \
 272         libmemcached \
 273         libmemcached_examples \
 274         libmemcachedutil \
 275         memcached_analyze \
 276         memcached_dump \
 277         memcached_flush \
 278         memcached_flush_buffers \
 279         memcached_generate_hash_value \
 280         memcached_quit \
 281         memcached_strerror \
 282         memcached_verbosity \
 283         memcapable \
 284         memcat \
 285         memcp \
 286         memdump \
 287         memerror \
 288         memflush \
 289         memrm \
 290         memslap \
 291         memstat
 292
 293 BEHAVIOR_PAGES= \
 294         memcached_behavior_get \
 295         memcached_behavior_set
 296
 297 ${BEHAVIOR_PAGES}:
 298         @rm -f $@.pop
 299         ln -s ${top_srcdir}/docs/memcached_behavior.pod ${top_builddir}/docs/$@.pop
 300
 301 CALLBACK_PAGES= \
 302         memcached_callback_get \
 303         memcached_callback_set
 304
 305 ${CALLBACK_PAGES}:
 306         @rm -f $@.pop
 307         ln -s ${top_srcdir}/docs/memcached_callback.pod ${top_builddir}/docs/$@.pop
 308
 309 STATS_PAGES= \
 310         memcached_stat \
 311         memcached_stat_get_keys \
 312         memcached_stat_get_value \
 313         memcached_stat_servername
 314
 315 ${STATS_PAGES}:
 316         @rm -f $@.pop
 317         ln -s ${top_srcdir}/docs/memcached_stats.pod ${top_builddir}/docs/$@.pop
 318
 319 ${RESULT_PAGES}:
 320         @rm -f $@.pop
 321         ln -s ${top_srcdir}/docs/memcached_result_st.pod ${top_builddir}/docs/$@.pop
 322
 323 VERSION_PAGES= \
 324                memcached_version \
 325                memcached_lib_version
 326
 327 ${VERSION_PAGES}:
 328         @rm -f $@.pop
 329         ln -s ${top_srcdir}/docs/memcached_version.pod ${top_builddir}/docs/$@.pop
 330
 331 MEMORY_ALLOCATORS_PAGES= \
 332                          memcached_get_memory_allocators \
 333                          memcached_set_memory_allocators
 334
 335 ${MEMORY_ALLOCATORS_PAGES}:
 336         @rm -f $@.pop
 337         ln -s ${top_srcdir}/docs/memcached_memory_allocators.pod ${top_builddir}/docs/$@.pop
 338
 339 USER_DATA_PAGES= \
 340                  memcached_get_user_data \
 341                  memcached_set_user_data
 342
 343 ${USER_DATA_PAGES}:
 344         @rm -f $@.pop
 345         ln -s ${top_srcdir}/docs/memcached_user_data.pod ${top_builddir}/docs/$@.pop
 346
 347
 348 POOL_PAGES= \
 349         memcached_pool_behavior_get \
 350         memcached_pool_behavior_set \
 351         memcached_pool_create \
 352         memcached_pool_destroy \
 353         memcached_pool_pop \
 354         memcached_pool_push
 355
 356 ${POOL_PAGES}:
 357         @rm -f $@.pop
 358         ln -s ${top_srcdir}/docs/memcached_pool.pod ${top_builddir}/docs/$@.pop
 359
 360 HASH_CREATE_PAGES= \
 361              hashkit_is_allocated \
 362              hashkit_create \
 363              hashkit_clone \
 364              hashkit_free
 365
 366 ${HASH_CREATE_PAGES}:
 367         @rm -f $@.pop
 368         ln -s ${top_srcdir}/docs/hashkit_create.pod ${top_builddir}/docs/$@.pop
 369
 370 KIT_FUNCTIONS_PAGES= \
 371                      hashkit_crc32 \
 372                      hashkit_fnv1_32 \
 373                      hashkit_fnv1_64 \
 374                      hashkit_fnv1a_32 \
 375                      hashkit_fnv1a_64 \
 376                      hashkit_functions \
 377                      hashkit_hsieh \
 378                      hashkit_jenkins \
 379                      hashkit_md5 \
 380                      hashkit_murmur
 381
 382 ${KIT_FUNCTIONS_PAGES}:
 383         @rm -f $@.pop
 384         ln -s ${top_srcdir}/docs/hashkit_functions.pod ${top_builddir}/docs/$@.pop
 385
 386 HASHKIT_ST_PAGES= \
 387         hashkit_value
 388
 389 ${HASH_KIT_ST_PAGES}:
 390         @rm -f $@.pop
 391         ln -s ${top_srcdir}/docs/hashkit_value.pod ${top_builddir}/docs/$@.pop
 392
 393 test-docs:
 394         ${PODCHECKER} $(top_srcdir)/docs/hashkit_create.pod
 395         ${PODCHECKER} $(top_srcdir)/docs/hashkit_functions.pod
 396         ${PODCHECKER} $(top_srcdir)/docs/hashkit_value.pod
 397         ${PODCHECKER} $(top_srcdir)/docs/libmemcached.pod
 398         ${PODCHECKER} $(top_srcdir)/docs/libmemcached_examples.pod
 399         ${PODCHECKER} $(top_srcdir)/docs/memcached_auto.pod
 400         ${PODCHECKER} $(top_srcdir)/docs/memcached_behavior.pod
 401         ${PODCHECKER} $(top_srcdir)/docs/memcached_callback.pod
 402         ${PODCHECKER} $(top_srcdir)/docs/memcached_create.pod
 403         ${PODCHECKER} $(top_srcdir)/docs/memcached_delete.pod
 404         ${PODCHECKER} $(top_srcdir)/docs/memcached_flush.pod
 405         ${PODCHECKER} $(top_srcdir)/docs/memcached_flush_buffers.pod
 406         ${PODCHECKER} $(top_srcdir)/docs/memcached_get.pod
 407         ${PODCHECKER} $(top_srcdir)/docs/memcached_memory_allocators.pod
 408         ${PODCHECKER} $(top_srcdir)/docs/memcached_pool.pod
 409         ${PODCHECKER} $(top_srcdir)/docs/memcached_quit.pod
 410         ${PODCHECKER} $(top_srcdir)/docs/memcached_server_st.pod
 411         ${PODCHECKER} $(top_srcdir)/docs/memcached_servers.pod
 412         ${PODCHECKER} $(top_srcdir)/docs/memcached_set.pod
 413         ${PODCHECKER} $(top_srcdir)/docs/memcached_stats.pod
 414         ${PODCHECKER} $(top_srcdir)/docs/memcached_strerror.pod
 415         ${PODCHECKER} $(top_srcdir)/docs/memcached_user_data.pod
 416         ${PODCHECKER} $(top_srcdir)/docs/memcached_verbosity.pod
 417         ${PODCHECKER} $(top_srcdir)/docs/memcached_version.pod
 418         ${PODCHECKER} $(top_srcdir)/docs/memcapable.pod
 419         ${PODCHECKER} $(top_srcdir)/docs/memcat.pod
 420         ${PODCHECKER} $(top_srcdir)/docs/memcp.pod
 421         ${PODCHECKER} $(top_srcdir)/docs/memerror.pod
 422         ${PODCHECKER} $(top_srcdir)/docs/memflush.pod
 423         ${PODCHECKER} $(top_srcdir)/docs/memrm.pod
 424         ${PODCHECKER} $(top_srcdir)/docs/memslap.pod
 425         ${PODCHECKER} $(top_srcdir)/docs/memstat.pod
 426
 427 html-pages: $(HTML_FILES)
 428
 429 SUFFIXES: .pop .pod .html .1 .3
 430
 431 .pop: ${_set}
 432
 433 .pop.html:
 434         pod2html --infile=$< >  $@
 435
 436 .pop.1:
 437         ${POD2MAN} -c "$*" -r "" -s 3 $< >  $@
 438
 439 .pop.3: ${_set}
 440         ${POD2MAN} -c "$*" -r "" -s 3 $< >  $@