Merge lp:~tangent-org/libmemcached/1.0-build Build: jenkins-Libmemcached-1.0-63

[awesomized/libmemcached] / docs / memcached_sasl.rst

diff --git a/docs/memcached_sasl.rst b/docs/memcached_sasl.rst
index bd51348bff8d3df3e0f6a612e07f37c4af50bb68..2a2e5699088047cc160a55d103600a363033c83b 100644 (file)
--- a/docs/memcached_sasl.rst
+++ b/docs/memcached_sasl.rst
@@ -15,9 +15,9 @@ SYNOPSIS
 
 .. c:function:: const sasl_callback_t *memcached_get_sasl_callbacks(memcached_st *ptr)
 
 
 .. c:function:: const sasl_callback_t *memcached_get_sasl_callbacks(memcached_st *ptr)
 

-.. c:function:: memcached_return memcached_set_sasl_auth_data(memcached_st *ptr, const char *username, const char *password)
+.. c:function:: memcached_return_t memcached_set_sasl_auth_data(memcached_st *ptr, const char *username, const char *password)

 
 

-.. c:function:: memcached_return memcached_destroy_sasl_auth_data(memcached_st *ptr)
+.. c:function:: memcached_return_t memcached_destroy_sasl_auth_data(memcached_st *ptr)

 
 Compile and link with -lmemcached
 
 
 Compile and link with -lmemcached
 


@@ -34,16 +34,13 @@ libsasl to perform SASL authentication.
 Please note that SASL requires the memcached binary protocol, and you have
 to specify the callbacks before you connect to the server.
 
 Please note that SASL requires the memcached binary protocol, and you have
 to specify the callbacks before you connect to the server.
 

-:c:func:`memcached_set_sasl_auth_data()` is a helper function defining
+:c:func:`memcached_set_sasl_auth_data` is a helper function defining

 the basic functionality for you, but it will store the username and password
 in memory. If you choose to use this method you have to call
 :c:type:`memcached_destroy_sasl_auth_data` before calling 
 :c:type:`memcached_free` to avoid a memory leak. You should NOT call 
 :c:type:`memcached_destroy_sasl_auth_data` if you specify your own callback 
 the basic functionality for you, but it will store the username and password
 in memory. If you choose to use this method you have to call
 :c:type:`memcached_destroy_sasl_auth_data` before calling 
 :c:type:`memcached_free` to avoid a memory leak. You should NOT call 
 :c:type:`memcached_destroy_sasl_auth_data` if you specify your own callback 

-function with :c:func:`memcached_set_sasl_callbacks()`.
-
-You as a client user have to initialize libsasl by using :c:type:`sasl_client_init` before enabling it in libmemcached, and you have to shut down libsasl by
-calling :c:func:`sasl_done()` when you are done using SASL from libmemcached.
+function with :c:func:`memcached_set_sasl_callbacks`.

 
 
 ------
 
 
 ------


@@ -51,8 +48,9 @@ RETURN
 ------
 
 
 ------
 
 

-:c:func:`memcached_get_sasl_callbacks()` returns the callbacks currently used
-by this memcached handle. :c:func:`memcached_get_sasl_set_auth_data()` returns :c:type:`MEMCACHED_SUCCESS` upon success.
+:c:func:`memcached_get_sasl_callbacks` returns the callbacks currently used by
+this memcached handle. :c:func:`memcached_set_sasl_auth_data` returns
+:c:type:`MEMCACHED_SUCCESS` upon success.

 
 
 ----
 
 
 ----