git.m6w6.name Git - m6w6/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 *.tmp
  11
  12 BUILT_SOURCES=
  13
  14 EXTRA_DIST= make_index.pl
  15
  16 AUTO_PAGES= \
  17             memcached_increment.pop \
  18             memcached_increment_with_initial.pop \
  19             memcached_decrement.pop \
  20             memcached_decrement_with_initial.pop
  21 BUILT_SOURCES += ${AUTO_PAGES}
  22
  23 BEHAVIOR_PAGES= \
  24                 memcached_behavior_get.pop \
  25                 memcached_behavior_set.pop
  26 BUILT_SOURCES += ${BEHAVIOR_PAGES}
  27
  28 CALLBACK_PAGES= \
  29                 memcached_callback_get.pop \
  30                 memcached_callback_set.pop
  31 BUILT_SOURCES += ${CALLBACK_PAGES}
  32
  33 CREATE_PAGES= \
  34               memcached_clone.pop \
  35               memcached_create.pop \
  36               memcached_free.pop \
  37               memcached_servers_reset.pop
  38 BUILT_SOURCES += ${CREATE_PAGES}
  39
  40 DELETE_PAGES= \
  41               memcached_delete.pop \
  42               memcached_delete_by_key.pop
  43 BUILT_SOURCES += ${DELETE_PAGES}
  44
  45 GENERIC_PAGES= \
  46                libmemcached.pop \
  47                libmemcached_examples.pop \
  48                libmemcachedutil.pop \
  49                memcached_analyze.pop \
  50                memcached_dump.pop \
  51                memcached_flush.pop \
  52                memcached_flush_buffers.pop \
  53                memcached_generate_hash_value.pop \
  54                memcached_quit.pop \
  55                memcached_strerror.pop \
  56                memcached_verbosity.pop \
  57                memcapable.pop \
  58                memcat.pop \
  59                memcp.pop \
  60                memdump.pop \
  61                memerror.pop \
  62                memflush.pop \
  63                memrm.pop \
  64                memslap.pop \
  65                memstat.pop
  66 BUILT_SOURCES += ${GENERIC_PAGES}
  67
  68 GET_PAGES= \
  69            memcached_get.pop \
  70            memcached_get_by_key.pop \
  71            memcached_fetch_result.pop \
  72            memcached_fetch_execute.pop \
  73            memcached_mget.pop \
  74            memcached_mget_by_key.pop \
  75            memcached_mget_execute.pop \
  76            memcached_mget_execute_by_key.pop \
  77            memcached_fetch.pop
  78 BUILT_SOURCES += ${GET_PAGES}
  79
  80 MEMORY_ALLOCATORS_PAGES= \
  81                          memcached_get_memory_allocators.pop \
  82                          memcached_set_memory_allocators.pop \
  83                          memcached_set_memory_allocators_context.pop
  84 BUILT_SOURCES += ${MEMORY_ALLOCATORS_PAGES}
  85
  86 POOL_PAGES= \
  87             memcached_pool_behavior_get.pop \
  88             memcached_pool_behavior_set.pop \
  89             memcached_pool_create.pop \
  90             memcached_pool_destroy.pop \
  91             memcached_pool_pop.pop \
  92             memcached_pool_push.pop
  93 BUILT_SOURCES += ${POOL_PAGES}
  94
  95 RESULT_PAGES= \
  96               memcached_result_cas.pop \
  97               memcached_result_create.pop \
  98               memcached_result_flags.pop \
  99               memcached_result_free.pop \
 100               memcached_result_key_length.pop \
 101               memcached_result_key_value.pop \
 102               memcached_result_length.pop \
 103               memcached_result_st.pop \
 104               memcached_result_value.pop
 105 BUILT_SOURCES += ${RESULT_PAGES}
 106
 107
 108 SERVER_PAGES= \
 109               memcached_server_count.pop \
 110               memcached_server_cursor.pop \
 111               memcached_server_list.pop \
 112               memcached_server_add.pop \
 113               memcached_server_add_unix_socket.pop \
 114               memcached_server_push.pop
 115 BUILT_SOURCES += ${SERVER_PAGES}
 116
 117 SERVER_ST_PAGES= \
 118                  memcached_server_list_free.pop \
 119                  memcached_server_list_count.pop \
 120                  memcached_server_list_append.pop \
 121                  memcached_servers_parse.pop
 122 BUILT_SOURCES += ${SERVER_ST_PAGES}
 123
 124 SET_PAGES= \
 125            memcached_set.pop \
 126            memcached_set_by_key.pop \
 127            memcached_cas.pop \
 128            memcached_cas_by_key.pop \
 129            memcached_replace.pop \
 130            memcached_replace_by_key.pop \
 131            memcached_add.pop \
 132            memcached_add_by_key.pop \
 133            memcached_prepend.pop \
 134            memcached_prepend_by_key.pop \
 135            memcached_append.pop \
 136            memcached_append_by_key.pop
 137 BUILT_SOURCES += ${SET_PAGES}
 138
 139 STATS_PAGES= \
 140              memcached_stat.pop \
 141              memcached_stat_execute.pop\
 142              memcached_stat_get_keys.pop\
 143              memcached_stat_get_value.pop \
 144              memcached_stat_servername.pop
 145 BUILT_SOURCES += ${STATS_PAGES}
 146
 147 USER_DATA_PAGES= \
 148                  memcached_get_user_data.pop \
 149                  memcached_set_user_data.pop
 150 BUILT_SOURCES += ${USER_DATA_PAGES}
 151
 152 VERSION_PAGES= \
 153                memcached_version.pop \
 154                memcached_lib_version.pop
 155 BUILT_SOURCES += ${VERSION_PAGES}
 156
 157
 158 #
 159 # These are for libhashkit
 160 #
 161 HASHKIT_CREATE_PAGES= \
 162                       hashkit_is_allocated.pop \
 163                       hashkit_create.pop \
 164                       hashkit_clone.pop \
 165                       hashkit_free.pop
 166 BUILT_SOURCES += ${HASHKIT_CREATE_PAGES}
 167
 168 HASHKIT_FUNCTIONS_PAGES= \
 169                          hashkit_crc32.pop \
 170                          hashkit_fnv1_32.pop \
 171                          hashkit_fnv1_64.pop \
 172                          hashkit_fnv1a_32.pop \
 173                          hashkit_fnv1a_64.pop \
 174                          hashkit_functions.pop \
 175                          hashkit_hsieh.pop \
 176                          hashkit_jenkins.pop \
 177                          hashkit_md5.pop \
 178                          hashkit_murmur.pop
 179 BUILT_SOURCES += ${HASHKIT_FUNCTIONS_PAGES}
 180
 181 HASHKIT_ST_PAGES= \
 182                   hashkit_value.pop
 183 BUILT_SOURCES += ${HASHKIT_ST_PAGES}
 184
 185
 186 HTML_FILES= \
 187             hashkit_clone.html \
 188             hashkit_crc32.html \
 189             hashkit_create.html \
 190             hashkit_fnv1_32.html \
 191             hashkit_fnv1_64.html \
 192             hashkit_fnv1a_32.html \
 193             hashkit_fnv1a_64.html \
 194             hashkit_free.html \
 195             hashkit_functions.html \
 196             hashkit_hsieh.html \
 197             hashkit_is_allocated.html \
 198             hashkit_jenkins.html \
 199             hashkit_md5.html \
 200             hashkit_murmur.html \
 201             hashkit_value.html \
 202             libmemcached_examples.html \
 203             libmemcached.html \
 204             libmemcachedutil.html \
 205             memcached_add_by_key.html \
 206             memcached_add.html \
 207             memcached_analyze.html \
 208             memcached_append_by_key.html \
 209             memcached_append.html \
 210             memcached_behavior_get.html \
 211             memcached_behavior_set.html \
 212             memcached_callback_get.html \
 213             memcached_callback_set.html \
 214             memcached_cas_by_key.html \
 215             memcached_cas.html \
 216             memcached_clone.html \
 217             memcached_create.html \
 218             memcached_decrement.html \
 219             memcached_decrement_with_initial.html \
 220             memcached_delete_by_key.html \
 221             memcached_delete.html \
 222             memcached_dump.html \
 223             memcached_fetch_execute.html \
 224             memcached_fetch.html \
 225             memcached_fetch_result.html \
 226             memcached_flush_buffers.html \
 227             memcached_flush.html \
 228             memcached_free.html \
 229             memcached_generate_hash_value.html \
 230             memcached_get_by_key.html \
 231             memcached_get_memory_allocators.html \
 232             memcached_get.html \
 233             memcached_get_user_data.html \
 234             memcached_increment.html \
 235             memcached_increment_with_initial.html \
 236             memcached_lib_version.html \
 237             memcached_mget_by_key.html \
 238             memcached_mget_execute_by_key.html \
 239             memcached_mget_execute.html \
 240             memcached_mget.html \
 241             memcached_pool_behavior_get.html \
 242             memcached_pool_behavior_set.html \
 243             memcached_pool_create.html \
 244             memcached_pool_destroy.html \
 245             memcached_pool_pop.html \
 246             memcached_pool_push.html \
 247             memcached_prepend_by_key.html \
 248             memcached_prepend.html \
 249             memcached_quit.html \
 250             memcached_replace_by_key.html \
 251             memcached_replace.html \
 252             memcached_result_cas.html \
 253             memcached_result_create.html \
 254             memcached_result_flags.html \
 255             memcached_result_free.html \
 256             memcached_result_key_length.html \
 257             memcached_result_key_value.html \
 258             memcached_result_length.html \
 259             memcached_result_st.html \
 260             memcached_result_value.html \
 261             memcached_server_add.html \
 262             memcached_server_add_unix_socket.html \
 263             memcached_server_count.html \
 264             memcached_server_cursor.html \
 265             memcached_server_list_append.html \
 266             memcached_server_list_count.html \
 267             memcached_server_list_free.html \
 268             memcached_server_list.html \
 269             memcached_server_push.html \
 270             memcached_servers_parse.html \
 271             memcached_set_by_key.html \
 272             memcached_set_memory_allocators.html \
 273             memcached_set.html \
 274             memcached_set_user_data.html \
 275             memcached_stat_execute.html \
 276             memcached_stat_get_keys.html \
 277             memcached_stat_get_value.html \
 278             memcached_stat.html \
 279             memcached_stat_servername.html \
 280             memcached_strerror.html \
 281             memcached_verbosity.html \
 282             memcached_version.html \
 283             memcapable.html \
 284             memcat.html \
 285             memcp.html \
 286             memdump.html \
 287             memerror.html \
 288             memflush.html \
 289             memrm.html \
 290             memslap.html \
 291             memstat.html
 292
 293 POD_FILES= \
 294            hashkit_create.pod \
 295            hashkit_functions.pod \
 296            hashkit_value.pod \
 297            libmemcached.pod \
 298            libmemcached_examples.pod \
 299            libmemcachedutil.pod \
 300            memcached_analyze.pod \
 301            memcached_auto.pod \
 302            memcached_behavior.pod \
 303            memcached_callback.pod \
 304            memcached_create.pod \
 305            memcached_delete.pod \
 306            memcached_dump.pod \
 307            memcached_flush.pod \
 308            memcached_flush_buffers.pod \
 309            memcached_generate_hash_value.pod \
 310            memcached_get.pod \
 311            memcached_memory_allocators.pod \
 312            memcached_pool.pod \
 313            memcached_quit.pod \
 314            memcached_result_st.pod \
 315            memcached_sasl.pod \
 316            memcached_server_st.pod \
 317            memcached_servers.pod \
 318            memcached_set.pod \
 319            memcached_stats.pod \
 320            memcached_strerror.pod \
 321            memcached_user_data.pod \
 322            memcached_verbosity.pod \
 323            memcached_version.pod \
 324            memcapable.pod \
 325            memcat.pod \
 326            memcp.pod \
 327            memdump.pod \
 328            memerror.pod \
 329            memflush.pod \
 330            memrm.pod \
 331            memslap.pod \
 332            memstat.pod
 333 EXTRA_DIST+= $(POD_FILES)
 334
 335 man_MANS = \
 336            hashkit_clone.3 \
 337            hashkit_crc32.3 \
 338            hashkit_create.3 \
 339            hashkit_fnv1_32.3 \
 340            hashkit_fnv1_64.3 \
 341            hashkit_fnv1a_32.3 \
 342            hashkit_fnv1a_64.3 \
 343            hashkit_free.3 \
 344            hashkit_functions.3 \
 345            hashkit_hsieh.3 \
 346            hashkit_is_allocated.3 \
 347            hashkit_jenkins.3 \
 348            hashkit_md5.3 \
 349            hashkit_murmur.3 \
 350            hashkit_value.3 \
 351            libmemcached.3 \
 352            libmemcached_examples.3 \
 353            memcached_add.3 \
 354            memcached_add_by_key.3 \
 355            memcached_analyze.3 \
 356            memcached_append.3 \
 357            memcached_append_by_key.3 \
 358            memcached_behavior_get.3 \
 359            memcached_behavior_set.3 \
 360            memcached_callback_get.3 \
 361            memcached_callback_set.3 \
 362            memcached_cas.3 \
 363            memcached_cas_by_key.3 \
 364            memcached_clone.3 \
 365            memcached_create.3 \
 366            memcached_decrement.3 \
 367            memcached_decrement_with_initial.3 \
 368            memcached_delete.3 \
 369            memcached_delete_by_key.3 \
 370            memcached_dump.3 \
 371            memcached_fetch.3 \
 372            memcached_fetch_execute.3 \
 373            memcached_fetch_result.3 \
 374            memcached_flush_buffers.3 \
 375            memcached_free.3 \
 376            memcached_generate_hash_value.3 \
 377            memcached_get.3 \
 378            memcached_get_by_key.3 \
 379            memcached_get_memory_allocators.3 \
 380            memcached_get_user_data.3 \
 381            memcached_increment.3 \
 382            memcached_increment_with_initial.3 \
 383            memcached_lib_version.3 \
 384            memcached_mget.3 \
 385            memcached_mget_by_key.3 \
 386            memcached_mget_execute.3  \
 387            memcached_mget_execute_by_key.3  \
 388            memcached_prepend.3 \
 389            memcached_prepend_by_key.3 \
 390            memcached_quit.3 \
 391            memcached_replace.3 \
 392            memcached_replace_by_key.3 \
 393            memcached_server_add.3 \
 394            memcached_server_count.3 \
 395            memcached_server_cursor.3 \
 396            memcached_server_list.3 \
 397            memcached_server_list_append.3 \
 398            memcached_server_list_count.3 \
 399            memcached_server_list_free.3 \
 400            memcached_server_push.3 \
 401            memcached_servers_parse.3 \
 402            memcached_set.3 \
 403            memcached_set_by_key.3 \
 404            memcached_set_memory_allocators.3 \
 405            memcached_set_user_data.3 \
 406            memcached_stat.3 \
 407            memcached_stat_execute.3 \
 408            memcached_stat_get_keys.3 \
 409            memcached_stat_get_value.3 \
 410            memcached_stat_servername.3 \
 411            memcached_strerror.3 \
 412            memcached_verbosity.3 \
 413            memcached_version.3 \
 414            memcapable.1 \
 415            memcat.1 \
 416            memcp.1 \
 417            memdump.1 \
 418            memerror.1 \
 419            memflush.1 \
 420            memrm.1 \
 421            memslap.1 \
 422            memstat.1
 423
 424 if HAVE_SASL
 425 POD_FILES+= memcached_sasl.pod
 426 man_MANS+= \
 427            memcached_destroy_sasl_auth_data.3 \
 428            memcached_get_sasl_callbacks.3 \
 429            memcached_sasl_set_auth_data.3 \
 430            memcached_set_sasl_callbacks.3
 431
 432 HTML_FILES+= \
 433            memcached_destroy_sasl_auth_data.html \
 434            memcached_get_sasl_callbacks.html \
 435            memcached_sasl_set_auth_data.html \
 436            memcached_set_sasl_callbacks.html
 437
 438
 439 SASL_PAGES= \
 440            memcached_destroy_sasl_auth_data.pop \
 441            memcached_get_sasl_callbacks.pop \
 442            memcached_sasl_set_auth_data.pop \
 443            memcached_set_sasl_callbacks.pop
 444 BUILT_SOURCES += ${SASL_PAGES}
 445
 446 ${SASL_PAGES}:
 447         @rm -f $@
 448         ln -s ${top_srcdir}/docs/memcached_sasl.pod ${top_builddir}/docs/$@
 449
 450 endif
 451
 452 if BUILD_LIBMEMCACHEDUTIL
 453 man_MANS+= \
 454           libmemcachedutil.3 \
 455           memcached_pool_behavior_set.3 \
 456           memcached_pool_behavior_get.3 \
 457           memcached_pool_create.3 \
 458           memcached_pool_destroy.3 \
 459           memcached_pool_push.3 \
 460           memcached_pool_pop.3
 461 endif
 462
 463
 464 ${CREATE_PAGES}:
 465         @rm -f $@
 466         ln -s ${top_srcdir}/docs/memcached_create.pod ${top_builddir}/docs/$@
 467
 468 ${SET_PAGES}:
 469         @rm -f $@
 470         ln -s ${top_srcdir}/docs/memcached_set.pod ${top_builddir}/docs/$@
 471
 472 ${DELETE_PAGES}:
 473         @rm -f $@
 474         ln -s ${top_srcdir}/docs/memcached_delete.pod ${top_builddir}/docs/$@
 475
 476 ${AUTO_PAGES}:
 477         @rm -f $@
 478         ln -s ${top_srcdir}/docs/memcached_auto.pod ${top_builddir}/docs/$@
 479
 480 ${GET_PAGES}:
 481         @rm -f $@
 482         ln -s ${top_srcdir}/docs/memcached_get.pod ${top_builddir}/docs/$@
 483
 484 ${SERVER_PAGES}:
 485         @rm -f $@
 486         ln -s ${top_srcdir}/docs/memcached_servers.pod ${top_builddir}/docs/$@
 487
 488 ${SERVER_ST_PAGES}:
 489         @rm -f $@
 490         ln -s ${top_srcdir}/docs/memcached_server_st.pod ${top_builddir}/docs/$@
 491
 492 ${GENERIC_PAGES}:
 493         @rm -f $@
 494         ln -s ${top_srcdir}/docs/$*.pod ${top_builddir}/docs/$@
 495
 496 ${BEHAVIOR_PAGES}:
 497         @rm -f $@
 498         ln -s ${top_srcdir}/docs/memcached_behavior.pod ${top_builddir}/docs/$@
 499
 500 ${CALLBACK_PAGES}:
 501         @rm -f $@
 502         ln -s ${top_srcdir}/docs/memcached_callback.pod ${top_builddir}/docs/$@
 503
 504 ${STATS_PAGES}:
 505         @rm -f $@
 506         ln -s ${top_srcdir}/docs/memcached_stats.pod ${top_builddir}/docs/$@
 507
 508 ${RESULT_PAGES}:
 509         @rm -f $@
 510         ln -s ${top_srcdir}/docs/memcached_result_st.pod ${top_builddir}/docs/$@
 511
 512 ${VERSION_PAGES}:
 513         @rm -f $@
 514         ln -s ${top_srcdir}/docs/memcached_version.pod ${top_builddir}/docs/$@
 515
 516 ${MEMORY_ALLOCATORS_PAGES}:
 517         @rm -f $@
 518         ln -s ${top_srcdir}/docs/memcached_memory_allocators.pod ${top_builddir}/docs/$@
 519
 520 ${USER_DATA_PAGES}:
 521         @rm -f $@
 522         ln -s ${top_srcdir}/docs/memcached_user_data.pod ${top_builddir}/docs/$@
 523
 524 ${POOL_PAGES}:
 525         @rm -f $@
 526         ln -s ${top_srcdir}/docs/memcached_pool.pod ${top_builddir}/docs/$@
 527
 528 ${HASHKIT_CREATE_PAGES}:
 529         @rm -f $@
 530         ln -s ${top_srcdir}/docs/hashkit_create.pod ${top_builddir}/docs/$@
 531
 532
 533 ${HASHKIT_FUNCTIONS_PAGES}:
 534         @rm -f $@
 535         ln -s ${top_srcdir}/docs/hashkit_functions.pod ${top_builddir}/docs/$@
 536
 537 ${HASHKIT_ST_PAGES}:
 538         @rm -f $@
 539         ln -s ${top_srcdir}/docs/hashkit_value.pod ${top_builddir}/docs/$@
 540
 541 test-docs: $(POD_FILES)
 542         ${PODCHECKER} $(top_srcdir)/docs/$?
 543
 544 html-local: html-pages html-index
 545
 546 html-pages: $(HTML_FILES)
 547
 548 html-index: html-pages
 549         perl make_index.pl *.html > index.html
 550
 551 SUFFIXES= .pop .pod .html .1 .3
 552
 553 .pop: ${_set}
 554
 555 .pop.html:
 556         pod2html --infile=$< >  $@
 557
 558 .pop.1:
 559         ${POD2MAN} -c "$*" -r "" -s 1 $< >  $@
 560
 561 .pop.3:
 562         ${POD2MAN} -c "$*" -r "" -s 3 $< >  $@