X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Finclude.am;h=b8b7a62be0aad4c2dcb26caa48eab81d7a0f1b76;hb=a6c3e3a3d04f379b1480c8c88a8eae17e54b1449;hp=9538941151f83573b06e3abeb0a61f32a1434975;hpb=1eae35aca01e152e10113cd97b7571ebd6eb5bd9;p=awesomized%2Flibmemcached diff --git a/docs/include.am b/docs/include.am index 95389411..b8b7a62b 100644 --- a/docs/include.am +++ b/docs/include.am @@ -3,10 +3,101 @@ # All paths should be given relative to the root EXTRA_DIST+= \ - docs/_static \ - docs/_templates \ docs/conf.py \ - ${top_srcdir}/docs/*.rst + docs/error_messages.rst \ + docs/client_errors/MEMCACHED_AUTH_CONTINUE.rst \ + docs/client_errors/MEMCACHED_AUTH_FAILURE.rst \ + docs/client_errors/MEMCACHED_AUTH_PROBLEM.rst \ + docs/client_errors/MEMCACHED_BAD_KEY_PROVIDED.rst \ + docs/client_errors/MEMCACHED_BUFFERED.rst \ + docs/client_errors/MEMCACHED_CLIENT_ERROR.rst \ + docs/client_errors/MEMCACHED_CONNECTION_BIND_FAILURE.rst \ + docs/client_errors/MEMCACHED_CONNECTION_FAILURE.rst \ + docs/client_errors/MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE.rst \ + docs/client_errors/MEMCACHED_DATA_DOES_NOT_EXIST.rst \ + docs/client_errors/MEMCACHED_DATA_EXISTS.rst \ + docs/client_errors/MEMCACHED_DELETED.rst \ + docs/client_errors/MEMCACHED_DEPRECATED.rst \ + docs/client_errors/MEMCACHED_E2BIG.rst \ + docs/client_errors/MEMCACHED_END.rst \ + docs/client_errors/MEMCACHED_ERRNO.rst \ + docs/client_errors/MEMCACHED_FAILURE.rst \ + docs/client_errors/MEMCACHED_FAIL_UNIX_SOCKET.rst \ + docs/client_errors/MEMCACHED_FETCH_NOTFINISHED.rst \ + docs/client_errors/MEMCACHED_HOST_LOOKUP_FAILURE.rst \ + docs/client_errors/MEMCACHED_INVALID_ARGUMENTS.rst \ + docs/client_errors/MEMCACHED_INVALID_HOST_PROTOCOL.rst \ + docs/client_errors/MEMCACHED_ITEM.rst \ + docs/client_errors/MEMCACHED_KEY_TOO_BIG.rst \ + docs/client_errors/MEMCACHED_MAXIMUM_RETURN.rst \ + docs/client_errors/MEMCACHED_MEMORY_ALLOCATION_FAILURE.rst \ + docs/client_errors/MEMCACHED_NOTFOUND.rst \ + docs/client_errors/MEMCACHED_NOTSTORED.rst \ + docs/client_errors/MEMCACHED_NOT_SUPPORTED.rst \ + docs/client_errors/MEMCACHED_NO_KEY_PROVIDED.rst \ + docs/client_errors/MEMCACHED_NO_SERVERS.rst \ + docs/client_errors/MEMCACHED_PARSE_ERROR.rst \ + docs/client_errors/MEMCACHED_PARSE_USER_ERROR.rst \ + docs/client_errors/MEMCACHED_PARTIAL_READ.rst \ + docs/client_errors/MEMCACHED_PROTOCOL_ERROR.rst \ + docs/client_errors/MEMCACHED_READ_FAILURE.rst \ + docs/client_errors/MEMCACHED_SERVER_ERROR.rst \ + docs/client_errors/MEMCACHED_SERVER_MARKED_DEAD.rst \ + docs/client_errors/MEMCACHED_SOME_ERRORS.rst \ + docs/client_errors/MEMCACHED_STAT.rst \ + docs/client_errors/MEMCACHED_STORED.rst \ + docs/client_errors/MEMCACHED_SUCCESS.rst \ + docs/client_errors/MEMCACHED_TIMEOUT.rst \ + docs/client_errors/MEMCACHED_UNKNOWN_READ_FAILURE.rst \ + docs/client_errors/MEMCACHED_UNKNOWN_STAT_KEY.rst \ + docs/client_errors/MEMCACHED_VALUE.rst \ + docs/client_errors/MEMCACHED_WRITE_FAILURE.rst \ + docs/hashkit_create.rst \ + docs/hashkit_functions.rst \ + docs/hashkit_value.rst \ + docs/index.rst \ + docs/libhashkit.rst \ + docs/libmemcached.rst \ + docs/libmemcached_configuration.rst \ + docs/libmemcached_examples.rst \ + docs/libmemcachedutil.rst \ + docs/memaslap.rst \ + docs/memcached_analyze.rst \ + docs/memcached_append.rst \ + docs/memcached_auto.rst \ + docs/memcached_behavior.rst \ + docs/memcached_callback.rst \ + docs/memcached_cas.rst \ + docs/memcached_create.rst \ + docs/memcached_delete.rst \ + docs/memcached_dump.rst \ + docs/memcached_flush.rst \ + docs/memcached_flush_buffers.rst \ + docs/memcached_generate_hash_value.rst \ + docs/memcached_get.rst \ + docs/memcached_memory_allocators.rst \ + docs/memcached_pool.rst \ + docs/memcached_quit.rst \ + docs/memcached_result_st.rst \ + docs/memcached_sasl.rst \ + docs/memcached_server_st.rst \ + docs/memcached_servers.rst \ + docs/memcached_set.rst \ + docs/memcached_stats.rst \ + docs/memcached_strerror.rst \ + docs/memcached_user_data.rst \ + docs/memcached_verbosity.rst \ + docs/memcached_version.rst \ + docs/memcapable.rst \ + docs/memcat.rst \ + docs/memcp.rst \ + docs/memdump.rst \ + docs/memerror.rst \ + docs/memflush.rst \ + docs/memrm.rst \ + docs/memslap.rst \ + docs/memstat.rst \ + docs/tap.rst # Makefile for Sphinx documentation # @@ -22,37 +113,101 @@ ALLSPHINXOPTS = -d $(SPHINX_BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOP .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_clone.3 \ + docs/man/hashkit_crc32.3 \ + docs/man/hashkit_create.3 \ + docs/man/hashkit_fnv1_32.3 \ + docs/man/hashkit_fnv1_64.3 \ + docs/man/hashkit_fnv1a_32.3 \ + docs/man/hashkit_fnv1a_64.3 \ + docs/man/hashkit_free.3 \ docs/man/hashkit_functions.3 \ + docs/man/hashkit_hsieh.3 \ + docs/man/hashkit_is_allocated.3 \ + docs/man/hashkit_jenkins.3 \ + docs/man/hashkit_md5.3 \ + docs/man/hashkit_murmur.3 \ docs/man/hashkit_value.3 \ - docs/man/libmemcached_examples.3 \ + docs/man/libhashkit.3 \ docs/man/libmemcached.3 \ + docs/man/libmemcached_examples.3 \ docs/man/libmemcachedutil.3 \ + docs/man/memaslap.1 \ + docs/man/memcached_add.3 \ + docs/man/memcached_add_by_key.3 \ docs/man/memcached_analyze.3 \ - docs/man/memcached_auto.3 \ - docs/man/memcached_behavior.3 \ - docs/man/memcached_callback.3 \ + docs/man/memcached_append.3 \ + docs/man/memcached_append_by_key.3 \ + docs/man/memcached_behavior_get.3 \ + docs/man/memcached_behavior_set.3 \ + docs/man/memcached_callback_get.3 \ + docs/man/memcached_callback_set.3 \ + docs/man/memcached_cas.3 \ + docs/man/memcached_cas_by_key.3 \ + docs/man/memcached_clone.3 \ docs/man/memcached_create.3 \ + docs/man/memcached_decrement.3 \ + docs/man/memcached_decrement_with_initial.3 \ docs/man/memcached_delete.3 \ + docs/man/memcached_delete_by_key.3 \ + docs/man/memcached_destroy_sasl_auth_data.3 \ docs/man/memcached_dump.3 \ + docs/man/memcached_fetch.3 \ + docs/man/memcached_fetch_execute.3 \ + docs/man/memcached_fetch_result.3 \ docs/man/memcached_flush_buffers.3 \ - docs/man/memcached_flush.3 \ + docs/man/memcached_free.3 \ + docs/man/memcached_generate_hash.3 \ + docs/man/libmemcached_check_configuration.3 \ + docs/man/libmemcached_configuration.3 \ + docs/man/memcached.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_get_by_key.3 \ + docs/man/memcached_get_memory_allocators.3 \ + docs/man/memcached_get_sasl_callbacks.3 \ + docs/man/memcached_get_user_data.3 \ + docs/man/memcached_increment.3 \ + docs/man/memcached_increment_with_initial.3 \ + docs/man/memcached_lib_version.3 \ + docs/man/memcached_mget.3 \ + docs/man/memcached_mget_by_key.3 \ + docs/man/memcached_mget_execute.3 \ + docs/man/memcached_mget_execute_by_key.3 \ + docs/man/memcached_pool_behavior_get.3 \ + docs/man/memcached_pool_behavior_set.3 \ + docs/man/memcached_pool_create.3 \ + docs/man/memcached_pool_destroy.3 \ + docs/man/memcached_pool_pop.3 \ + docs/man/memcached_pool_push.3 \ + docs/man/memcached_pool_st.3 \ + docs/man/memcached_prepend.3 \ + docs/man/memcached_prepend_by_key.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_replace.3 \ + docs/man/memcached_replace_by_key.3 \ + docs/man/memcached_sasl_set_auth_data.3 \ + docs/man/memcached_server_add.3 \ + docs/man/memcached_server_count.3 \ + docs/man/memcached_server_cursor.3 \ + docs/man/memcached_server_list.3 \ + docs/man/memcached_server_list_append.3 \ + docs/man/memcached_server_list_count.3 \ + docs/man/memcached_server_list_free.3 \ + docs/man/memcached_server_push.3 \ + docs/man/memcached_servers_parse.3 \ docs/man/memcached_set.3 \ - docs/man/memcached_stats.3 \ + docs/man/memcached_set_by_key.3 \ + docs/man/memcached_set_memory_allocators.3 \ + docs/man/memcached_set_sasl_callbacks.3 \ + docs/man/memcached_set_user_data.3 \ + docs/man/memcached_stat.3 \ + docs/man/memcached_stat_execute.3 \ + docs/man/memcached_stat_get_keys.3 \ + docs/man/memcached_stat_get_value.3 \ + docs/man/memcached_stat_servername.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 \ @@ -65,88 +220,6 @@ man_MANS+= \ 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 - -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: @@ -204,17 +277,17 @@ 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 "# qcollectiongenerator $(SPHINX_BUILDDIR)/qthelp/Libmemcached.qhcp" @echo "To view the help file:" - @echo "# assistant -collectionFile $(SPHINX_BUILDDIR)/qthelp/Drizzle.qhc" + @echo "# assistant -collectionFile $(SPHINX_BUILDDIR)/qthelp/Libmemcached.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 "# mkdir -p $$HOME/.local/share/devhelp/Libmemcached" + @echo "# ln -s $(SPHINX_BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Libmemcached" @echo "# devhelp" epub: