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