Add support for SASL
[m6w6/libmemcached] / docs / Makefile.am
index e9761c87f6f723228351b95d7b77199a487b5fef..348e9ca63096189870242e5acc53b7c722a1f682 100644 (file)
@@ -11,27 +11,30 @@ 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
+           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
+               memcached_behavior_get.pop \
+               memcached_behavior_set.pop
 BUILT_SOURCES += ${BEHAVIOR_PAGES}
 
 CALLBACK_PAGES= \
-       memcached_callback_get.pop \
-       memcached_callback_set.pop
+               memcached_callback_get.pop \
+               memcached_callback_set.pop
 BUILT_SOURCES += ${CALLBACK_PAGES}
 
 CREATE_PAGES= \
-            memcached_create.pop \
-            memcached_free.pop \
-            memcached_clone.pop
+             memcached_clone.pop \
+             memcached_create.pop \
+             memcached_free.pop \
+             memcached_servers_reset.pop
 BUILT_SOURCES += ${CREATE_PAGES}
 
 DELETE_PAGES= \
@@ -40,26 +43,26 @@ DELETE_PAGES= \
 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 \
-       memslap.pop \
-       memstat.pop
+              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 \
+              memslap.pop \
+              memstat.pop
 BUILT_SOURCES += ${GENERIC_PAGES}
 
 GET_PAGES= \
@@ -76,16 +79,17 @@ BUILT_SOURCES += ${GET_PAGES}
 
 MEMORY_ALLOCATORS_PAGES= \
                         memcached_get_memory_allocators.pop \
-                        memcached_set_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 
+           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= \
@@ -103,17 +107,18 @@ 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 
+             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 
+                memcached_servers_parse.pop
 BUILT_SOURCES += ${SERVER_ST_PAGES}
 
 SET_PAGES= \
@@ -132,10 +137,10 @@ SET_PAGES= \
 BUILT_SOURCES += ${SET_PAGES}
 
 STATS_PAGES= \
-       memcached_stat.pop \
-       memcached_stat_get_keys.pop .pop\
-       memcached_stat_get_value.pop \
-       memcached_stat_servername.pop
+            memcached_stat.pop \
+            memcached_stat_get_keys.pop .pop\
+            memcached_stat_get_value.pop \
+            memcached_stat_servername.pop
 BUILT_SOURCES += ${STATS_PAGES}
 
 USER_DATA_PAGES= \
@@ -153,27 +158,27 @@ BUILT_SOURCES += ${VERSION_PAGES}
 # These are for libhashkit
 #
 HASHKIT_CREATE_PAGES= \
-            hashkit_is_allocated.pop \
-            hashkit_create.pop \
-            hashkit_clone.pop \
-            hashkit_free.pop
+                     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
+                        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
+                 hashkit_value.pop
 BUILT_SOURCES += ${HASHKIT_ST_PAGES}
 
 
@@ -255,6 +260,7 @@ HTML_FILES= \
            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 \
@@ -282,7 +288,7 @@ HTML_FILES= \
            memslap.html \
            memstat.html
 
-EXTRA_DIST = \
+POD_FILES= \
             hashkit_create.pod \
             hashkit_functions.pod \
             hashkit_value.pod \
@@ -320,78 +326,123 @@ EXTRA_DIST = \
             memrm.pod \
             memslap.pod \
             memstat.pod
+EXTRA_DIST+= $(POD_FILES)
 
 man_MANS = \
-         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_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_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 \
-         memslap.1 \
-         memstat.1
+          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_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 \
+          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+= \
@@ -405,11 +456,11 @@ man_MANS+= \
 endif
 
 
-${CREATE_PAGES}: 
+${CREATE_PAGES}:
        @rm -f $@
        ln -s ${top_srcdir}/docs/memcached_create.pod ${top_builddir}/docs/$@
 
-${SET_PAGES}: 
+${SET_PAGES}:
        @rm -f $@
        ln -s ${top_srcdir}/docs/memcached_set.pod ${top_builddir}/docs/$@
 
@@ -465,7 +516,6 @@ ${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/$@
@@ -483,44 +533,16 @@ ${HASHKIT_ST_PAGES}:
        @rm -f $@
        ln -s ${top_srcdir}/docs/hashkit_value.pod ${top_builddir}/docs/$@
 
-test-docs: $(EXTRA_DIST)
+test-docs: $(POD_FILES)
        ${PODCHECKER} $(top_srcdir)/docs/$?
 
-#      ${PODCHECKER} $(top_srcdir)/docs/hashkit_create.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/hashkit_functions.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/hashkit_value.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/libmemcached.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/libmemcached_examples.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memcached_auto.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memcached_behavior.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memcached_callback.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memcached_create.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memcached_delete.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memcached_flush.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memcached_flush_buffers.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memcached_get.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memcached_memory_allocators.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memcached_pool.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memcached_quit.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memcached_server_st.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memcached_servers.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memcached_set.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memcached_stats.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memcached_strerror.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memcached_user_data.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memcached_verbosity.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memcached_version.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memcapable.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memcat.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memcp.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memerror.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memflush.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memrm.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memslap.pod
-#      ${PODCHECKER} $(top_srcdir)/docs/memstat.pod
+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}