From: Brian Aker <brian@tangent.org>
Date: Thu, 14 Apr 2011 01:29:28 +0000 (-0700)
Subject: Merge in doc updates.
X-Git-Tag: 0.51~14
X-Git-Url: https://git.m6w6.name/?a=commitdiff_plain;h=b50e6755f3e6d65ace83556640d86ffc43dc7c1e;hp=1c8df302c16c766ef628eb4adfcac4ac30437026;p=awesomized%2Flibmemcached

Merge in doc updates.
---

diff --git a/Makefile.am b/Makefile.am
index 79b4cc7a..80b2c03e 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -64,7 +64,7 @@ generic:
 	cp ~/rpmbuild/RPMS/x86_64/libmemcached-$(VERSION)*.rpm .
 	cp ~/rpmbuild/SRPMS/libmemcached-$(VERSION)*.rpm .
 
-rpm: all dist generic fedora
+rpm: all man dist generic fedora
 
 merge-clean:
 	find ./ | $(GREP) \.gcda | xargs rm -f
diff --git a/docs/libmemcached_examples.rst b/docs/libmemcached_examples.rst
index 5c3acf6a..b0374981 100644
--- a/docs/libmemcached_examples.rst
+++ b/docs/libmemcached_examples.rst
@@ -13,24 +13,6 @@ For full examples, test cases are found in tests/\*.c in the main
 distribution. These are always up to date, and are used for each test run of
 the library.
 
------------------------------------------------
-Creating and Freeing the memcached_st structure
------------------------------------------------
-
-
-.. code-block:: c
-
-   memcached_st *memc;
-   memcached_return_t rc;
- 
-   memc= memcached_create(NULL);
-   ...do stuff...
-   memcached_free(memc);
-
-
-The above code would create a connection and then free the connection when
-finished.
-
 
 ---------------------
 Connecting to servers
@@ -41,7 +23,7 @@ Connecting to servers
 .. code-block:: c
 
    const char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com"
-   memcached_st *memc= memcached_create_with_options(config_string, strlen(config_string);
+   memcached_st *memc= memcached(config_string, strlen(config_string);
    {
     ...
    }
@@ -97,25 +79,14 @@ Adding a value to the server
 .. code-block:: c
 
    char *key= "foo";
-   char *value;
-   size_t value_length= 8191;
-   unsigned int x;
- 
-   value = (char*)malloc(value_length);
-   assert(value);
- 
-   for (x= 0; x < value_length; x++)
-   value[x] = (char) (x % 127);
- 
-   for (x= 0; x < 1; x++)
+   char *value= "value";
+
+   memcached_return_t rc= memcached_set(memc, key, strlen(key), value, value_length, (time_t)0, (uint32_t)0);
+
+   if (rc != MEMCACHED_SUCCESS)
    {
-     rc= memcached_set(memc, key, strlen(key), 
-     value, value_length,
-     (time_t)0, (uint32_t)0);
-     assert(rc == MEMCACHED_SUCCESS);
+   ... // handle failure
    }
- 
-   free(value);
 
 
 It is best practice to always look at the return value of any operation.
diff --git a/docs/man/libmemcached_examples.3 b/docs/man/libmemcached_examples.3
index e491e58f..bed8f658 100644
--- a/docs/man/libmemcached_examples.3
+++ b/docs/man/libmemcached_examples.3
@@ -37,27 +37,12 @@ Examples for libmemcached
 For full examples, test cases are found in tests/*.c in the main
 distribution. These are always up to date, and are used for each test run of
 the library.
-.SH CREATING AND FREEING THE MEMCACHED_ST STRUCTURE
-.sp
-.nf
-.ft C
-memcached_st *memc;
-memcached_return_t rc;
-
-memc= memcached_create(NULL);
-\&...do stuff...
-memcached_free(memc);
-.ft P
-.fi
-.sp
-The above code would create a connection and then free the connection when
-finished.
 .SH CONNECTING TO SERVERS
 .sp
 .nf
 .ft C
 const char *config_string= "\-\-SERVER=host10.example.com \-\-SERVER=host11.example.com \-\-SERVER=host10.example.com"
-memcached_st *memc= memcached_create_with_options(config_string, strlen(config_string);
+memcached_st *memc= memcached(config_string, strlen(config_string);
 {
  ...
 }
@@ -102,25 +87,14 @@ with the pool.
 .nf
 .ft C
 char *key= "foo";
-char *value;
-size_t value_length= 8191;
-unsigned int x;
-
-value = (char*)malloc(value_length);
-assert(value);
+char *value= "value";
 
-for (x= 0; x < value_length; x++)
-value[x] = (char) (x % 127);
+memcached_return_t rc= memcached_set(memc, key, strlen(key), value, value_length, (time_t)0, (uint32_t)0);
 
-for (x= 0; x < 1; x++)
+if (rc != MEMCACHED_SUCCESS)
 {
-  rc= memcached_set(memc, key, strlen(key),
-  value, value_length,
-  (time_t)0, (uint32_t)0);
-  assert(rc == MEMCACHED_SUCCESS);
+\&... // handle failure
 }
-
-free(value);
 .ft P
 .fi
 .sp