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