From: Brian Aker Date: Wed, 6 Apr 2011 05:27:35 +0000 (-0700) Subject: First pass on updating docs. X-Git-Tag: 0.51~15^2~35 X-Git-Url: https://git.m6w6.name/?a=commitdiff_plain;h=c4dbc7e56b01545e25bc95ba122c79d4a2631a99;p=m6w6%2Flibmemcached First pass on updating docs. --- c4dbc7e56b01545e25bc95ba122c79d4a2631a99 diff --cc Makefile.am index b9fec57e,e42a8aef..baecaf4e --- a/Makefile.am +++ b/Makefile.am @@@ -32,20 -33,11 +33,10 @@@ EXTRA_DIST= m4/po.m4 \ m4/progtest.m4 - TEST_DOCS= - if BUILD_DOCS - SUBDIRS = docs - TEST_DOCS+=test-docs - endif - - test-docs: - (cd docs && $(MAKE) test-docs) - +include libtest/include.am - include libmemcached/include.am include clients/include.am -include libtest/include.am include libhashkit/include.am -include unittests/include.am include tests/include.am include example/include.am include support/include.am diff --cc configure.ac index b4581e9f,8657fc6e..ff9329bf --- a/configure.ac +++ b/configure.ac @@@ -103,7 -96,7 +103,6 @@@ AC_SEARCH_LIBS(gethostbyname, nsl AC_CHECK_FUNCS([getline]) --PANDORA_HAVE_LIBGTEST PANDORA_HAVE_LIBEVENT my_saved_libs="$LIBS" LIBS= diff --cc docs/Makefile.am.THIS index 00000000,00000000..2d1c2829 new file mode 100644 --- /dev/null +++ b/docs/Makefile.am.THIS @@@ -1,0 -1,0 +1,566 @@@ ++# This file generates all of man/html pages that we use for documentation. ++# ++# When hacking this file you need to know that we take .pod files and turn ++# them into .pop files. .pop files are 1=1 for man pages, but one .pod ++# file may generate many .pop files. ++# ++# -Brian ++# ++# ++CLEANFILES= *.1 *.3 *.html *.pop *.tmp ++ ++BUILT_SOURCES= ++ ++EXTRA_DIST= make_index.pl ++ ++AUTO_PAGES= \ ++ memcached_increment.pop \ ++ memcached_increment_with_initial.pop \ ++ memcached_decrement.pop \ ++ memcached_decrement_with_initial.pop ++BUILT_SOURCES += ${AUTO_PAGES} ++ ++BEHAVIOR_PAGES= \ ++ memcached_behavior_get.pop \ ++ memcached_behavior_set.pop ++BUILT_SOURCES += ${BEHAVIOR_PAGES} ++ ++CALLBACK_PAGES= \ ++ memcached_callback_get.pop \ ++ memcached_callback_set.pop ++BUILT_SOURCES += ${CALLBACK_PAGES} ++ ++CREATE_PAGES= \ ++ memcached_clone.pop \ ++ memcached_create.pop \ ++ memcached_free.pop \ ++ memcached_servers_reset.pop ++BUILT_SOURCES += ${CREATE_PAGES} ++ ++DELETE_PAGES= \ ++ memcached_delete.pop \ ++ memcached_delete_by_key.pop ++BUILT_SOURCES += ${DELETE_PAGES} ++ ++GENERIC_PAGES= \ ++ libmemcached.pop \ ++ libmemcached_examples.pop \ ++ libmemcachedutil.pop \ ++ memcached_analyze.pop \ ++ memcached_dump.pop \ ++ memcached_flush.pop \ ++ memcached_flush_buffers.pop \ ++ memcached_generate_hash_value.pop \ ++ memcached_quit.pop \ ++ memcached_strerror.pop \ ++ memcached_verbosity.pop \ ++ memcapable.pop \ ++ memcat.pop \ ++ memcp.pop \ ++ memdump.pop \ ++ memerror.pop \ ++ memflush.pop \ ++ memrm.pop \ ++ memaslap.pop \ ++ memslap.pop \ ++ memstat.pop ++BUILT_SOURCES += ${GENERIC_PAGES} ++ ++GET_PAGES= \ ++ memcached_get.pop \ ++ memcached_get_by_key.pop \ ++ memcached_fetch_result.pop \ ++ memcached_fetch_execute.pop \ ++ memcached_mget.pop \ ++ memcached_mget_by_key.pop \ ++ memcached_mget_execute.pop \ ++ memcached_mget_execute_by_key.pop \ ++ memcached_fetch.pop ++BUILT_SOURCES += ${GET_PAGES} ++ ++MEMORY_ALLOCATORS_PAGES= \ ++ memcached_get_memory_allocators.pop \ ++ memcached_set_memory_allocators.pop \ ++ memcached_set_memory_allocators_context.pop ++BUILT_SOURCES += ${MEMORY_ALLOCATORS_PAGES} ++ ++POOL_PAGES= \ ++ memcached_pool_behavior_get.pop \ ++ memcached_pool_behavior_set.pop \ ++ memcached_pool_create.pop \ ++ memcached_pool_destroy.pop \ ++ memcached_pool_pop.pop \ ++ memcached_pool_push.pop ++BUILT_SOURCES += ${POOL_PAGES} ++ ++RESULT_PAGES= \ ++ memcached_result_cas.pop \ ++ memcached_result_create.pop \ ++ memcached_result_flags.pop \ ++ memcached_result_free.pop \ ++ memcached_result_key_length.pop \ ++ memcached_result_key_value.pop \ ++ memcached_result_length.pop \ ++ memcached_result_st.pop \ ++ memcached_result_value.pop ++BUILT_SOURCES += ${RESULT_PAGES} ++ ++ ++SERVER_PAGES= \ ++ memcached_server_count.pop \ ++ memcached_server_cursor.pop \ ++ memcached_server_list.pop \ ++ memcached_server_add.pop \ ++ memcached_server_add_unix_socket.pop \ ++ memcached_server_push.pop ++BUILT_SOURCES += ${SERVER_PAGES} ++ ++SERVER_ST_PAGES= \ ++ memcached_server_list_free.pop \ ++ memcached_server_list_count.pop \ ++ memcached_server_list_append.pop \ ++ memcached_servers_parse.pop ++BUILT_SOURCES += ${SERVER_ST_PAGES} ++ ++SET_PAGES= \ ++ memcached_set.pop \ ++ memcached_set_by_key.pop \ ++ memcached_cas.pop \ ++ memcached_cas_by_key.pop \ ++ memcached_replace.pop \ ++ memcached_replace_by_key.pop \ ++ memcached_add.pop \ ++ memcached_add_by_key.pop \ ++ memcached_prepend.pop \ ++ memcached_prepend_by_key.pop \ ++ memcached_append.pop \ ++ memcached_append_by_key.pop ++BUILT_SOURCES += ${SET_PAGES} ++ ++STATS_PAGES= \ ++ memcached_stat.pop \ ++ memcached_stat_execute.pop\ ++ memcached_stat_get_keys.pop\ ++ memcached_stat_get_value.pop \ ++ memcached_stat_servername.pop ++BUILT_SOURCES += ${STATS_PAGES} ++ ++USER_DATA_PAGES= \ ++ memcached_get_user_data.pop \ ++ memcached_set_user_data.pop ++BUILT_SOURCES += ${USER_DATA_PAGES} ++ ++VERSION_PAGES= \ ++ memcached_version.pop \ ++ memcached_lib_version.pop ++BUILT_SOURCES += ${VERSION_PAGES} ++ ++ ++# ++# These are for libhashkit ++# ++HASHKIT_CREATE_PAGES= \ ++ hashkit_is_allocated.pop \ ++ hashkit_create.pop \ ++ hashkit_clone.pop \ ++ hashkit_free.pop ++BUILT_SOURCES += ${HASHKIT_CREATE_PAGES} ++ ++HASHKIT_FUNCTIONS_PAGES= \ ++ hashkit_crc32.pop \ ++ hashkit_fnv1_32.pop \ ++ hashkit_fnv1_64.pop \ ++ hashkit_fnv1a_32.pop \ ++ hashkit_fnv1a_64.pop \ ++ hashkit_functions.pop \ ++ hashkit_hsieh.pop \ ++ hashkit_jenkins.pop \ ++ hashkit_md5.pop \ ++ hashkit_murmur.pop ++BUILT_SOURCES += ${HASHKIT_FUNCTIONS_PAGES} ++ ++HASHKIT_ST_PAGES= \ ++ hashkit_value.pop ++BUILT_SOURCES += ${HASHKIT_ST_PAGES} ++ ++ ++HTML_FILES= \ ++ hashkit_clone.html \ ++ hashkit_crc32.html \ ++ hashkit_create.html \ ++ hashkit_fnv1_32.html \ ++ hashkit_fnv1_64.html \ ++ hashkit_fnv1a_32.html \ ++ hashkit_fnv1a_64.html \ ++ hashkit_free.html \ ++ hashkit_functions.html \ ++ hashkit_hsieh.html \ ++ hashkit_is_allocated.html \ ++ hashkit_jenkins.html \ ++ hashkit_md5.html \ ++ hashkit_murmur.html \ ++ hashkit_value.html \ ++ libmemcached_examples.html \ ++ libmemcached.html \ ++ libmemcachedutil.html \ ++ memcached_add_by_key.html \ ++ memcached_add.html \ ++ memcached_analyze.html \ ++ memcached_append_by_key.html \ ++ memcached_append.html \ ++ memcached_behavior_get.html \ ++ memcached_behavior_set.html \ ++ memcached_callback_get.html \ ++ memcached_callback_set.html \ ++ memcached_cas_by_key.html \ ++ memcached_cas.html \ ++ memcached_clone.html \ ++ memcached_create.html \ ++ memcached_decrement.html \ ++ memcached_decrement_with_initial.html \ ++ memcached_delete_by_key.html \ ++ memcached_delete.html \ ++ memcached_dump.html \ ++ memcached_fetch_execute.html \ ++ memcached_fetch.html \ ++ memcached_fetch_result.html \ ++ memcached_flush_buffers.html \ ++ memcached_flush.html \ ++ memcached_free.html \ ++ memcached_generate_hash_value.html \ ++ memcached_get_by_key.html \ ++ memcached_get_memory_allocators.html \ ++ memcached_get.html \ ++ memcached_get_user_data.html \ ++ memcached_increment.html \ ++ memcached_increment_with_initial.html \ ++ memcached_lib_version.html \ ++ memcached_mget_by_key.html \ ++ memcached_mget_execute_by_key.html \ ++ memcached_mget_execute.html \ ++ memcached_mget.html \ ++ memcached_pool_behavior_get.html \ ++ memcached_pool_behavior_set.html \ ++ memcached_pool_create.html \ ++ memcached_pool_destroy.html \ ++ memcached_pool_pop.html \ ++ memcached_pool_push.html \ ++ memcached_prepend_by_key.html \ ++ memcached_prepend.html \ ++ memcached_quit.html \ ++ memcached_replace_by_key.html \ ++ memcached_replace.html \ ++ memcached_result_cas.html \ ++ memcached_result_create.html \ ++ memcached_result_flags.html \ ++ memcached_result_free.html \ ++ memcached_result_key_length.html \ ++ memcached_result_key_value.html \ ++ memcached_result_length.html \ ++ memcached_result_st.html \ ++ memcached_result_value.html \ ++ memcached_server_add.html \ ++ memcached_server_add_unix_socket.html \ ++ memcached_server_count.html \ ++ memcached_server_cursor.html \ ++ memcached_server_list_append.html \ ++ memcached_server_list_count.html \ ++ memcached_server_list_free.html \ ++ memcached_server_list.html \ ++ memcached_server_push.html \ ++ memcached_servers_parse.html \ ++ memcached_set_by_key.html \ ++ memcached_set_memory_allocators.html \ ++ memcached_set.html \ ++ memcached_set_user_data.html \ ++ memcached_stat_execute.html \ ++ memcached_stat_get_keys.html \ ++ memcached_stat_get_value.html \ ++ memcached_stat.html \ ++ memcached_stat_servername.html \ ++ memcached_strerror.html \ ++ memcached_verbosity.html \ ++ memcached_version.html \ ++ memcapable.html \ ++ memcat.html \ ++ memcp.html \ ++ memdump.html \ ++ memerror.html \ ++ memflush.html \ ++ memrm.html \ ++ memaslap.html \ ++ memslap.html \ ++ memstat.html ++ ++POD_FILES= \ ++ hashkit_create.pod \ ++ hashkit_functions.pod \ ++ hashkit_value.pod \ ++ libmemcached.pod \ ++ libmemcached_examples.pod \ ++ libmemcachedutil.pod \ ++ memcached_analyze.pod \ ++ memcached_auto.pod \ ++ memcached_behavior.pod \ ++ memcached_callback.pod \ ++ memcached_create.pod \ ++ memcached_delete.pod \ ++ memcached_dump.pod \ ++ memcached_flush.pod \ ++ memcached_flush_buffers.pod \ ++ memcached_generate_hash_value.pod \ ++ memcached_get.pod \ ++ memcached_memory_allocators.pod \ ++ memcached_pool.pod \ ++ memcached_quit.pod \ ++ memcached_result_st.pod \ ++ memcached_sasl.pod \ ++ memcached_server_st.pod \ ++ memcached_servers.pod \ ++ memcached_set.pod \ ++ memcached_stats.pod \ ++ memcached_strerror.pod \ ++ memcached_user_data.pod \ ++ memcached_verbosity.pod \ ++ memcached_version.pod \ ++ memcapable.pod \ ++ memcat.pod \ ++ memcp.pod \ ++ memdump.pod \ ++ memerror.pod \ ++ memflush.pod \ ++ memrm.pod \ ++ memaslap.pod \ ++ memslap.pod \ ++ memstat.pod ++EXTRA_DIST+= $(POD_FILES) ++ ++man_MANS = \ ++ hashkit_clone.3 \ ++ hashkit_crc32.3 \ ++ hashkit_create.3 \ ++ hashkit_fnv1_32.3 \ ++ hashkit_fnv1_64.3 \ ++ hashkit_fnv1a_32.3 \ ++ hashkit_fnv1a_64.3 \ ++ hashkit_free.3 \ ++ hashkit_functions.3 \ ++ hashkit_hsieh.3 \ ++ hashkit_is_allocated.3 \ ++ hashkit_jenkins.3 \ ++ hashkit_md5.3 \ ++ hashkit_murmur.3 \ ++ hashkit_value.3 \ ++ libmemcached.3 \ ++ libmemcached_examples.3 \ ++ memcached_add.3 \ ++ memcached_add_by_key.3 \ ++ memcached_analyze.3 \ ++ memcached_append.3 \ ++ memcached_append_by_key.3 \ ++ memcached_behavior_get.3 \ ++ memcached_behavior_set.3 \ ++ memcached_callback_get.3 \ ++ memcached_callback_set.3 \ ++ memcached_cas.3 \ ++ memcached_cas_by_key.3 \ ++ memcached_clone.3 \ ++ memcached_create.3 \ ++ memcached_decrement.3 \ ++ memcached_decrement_with_initial.3 \ ++ memcached_delete.3 \ ++ memcached_delete_by_key.3 \ ++ memcached_dump.3 \ ++ memcached_fetch.3 \ ++ memcached_fetch_execute.3 \ ++ memcached_fetch_result.3 \ ++ memcached_flush_buffers.3 \ ++ memcached_free.3 \ ++ memcached_generate_hash_value.3 \ ++ memcached_get.3 \ ++ memcached_get_by_key.3 \ ++ memcached_get_memory_allocators.3 \ ++ memcached_get_user_data.3 \ ++ memcached_increment.3 \ ++ memcached_increment_with_initial.3 \ ++ memcached_lib_version.3 \ ++ memcached_mget.3 \ ++ memcached_mget_by_key.3 \ ++ memcached_mget_execute.3 \ ++ memcached_mget_execute_by_key.3 \ ++ memcached_prepend.3 \ ++ memcached_prepend_by_key.3 \ ++ memcached_quit.3 \ ++ memcached_replace.3 \ ++ memcached_replace_by_key.3 \ ++ memcached_server_add.3 \ ++ memcached_server_count.3 \ ++ memcached_server_cursor.3 \ ++ memcached_server_list.3 \ ++ memcached_server_list_append.3 \ ++ memcached_server_list_count.3 \ ++ memcached_server_list_free.3 \ ++ memcached_server_push.3 \ ++ memcached_servers_parse.3 \ ++ memcached_set.3 \ ++ memcached_set_by_key.3 \ ++ memcached_set_memory_allocators.3 \ ++ memcached_set_user_data.3 \ ++ memcached_stat.3 \ ++ memcached_stat_execute.3 \ ++ memcached_stat_get_keys.3 \ ++ memcached_stat_get_value.3 \ ++ memcached_stat_servername.3 \ ++ memcached_strerror.3 \ ++ memcached_verbosity.3 \ ++ memcached_version.3 \ ++ memcapable.1 \ ++ memcat.1 \ ++ memcp.1 \ ++ memdump.1 \ ++ memerror.1 \ ++ memflush.1 \ ++ memrm.1 \ ++ memaslap.1 \ ++ memslap.1 \ ++ memstat.1 ++ ++if HAVE_SASL ++POD_FILES+= memcached_sasl.pod ++man_MANS+= \ ++ memcached_destroy_sasl_auth_data.3 \ ++ memcached_get_sasl_callbacks.3 \ ++ memcached_sasl_set_auth_data.3 \ ++ memcached_set_sasl_callbacks.3 ++ ++HTML_FILES+= \ ++ memcached_destroy_sasl_auth_data.html \ ++ memcached_get_sasl_callbacks.html \ ++ memcached_sasl_set_auth_data.html \ ++ memcached_set_sasl_callbacks.html ++ ++ ++SASL_PAGES= \ ++ memcached_destroy_sasl_auth_data.pop \ ++ memcached_get_sasl_callbacks.pop \ ++ memcached_sasl_set_auth_data.pop \ ++ memcached_set_sasl_callbacks.pop ++BUILT_SOURCES += ${SASL_PAGES} ++ ++${SASL_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_sasl.pod ${top_builddir}/docs/$@ ++ ++endif ++ ++if BUILD_LIBMEMCACHEDUTIL ++man_MANS+= \ ++ libmemcachedutil.3 \ ++ memcached_pool_behavior_set.3 \ ++ memcached_pool_behavior_get.3 \ ++ memcached_pool_create.3 \ ++ memcached_pool_destroy.3 \ ++ memcached_pool_push.3 \ ++ memcached_pool_pop.3 ++endif ++ ++ ++${CREATE_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_create.pod ${top_builddir}/docs/$@ ++ ++${SET_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_set.pod ${top_builddir}/docs/$@ ++ ++${DELETE_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_delete.pod ${top_builddir}/docs/$@ ++ ++${AUTO_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_auto.pod ${top_builddir}/docs/$@ ++ ++${GET_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_get.pod ${top_builddir}/docs/$@ ++ ++${SERVER_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_servers.pod ${top_builddir}/docs/$@ ++ ++${SERVER_ST_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_server_st.pod ${top_builddir}/docs/$@ ++ ++${GENERIC_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/$*.pod ${top_builddir}/docs/$@ ++ ++${BEHAVIOR_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_behavior.pod ${top_builddir}/docs/$@ ++ ++${CALLBACK_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_callback.pod ${top_builddir}/docs/$@ ++ ++${STATS_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_stats.pod ${top_builddir}/docs/$@ ++ ++${RESULT_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_result_st.pod ${top_builddir}/docs/$@ ++ ++${VERSION_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_version.pod ${top_builddir}/docs/$@ ++ ++${MEMORY_ALLOCATORS_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_memory_allocators.pod ${top_builddir}/docs/$@ ++ ++${USER_DATA_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_user_data.pod ${top_builddir}/docs/$@ ++ ++${POOL_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_pool.pod ${top_builddir}/docs/$@ ++ ++${HASHKIT_CREATE_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/hashkit_create.pod ${top_builddir}/docs/$@ ++ ++ ++${HASHKIT_FUNCTIONS_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/hashkit_functions.pod ${top_builddir}/docs/$@ ++ ++${HASHKIT_ST_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/hashkit_value.pod ${top_builddir}/docs/$@ ++ ++test-docs: $(POD_FILES) ++ ${PODCHECKER} $(top_srcdir)/docs/$? ++ ++html-local: html-pages html-index ++ ++html-pages: $(HTML_FILES) ++ ++html-index: html-pages ++ perl make_index.pl *.html > index.html ++ ++SUFFIXES= .pop .pod .html .1 .3 ++ ++.pop: ${_set} ++ ++.pop.html: ++ pod2html --infile=$< > $@ ++ ++.pop.1: ++ ${POD2MAN} -c "$*" -r "" -s 1 $< > $@ ++ ++.pop.3: ++ ${POD2MAN} -c "$*" -r "" -s 3 $< > $@ diff --cc docs/include.am index 00000000,95389411..97026c3c mode 000000,100644..100644 --- a/docs/include.am +++ b/docs/include.am @@@ -1,0 -1,263 +1,535 @@@ + # vim:ft=automake + # included from Top Level Makefile.am + # All paths should be given relative to the root + + EXTRA_DIST+= \ + docs/_static \ + docs/_templates \ + docs/conf.py \ + ${top_srcdir}/docs/*.rst + ++AUTO_PAGES= \ ++ memcached_increment.pop \ ++ memcached_increment_with_initial.pop \ ++ memcached_decrement.pop \ ++ memcached_decrement_with_initial.pop ++BUILT_SOURCES += ${AUTO_PAGES} ++ ++BEHAVIOR_PAGES= \ ++ memcached_behavior_get.pop \ ++ memcached_behavior_set.pop ++BUILT_SOURCES += ${BEHAVIOR_PAGES} ++ ++CALLBACK_PAGES= \ ++ memcached_callback_get.pop \ ++ memcached_callback_set.pop ++BUILT_SOURCES += ${CALLBACK_PAGES} ++ ++CREATE_PAGES= \ ++ memcached_clone.pop \ ++ memcached_create.pop \ ++ memcached_free.pop \ ++ memcached_servers_reset.pop ++BUILT_SOURCES += ${CREATE_PAGES} ++ ++DELETE_PAGES= \ ++ memcached_delete.pop \ ++ memcached_delete_by_key.pop ++BUILT_SOURCES += ${DELETE_PAGES} ++ ++GENERIC_PAGES= \ ++ libmemcached.pop \ ++ libmemcached_examples.pop \ ++ libmemcachedutil.pop \ ++ memcached_analyze.pop \ ++ memcached_dump.pop \ ++ memcached_flush.pop \ ++ memcached_flush_buffers.pop \ ++ memcached_generate_hash_value.pop \ ++ memcached_quit.pop \ ++ memcached_strerror.pop \ ++ memcached_verbosity.pop \ ++ memcapable.pop \ ++ memcat.pop \ ++ memcp.pop \ ++ memdump.pop \ ++ memerror.pop \ ++ memflush.pop \ ++ memrm.pop \ ++ memaslap.pop \ ++ memslap.pop \ ++ memstat.pop ++BUILT_SOURCES += ${GENERIC_PAGES} ++ ++GET_PAGES= \ ++ memcached_get.pop \ ++ memcached_get_by_key.pop \ ++ memcached_fetch_result.pop \ ++ memcached_fetch_execute.pop \ ++ memcached_mget.pop \ ++ memcached_mget_by_key.pop \ ++ memcached_mget_execute.pop \ ++ memcached_mget_execute_by_key.pop \ ++ memcached_fetch.pop ++BUILT_SOURCES += ${GET_PAGES} ++ ++MEMORY_ALLOCATORS_PAGES= \ ++ memcached_get_memory_allocators.pop \ ++ memcached_set_memory_allocators.pop \ ++ memcached_set_memory_allocators_context.pop ++BUILT_SOURCES += ${MEMORY_ALLOCATORS_PAGES} ++ ++POOL_PAGES= \ ++ memcached_pool_behavior_get.pop \ ++ memcached_pool_behavior_set.pop \ ++ memcached_pool_create.pop \ ++ memcached_pool_destroy.pop \ ++ memcached_pool_pop.pop \ ++ memcached_pool_push.pop ++BUILT_SOURCES += ${POOL_PAGES} ++ ++RESULT_PAGES= \ ++ memcached_result_cas.pop \ ++ memcached_result_create.pop \ ++ memcached_result_flags.pop \ ++ memcached_result_free.pop \ ++ memcached_result_key_length.pop \ ++ memcached_result_key_value.pop \ ++ memcached_result_length.pop \ ++ memcached_result_st.pop \ ++ memcached_result_value.pop ++BUILT_SOURCES += ${RESULT_PAGES} ++ ++ ++SERVER_PAGES= \ ++ memcached_server_count.pop \ ++ memcached_server_cursor.pop \ ++ memcached_server_list.pop \ ++ memcached_server_add.pop \ ++ memcached_server_add_unix_socket.pop \ ++ memcached_server_push.pop ++BUILT_SOURCES += ${SERVER_PAGES} ++ ++SERVER_ST_PAGES= \ ++ memcached_server_list_free.pop \ ++ memcached_server_list_count.pop \ ++ memcached_server_list_append.pop \ ++ memcached_servers_parse.pop ++BUILT_SOURCES += ${SERVER_ST_PAGES} ++ ++SET_PAGES= \ ++ memcached_set.pop \ ++ memcached_set_by_key.pop \ ++ memcached_cas.pop \ ++ memcached_cas_by_key.pop \ ++ memcached_replace.pop \ ++ memcached_replace_by_key.pop \ ++ memcached_add.pop \ ++ memcached_add_by_key.pop \ ++ memcached_prepend.pop \ ++ memcached_prepend_by_key.pop \ ++ memcached_append.pop \ ++ memcached_append_by_key.pop ++BUILT_SOURCES += ${SET_PAGES} ++ ++STATS_PAGES= \ ++ memcached_stat.pop \ ++ memcached_stat_execute.pop\ ++ memcached_stat_get_keys.pop\ ++ memcached_stat_get_value.pop \ ++ memcached_stat_servername.pop ++BUILT_SOURCES += ${STATS_PAGES} ++ ++USER_DATA_PAGES= \ ++ memcached_get_user_data.pop \ ++ memcached_set_user_data.pop ++BUILT_SOURCES += ${USER_DATA_PAGES} ++ ++VERSION_PAGES= \ ++ memcached_version.pop \ ++ memcached_lib_version.pop ++BUILT_SOURCES += ${VERSION_PAGES} ++ ++ ++# ++# These are for libhashkit ++# ++HASHKIT_CREATE_PAGES= \ ++ hashkit_is_allocated.pop \ ++ hashkit_create.pop \ ++ hashkit_clone.pop \ ++ hashkit_free.pop ++BUILT_SOURCES += ${HASHKIT_CREATE_PAGES} ++ ++HASHKIT_FUNCTIONS_PAGES= \ ++ hashkit_crc32.pop \ ++ hashkit_fnv1_32.pop \ ++ hashkit_fnv1_64.pop \ ++ hashkit_fnv1a_32.pop \ ++ hashkit_fnv1a_64.pop \ ++ hashkit_functions.pop \ ++ hashkit_hsieh.pop \ ++ hashkit_jenkins.pop \ ++ hashkit_md5.pop \ ++ hashkit_murmur.pop ++BUILT_SOURCES += ${HASHKIT_FUNCTIONS_PAGES} ++ ++HASHKIT_ST_PAGES= \ ++ hashkit_value.pop ++BUILT_SOURCES += ${HASHKIT_ST_PAGES} ++ + # Makefile for Sphinx documentation + # + + SPHINXOPTS = ${SPHINX_WARNINGS} -D release=${PANDORA_RELEASE_VERSION} + PAPER = + SPHINX_BUILDDIR = ${top_builddir}/docs + + # Internal variables. + PAPEROPT_a4 = -D latex_paper_size=a4 + PAPEROPT_letter = -D latex_paper_size=letter + ALLSPHINXOPTS = -d $(SPHINX_BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ${top_srcdir}/docs + + .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest + + if HAVE_RECENT_SPHINX + + man_MANS+= \ + docs/man/hashkit_create.3 \ + docs/man/hashkit_functions.3 \ + docs/man/hashkit_value.3 \ + docs/man/libmemcached_examples.3 \ + docs/man/libmemcached.3 \ + docs/man/libmemcachedutil.3 \ + docs/man/memcached_analyze.3 \ + docs/man/memcached_auto.3 \ + docs/man/memcached_behavior.3 \ + docs/man/memcached_callback.3 \ + docs/man/memcached_create.3 \ + docs/man/memcached_delete.3 \ + docs/man/memcached_dump.3 \ + docs/man/memcached_flush_buffers.3 \ + docs/man/memcached_flush.3 \ + docs/man/memcached_generate_hash_value.3 \ + docs/man/memcached_get.3 \ + docs/man/memcached_memory_allocators.3 \ + docs/man/memcached_pool.3 \ + docs/man/memcached_quit.3 \ + docs/man/memcached_result_st.3 \ + docs/man/memcached_sasl.3 \ + docs/man/memcached_servers.3 \ + docs/man/memcached_server_st.3 \ + docs/man/memcached_set.3 \ + docs/man/memcached_stats.3 \ + docs/man/memcached_strerror.3 \ + docs/man/memcached_user_data.3 \ + docs/man/memcached_verbosity.3 \ + docs/man/memcached_version.3 \ + docs/man/memcapable.1 \ + docs/man/memcat.1 \ + docs/man/memcp.1 \ + docs/man/memdump.1 \ + docs/man/memerror.1 \ + docs/man/memflush.1 \ + docs/man/memrm.1 \ + docs/man/memslap.1 \ + docs/man/memstat.1 + + DISTCLEANFILES+= \ + docs/man/hashkit_create.3 \ + docs/man/hashkit_functions.3 \ + docs/man/hashkit_value.3 \ + docs/man/libmemcached_examples.3 \ + docs/man/libmemcached.3 \ + docs/man/libmemcachedutil.3 \ + docs/man/memcached_analyze.3 \ + docs/man/memcached_auto.3 \ + docs/man/memcached_behavior.3 \ + docs/man/memcached_callback.3 \ + docs/man/memcached_create.3 \ + docs/man/memcached_delete.3 \ + docs/man/memcached_dump.3 \ + docs/man/memcached_flush_buffers.3 \ + docs/man/memcached_flush.3 \ + docs/man/memcached_generate_hash_value.3 \ + docs/man/memcached_get.3 \ + docs/man/memcached_memory_allocators.3 \ + docs/man/memcached_pool.3 \ + docs/man/memcached_quit.3 \ + docs/man/memcached_result_st.3 \ + docs/man/memcached_sasl.3 \ + docs/man/memcached_servers.3 \ + docs/man/memcached_server_st.3 \ + docs/man/memcached_set.3 \ + docs/man/memcached_stats.3 \ + docs/man/memcached_strerror.3 \ + docs/man/memcached_user_data.3 \ + docs/man/memcached_verbosity.3 \ + docs/man/memcached_version.3 \ + docs/man/memcapable.1 \ + docs/man/memcat.1 \ + docs/man/memcp.1 \ + docs/man/memdump.1 \ + docs/man/memerror.1 \ + docs/man/memflush.1 \ + docs/man/memrm.1 \ + docs/man/memslap.1 \ + docs/man/memstat.1 + ++man_MANS+= \ ++ memcached_destroy_sasl_auth_data.3 \ ++ memcached_get_sasl_callbacks.3 \ ++ memcached_sasl_set_auth_data.3 \ ++ memcached_set_sasl_callbacks.3 ++ ++HTML_FILES+= \ ++ memcached_destroy_sasl_auth_data.html \ ++ memcached_get_sasl_callbacks.html \ ++ memcached_sasl_set_auth_data.html \ ++ memcached_set_sasl_callbacks.html ++ ++SASL_PAGES= \ ++ memcached_destroy_sasl_auth_data.rst \ ++ memcached_get_sasl_callbacks.rst \ ++ memcached_sasl_set_auth_data.rst \ ++ memcached_set_sasl_callbacks.rst ++BUILT_SOURCES += ${SASL_PAGES} ++ + docs/man/hashkit_create.3: man + docs/man/hashkit_functions.3: man + docs/man/hashkit_value.3: man + docs/man/libmemcached_examples.3: man + docs/man/libmemcached.3: man + docs/man/libmemcachedutil.3: man + docs/man/memcached_analyze.3: man + docs/man/memcached_auto.3: man + docs/man/memcached_behavior.3: man + docs/man/memcached_callback.3: man + docs/man/memcached_create.3: man + docs/man/memcached_delete.3: man + docs/man/memcached_dump.3: man + docs/man/memcached_flush_buffers.3: man + docs/man/memcached_flush.3: man + docs/man/memcached_generate_hash_value.3: man + docs/man/memcached_get.3: man + docs/man/memcached_memory_allocators.3: man + docs/man/memcached_pool.3: man + docs/man/memcached_quit.3: man + docs/man/memcached_result_st.3: man + docs/man/memcached_sasl.3: man + docs/man/memcached_servers.3: man + docs/man/memcached_server_st.3: man + docs/man/memcached_set.3: man + docs/man/memcached_stats.3: man + docs/man/memcached_strerror.3: man + docs/man/memcached_user_data.3: man + docs/man/memcached_verbosity.3: man + docs/man/memcached_version.3: man + docs/man/memcapable.1: man + docs/man/memcat.1: man + docs/man/memcp.1: man + docs/man/memdump.1: man + docs/man/memerror.1: man + docs/man/memflush.1: man + docs/man/memrm.1: man + docs/man/memslap.1: man + docs/man/memstat.1: man + + endif + + if HAVE_SPHINX + sphinx-help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + + html-local: + PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/html." + + dirhtml: + PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/dirhtml." + + singlehtml: + PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(SPHINX_BUILDDIR)/singlehtml." + + pickle: + PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + + json: + PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + + htmlhelp: + PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(SPHINX_BUILDDIR)/htmlhelp." + + qthelp: + PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(SPHINX_BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(SPHINX_BUILDDIR)/qthelp/Drizzle.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(SPHINX_BUILDDIR)/qthelp/Drizzle.qhc" + + devhelp: + PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/Drizzle" + @echo "# ln -s $(SPHINX_BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Drizzle" + @echo "# devhelp" + + epub: + PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(SPHINX_BUILDDIR)/epub." + + latex: + PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(SPHINX_BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + + latexpdf: latex + PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + make -C $(SPHINX_BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(SPHINX_BUILDDIR)/latex." + + text: + PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(SPHINX_BUILDDIR)/text." + + man: + PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(SPHINX_BUILDDIR)/man." + + changes: + PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes + @echo + @echo "The overview file is in $(SPHINX_BUILDDIR)/changes." + + linkcheck: + PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(SPHINX_BUILDDIR)/linkcheck/output.txt." + + doctest: + PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(SPHINX_BUILDDIR)/doctest/output.txt." + endif ++ ++${CREATE_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_create.pod ${top_builddir}/docs/$@ ++ ++${SET_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_set.pod ${top_builddir}/docs/$@ ++ ++${DELETE_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_delete.pod ${top_builddir}/docs/$@ ++ ++${AUTO_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_auto.pod ${top_builddir}/docs/$@ ++ ++${GET_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_get.pod ${top_builddir}/docs/$@ ++ ++${SERVER_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_servers.pod ${top_builddir}/docs/$@ ++ ++${SERVER_ST_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_server_st.pod ${top_builddir}/docs/$@ ++ ++${GENERIC_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/$*.pod ${top_builddir}/docs/$@ ++ ++${BEHAVIOR_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_behavior.pod ${top_builddir}/docs/$@ ++ ++${CALLBACK_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_callback.pod ${top_builddir}/docs/$@ ++ ++${STATS_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_stats.pod ${top_builddir}/docs/$@ ++ ++${RESULT_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_result_st.pod ${top_builddir}/docs/$@ ++ ++${VERSION_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_version.pod ${top_builddir}/docs/$@ ++ ++${MEMORY_ALLOCATORS_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_memory_allocators.pod ${top_builddir}/docs/$@ ++ ++${USER_DATA_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_user_data.pod ${top_builddir}/docs/$@ ++ ++${POOL_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_pool.pod ${top_builddir}/docs/$@ ++ ++${HASHKIT_CREATE_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/hashkit_create.pod ${top_builddir}/docs/$@ ++ ++ ++${HASHKIT_FUNCTIONS_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/hashkit_functions.pod ${top_builddir}/docs/$@ ++ ++${HASHKIT_ST_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/hashkit_value.pod ${top_builddir}/docs/$@ ++ ++${SASL_PAGES}: ++ @rm -f $@ ++ ln -s ${top_srcdir}/docs/memcached_sasl.pod ${top_builddir}/docs/$@ ++ ++ diff --cc docs/memslap.pod.THIS index 00000000,00000000..43f714cc new file mode 100644 --- /dev/null +++ b/docs/memslap.pod.THIS @@@ -1,0 -1,0 +1,33 @@@ ++=head1 NAME ++ ++memslap - Load testing and benchmarking tool for memcached ++ ++=head1 SYNOPSIS ++ ++ memslap [options] ++ ++=head1 DESCRIPTION ++ ++B is a load generation and benchmark tool for memcached(1) ++servers. It simulates loads on memcached server clusters. ++ ++You can specify servers via the B<--servers> option or via the ++environment variable C. ++ ++For a full list of operations run the tool with the B<--help> option. ++ ++=head1 HOME ++ ++To find out more information please check: ++L ++ ++=head1 AUTHOR ++ ++Brian Aker, Ebrian@tangent.orgE ++ ++=head1 SEE ALSO ++ ++memcached(1) libmemcached(3) ++ ++=cut ++ diff --cc m4/pandora_warnings.m4 index 7ef435ff,95618975..0f6d47af --- a/m4/pandora_warnings.m4 +++ b/m4/pandora_warnings.m4 @@@ -127,9 -130,9 +130,9 @@@ AC_DEFUN([PANDORA_WARNINGS], ],[ m4_if(PW_LESS_WARNINGS,[no],[ - BASE_WARNINGS_FULL="${W_CONVERSION} -Wstrict-aliasing" + BASE_WARNINGS_FULL="${W_CONVERSION} -Wstrict-aliasing -Wswitch-enum " CC_WARNINGS_FULL="-Wswitch-default -Wswitch-enum -Wwrite-strings" - CXX_WARNINGS_FULL="-Weffc++ -Wold-style-cast" + CXX_WARNINGS_FULL="" NO_OLD_STYLE_CAST="-Wno-old-style-cast" NO_EFF_CXX="-Wno-effc++" ],[