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