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_get_keys.pop .pop\
 142              memcached_stat_get_value.pop \
 143              memcached_stat_servername.pop
 144 BUILT_SOURCES += ${STATS_PAGES}
 145
 146 USER_DATA_PAGES= \
 147                  memcached_get_user_data.pop \
 148                  memcached_set_user_data.pop
 149 BUILT_SOURCES += ${USER_DATA_PAGES}
 150
 151 VERSION_PAGES= \
 152                memcached_version.pop \
 153                memcached_lib_version.pop
 154 BUILT_SOURCES += ${VERSION_PAGES}
 155
 156
 157 #
 158 # These are for libhashkit
 159 #
 160 HASHKIT_CREATE_PAGES= \
 161                       hashkit_is_allocated.pop \
 162                       hashkit_create.pop \
 163                       hashkit_clone.pop \
 164                       hashkit_free.pop
 165 BUILT_SOURCES += ${HASHKIT_CREATE_PAGES}
 166
 167 HASHKIT_FUNCTIONS_PAGES= \
 168                          hashkit_crc32.pop \
 169                          hashkit_fnv1_32.pop \
 170                          hashkit_fnv1_64.pop \
 171                          hashkit_fnv1a_32.pop \
 172                          hashkit_fnv1a_64.pop \
 173                          hashkit_functions.pop \
 174                          hashkit_hsieh.pop \
 175                          hashkit_jenkins.pop \
 176                          hashkit_md5.pop \
 177                          hashkit_murmur.pop
 178 BUILT_SOURCES += ${HASHKIT_FUNCTIONS_PAGES}
 179
 180 HASHKIT_ST_PAGES= \
 181                   hashkit_value.pop
 182 BUILT_SOURCES += ${HASHKIT_ST_PAGES}
 183
 184
 185 HTML_FILES= \
 186             hashkit_clone.html \
 187             hashkit_crc32.html \
 188             hashkit_create.html \
 189             hashkit_fnv1_32.html \
 190             hashkit_fnv1_64.html \
 191             hashkit_fnv1a_32.html \
 192             hashkit_fnv1a_64.html \
 193             hashkit_free.html \
 194             hashkit_functions.html \
 195             hashkit_hsieh.html \
 196             hashkit_is_allocated.html \
 197             hashkit_jenkins.html \
 198             hashkit_md5.html \
 199             hashkit_murmur.html \
 200             hashkit_value.html \
 201             libmemcached_examples.html \
 202             libmemcached.html \
 203             libmemcachedutil.html \
 204             memcached_add_by_key.html \
 205             memcached_add.html \
 206             memcached_analyze.html \
 207             memcached_append_by_key.html \
 208             memcached_append.html \
 209             memcached_behavior_get.html \
 210             memcached_behavior_set.html \
 211             memcached_callback_get.html \
 212             memcached_callback_set.html \
 213             memcached_cas_by_key.html \
 214             memcached_cas.html \
 215             memcached_clone.html \
 216             memcached_create.html \
 217             memcached_decrement.html \
 218             memcached_decrement_with_initial.html \
 219             memcached_delete_by_key.html \
 220             memcached_delete.html \
 221             memcached_dump.html \
 222             memcached_fetch_execute.html \
 223             memcached_fetch.html \
 224             memcached_fetch_result.html \
 225             memcached_flush_buffers.html \
 226             memcached_flush.html \
 227             memcached_free.html \
 228             memcached_generate_hash_value.html \
 229             memcached_get_by_key.html \
 230             memcached_get_memory_allocators.html \
 231             memcached_get.html \
 232             memcached_get_user_data.html \
 233             memcached_increment.html \
 234             memcached_increment_with_initial.html \
 235             memcached_lib_version.html \
 236             memcached_mget_by_key.html \
 237             memcached_mget_execute_by_key.html \
 238             memcached_mget_execute.html \
 239             memcached_mget.html \
 240             memcached_pool_behavior_get.html \
 241             memcached_pool_behavior_set.html \
 242             memcached_pool_create.html \
 243             memcached_pool_destroy.html \
 244             memcached_pool_pop.html \
 245             memcached_pool_push.html \
 246             memcached_prepend_by_key.html \
 247             memcached_prepend.html \
 248             memcached_quit.html \
 249             memcached_replace_by_key.html \
 250             memcached_replace.html \
 251             memcached_result_cas.html \
 252             memcached_result_create.html \
 253             memcached_result_flags.html \
 254             memcached_result_free.html \
 255             memcached_result_key_length.html \
 256             memcached_result_key_value.html \
 257             memcached_result_length.html \
 258             memcached_result_st.html \
 259             memcached_result_value.html \
 260             memcached_server_add.html \
 261             memcached_server_add_unix_socket.html \
 262             memcached_server_count.html \
 263             memcached_server_cursor.html \
 264             memcached_server_list_append.html \
 265             memcached_server_list_count.html \
 266             memcached_server_list_free.html \
 267             memcached_server_list.html \
 268             memcached_server_push.html \
 269             memcached_servers_parse.html \
 270             memcached_set_by_key.html \
 271             memcached_set_memory_allocators.html \
 272             memcached_set.html \
 273             memcached_set_user_data.html \
 274             memcached_stat_get_keys.html \
 275             memcached_stat_get_value.html \
 276             memcached_stat.html \
 277             memcached_stat_servername.html \
 278             memcached_strerror.html \
 279             memcached_verbosity.html \
 280             memcached_version.html \
 281             memcapable.html \
 282             memcat.html \
 283             memcp.html \
 284             memdump.html \
 285             memerror.html \
 286             memflush.html \
 287             memrm.html \
 288             memslap.html \
 289             memstat.html
 290
 291 POD_FILES= \
 292              hashkit_create.pod \
 293              hashkit_functions.pod \
 294              hashkit_value.pod \
 295              libmemcached.pod \
 296              libmemcached_examples.pod \
 297              libmemcachedutil.pod \
 298              memcached_analyze.pod \
 299              memcached_auto.pod \
 300              memcached_behavior.pod \
 301              memcached_callback.pod \
 302              memcached_create.pod \
 303              memcached_delete.pod \
 304              memcached_dump.pod \
 305              memcached_flush.pod \
 306              memcached_flush_buffers.pod \
 307              memcached_generate_hash_value.pod \
 308              memcached_get.pod \
 309              memcached_memory_allocators.pod \
 310              memcached_pool.pod \
 311              memcached_quit.pod \
 312              memcached_server_st.pod \
 313              memcached_servers.pod \
 314              memcached_set.pod \
 315              memcached_stats.pod \
 316              memcached_strerror.pod \
 317              memcached_user_data.pod \
 318              memcached_verbosity.pod \
 319              memcached_version.pod \
 320              memcapable.pod \
 321              memcat.pod \
 322              memcp.pod \
 323              memdump.pod \
 324              memerror.pod \
 325              memflush.pod \
 326              memrm.pod \
 327              memslap.pod \
 328              memstat.pod
 329 EXTRA_DIST+= $(POD_FILES)
 330
 331 man_MANS = \
 332            hashkit_clone.3 \
 333            hashkit_crc32.3 \
 334            hashkit_create.3 \
 335            hashkit_fnv1_32.3 \
 336            hashkit_fnv1_64.3 \
 337            hashkit_fnv1a_32.3 \
 338            hashkit_fnv1a_64.3 \
 339            hashkit_free.3 \
 340            hashkit_functions.3 \
 341            hashkit_hsieh.3 \
 342            hashkit_is_allocated.3 \
 343            hashkit_jenkins.3 \
 344            hashkit_md5.3 \
 345            hashkit_murmur.3 \
 346            hashkit_value.3 \
 347            libmemcached.3 \
 348            libmemcached_examples.3 \
 349            memcached_add.3 \
 350            memcached_add_by_key.3 \
 351            memcached_analyze.3 \
 352            memcached_append.3 \
 353            memcached_append_by_key.3 \
 354            memcached_behavior_get.3 \
 355            memcached_behavior_set.3 \
 356            memcached_callback_get.3 \
 357            memcached_callback_set.3 \
 358            memcached_cas.3 \
 359            memcached_cas_by_key.3 \
 360            memcached_clone.3 \
 361            memcached_create.3 \
 362            memcached_decrement.3 \
 363            memcached_decrement_with_initial.3 \
 364            memcached_delete.3 \
 365            memcached_delete_by_key.3 \
 366            memcached_dump.3 \
 367            memcached_fetch.3 \
 368            memcached_fetch_execute.3 \
 369            memcached_fetch_result.3 \
 370            memcached_flush_buffers.3 \
 371            memcached_free.3 \
 372            memcached_generate_hash_value.3 \
 373            memcached_get.3 \
 374            memcached_get_by_key.3 \
 375            memcached_get_memory_allocators.3 \
 376            memcached_get_user_data.3 \
 377            memcached_increment.3 \
 378            memcached_increment_with_initial.3 \
 379            memcached_lib_version.3 \
 380            memcached_mget.3 \
 381            memcached_mget_by_key.3 \
 382            memcached_mget_execute.3  \
 383            memcached_mget_execute_by_key.3  \
 384            memcached_prepend.3 \
 385            memcached_prepend_by_key.3 \
 386            memcached_quit.3 \
 387            memcached_replace.3 \
 388            memcached_replace_by_key.3 \
 389            memcached_server_add.3 \
 390            memcached_server_count.3 \
 391            memcached_server_cursor.3 \
 392            memcached_server_list.3 \
 393            memcached_server_list_append.3 \
 394            memcached_server_list_count.3 \
 395            memcached_server_list_free.3 \
 396            memcached_server_push.3 \
 397            memcached_servers_parse.3 \
 398            memcached_set.3 \
 399            memcached_set_by_key.3 \
 400            memcached_set_memory_allocators.3 \
 401            memcached_set_user_data.3 \
 402            memcached_stat.3 \
 403            memcached_stat_get_keys.3 \
 404            memcached_stat_get_value.3 \
 405            memcached_stat_servername.3 \
 406            memcached_strerror.3 \
 407            memcached_verbosity.3 \
 408            memcached_version.3 \
 409            memcapable.1 \
 410            memcat.1 \
 411            memcp.1 \
 412            memdump.1 \
 413            memerror.1 \
 414            memflush.1 \
 415            memrm.1 \
 416            memslap.1 \
 417            memstat.1
 418
 419 if BUILD_LIBMEMCACHEDUTIL
 420 man_MANS+= \
 421           libmemcachedutil.3 \
 422           memcached_pool_behavior_set.3 \
 423           memcached_pool_behavior_get.3 \
 424           memcached_pool_create.3 \
 425           memcached_pool_destroy.3 \
 426           memcached_pool_push.3 \
 427           memcached_pool_pop.3
 428 endif
 429
 430
 431 ${CREATE_PAGES}:
 432         @rm -f $@
 433         ln -s ${top_srcdir}/docs/memcached_create.pod ${top_builddir}/docs/$@
 434
 435 ${SET_PAGES}:
 436         @rm -f $@
 437         ln -s ${top_srcdir}/docs/memcached_set.pod ${top_builddir}/docs/$@
 438
 439 ${DELETE_PAGES}:
 440         @rm -f $@
 441         ln -s ${top_srcdir}/docs/memcached_delete.pod ${top_builddir}/docs/$@
 442
 443 ${AUTO_PAGES}:
 444         @rm -f $@
 445         ln -s ${top_srcdir}/docs/memcached_auto.pod ${top_builddir}/docs/$@
 446
 447 ${GET_PAGES}:
 448         @rm -f $@
 449         ln -s ${top_srcdir}/docs/memcached_get.pod ${top_builddir}/docs/$@
 450
 451 ${SERVER_PAGES}:
 452         @rm -f $@
 453         ln -s ${top_srcdir}/docs/memcached_servers.pod ${top_builddir}/docs/$@
 454
 455 ${SERVER_ST_PAGES}:
 456         @rm -f $@
 457         ln -s ${top_srcdir}/docs/memcached_server_st.pod ${top_builddir}/docs/$@
 458
 459 ${GENERIC_PAGES}:
 460         @rm -f $@
 461         ln -s ${top_srcdir}/docs/$*.pod ${top_builddir}/docs/$@
 462
 463 ${BEHAVIOR_PAGES}:
 464         @rm -f $@
 465         ln -s ${top_srcdir}/docs/memcached_behavior.pod ${top_builddir}/docs/$@
 466
 467 ${CALLBACK_PAGES}:
 468         @rm -f $@
 469         ln -s ${top_srcdir}/docs/memcached_callback.pod ${top_builddir}/docs/$@
 470
 471 ${STATS_PAGES}:
 472         @rm -f $@
 473         ln -s ${top_srcdir}/docs/memcached_stats.pod ${top_builddir}/docs/$@
 474
 475 ${RESULT_PAGES}:
 476         @rm -f $@
 477         ln -s ${top_srcdir}/docs/memcached_result_st.pod ${top_builddir}/docs/$@
 478
 479 ${VERSION_PAGES}:
 480         @rm -f $@
 481         ln -s ${top_srcdir}/docs/memcached_version.pod ${top_builddir}/docs/$@
 482
 483 ${MEMORY_ALLOCATORS_PAGES}:
 484         @rm -f $@
 485         ln -s ${top_srcdir}/docs/memcached_memory_allocators.pod ${top_builddir}/docs/$@
 486
 487 ${USER_DATA_PAGES}:
 488         @rm -f $@
 489         ln -s ${top_srcdir}/docs/memcached_user_data.pod ${top_builddir}/docs/$@
 490
 491
 492 ${POOL_PAGES}:
 493         @rm -f $@
 494         ln -s ${top_srcdir}/docs/memcached_pool.pod ${top_builddir}/docs/$@
 495
 496 ${HASHKIT_CREATE_PAGES}:
 497         @rm -f $@
 498         ln -s ${top_srcdir}/docs/hashkit_create.pod ${top_builddir}/docs/$@
 499
 500
 501 ${HASHKIT_FUNCTIONS_PAGES}:
 502         @rm -f $@
 503         ln -s ${top_srcdir}/docs/hashkit_functions.pod ${top_builddir}/docs/$@
 504
 505 ${HASHKIT_ST_PAGES}:
 506         @rm -f $@
 507         ln -s ${top_srcdir}/docs/hashkit_value.pod ${top_builddir}/docs/$@
 508
 509 test-docs: $(POD_FILES)
 510         ${PODCHECKER} $(top_srcdir)/docs/$?
 511
 512 html-local: html-pages html-index
 513
 514 html-pages: $(HTML_FILES)
 515
 516 html-index: html-pages
 517         perl make_index.pl *.html > index.html
 518
 519 SUFFIXES= .pop .pod .html .1 .3
 520
 521 .pop: ${_set}
 522
 523 .pop.html:
 524         pod2html --infile=$< >  $@
 525
 526 .pop.1:
 527         ${POD2MAN} -c "$*" -r "" -s 1 $< >  $@
 528
 529 .pop.3:
 530         ${POD2MAN} -c "$*" -r "" -s 3 $< >  $@