1
=== modified file 'docs/hashkit_create.rst'
2
--- docs/hashkit_create.rst	2011-04-14 04:27:08 +0000
3
+++ docs/hashkit_create.rst	2011-04-18 19:22:31 +0000
4
@@ -22,9 +22,9 @@
5
22
22
6
23
.. code-block:: perl
23
.. code-block:: perl
7
24
24
9
25
   #include <libmemcached/hashkit.h>
25
#include <libmemcached/hashkit.h>
10
26
 
26
 
12
27
   hashkit_st *hashkit_create(hashkit_st *hash);
27
hashkit_st *hashkit_create(hashkit_st *hash);
13
28
 
28
 
14
29
   hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
29
   hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
15
30
 
30
 
16
31
31
17
=== modified file 'docs/libmemcached.rst'
18
--- docs/libmemcached.rst	2011-04-14 04:27:08 +0000
19
+++ docs/libmemcached.rst	2011-04-18 19:22:31 +0000
20
@@ -6,10 +6,17 @@
21
6
SYNOPSIS
6
SYNOPSIS
22
7
--------
7
--------
23
8
8
28
9
#include <libmemcached/memcached.h>
9
libMemcached is an open source C/C++ client library and tools for the memcached server (http://danga.com/memcached). It has been designed to be light on memory usage, thread safe, and provide full access to server side methods.
29
10
10
30
11
Compile and link with -lmemcached
11
libMemcached was designed to provide the greatest number of options to use Memcached. Some of the features provided:
31
12
12
32
13
1. Asynchronous and Synchronous Transport Support.
33
14
2. Consistent Hashing and Distribution.
34
15
3. Tunable Hashing algorithm to match keys.
35
16
4. Access to large object support.
36
17
5. Local replication.
37
18
6. A complete reference guide and documentation to the API.
38
19
7. Tools to Manage your Memcached networks.
39
13
20
40
14
-----------
21
-----------
41
15
DESCRIPTION
22
DESCRIPTION
42
@@ -21,14 +28,14 @@
43
21
applications by alleviating database load." `http://danga.com/memcached/ <http://danga.com/memcached/>`_
28
applications by alleviating database load." `http://danga.com/memcached/ <http://danga.com/memcached/>`_
44
22
29
45
23
\ **libmemcached**\  is a small, thread-safe client library for the
30
\ **libmemcached**\  is a small, thread-safe client library for the
47
24
memcached protocol. The code has all been written with an eye to allow
31
memcached protocol. The code has all been written to allow
48
25
for both web and embedded usage. It handles the work behind routing
32
for both web and embedded usage. It handles the work behind routing
52
26
particular keys to specific servers that you specify (and values are
33
individual keys to specific servers specified by the developer (and values are
53
27
matched based on server order as supplied by you). It implements both
34
matched based on server order as supplied by the user). It implements
54
28
a modula and consistent method of object distribution.
35
a modular and consistent method of object distribution.
55
29
36
56
30
There are multiple implemented routing and hashing methods. See the
37
There are multiple implemented routing and hashing methods. See the
58
31
memcached_behavior_set() manpage.
38
memcached_behavior_set() manpage for more information.
59
32
39
60
33
All operations are performed against a \ ``memcached_st``\  structure.
40
All operations are performed against a \ ``memcached_st``\  structure.
61
34
These structures can either be dynamically allocated or statically
41
These structures can either be dynamically allocated or statically
62
@@ -117,9 +124,9 @@
63
117
---------------------
124
---------------------
64
118
125
65
119
126
67
120
When using threads or forked processes it is important to keep an instance
127
When using threads or forked processes it is important to keep one instance
68
121
of \ ``memcached_st``\  per process or thread. Without creating your own locking
128
of \ ``memcached_st``\  per process or thread. Without creating your own locking
70
122
structures you can not share a single \ ``memcached_st``\ . You can though call
129
structures you can not share a single \ ``memcached_st``\ . However, you can call
71
123
memcached_quit(3) on a \ ``memcached_st``\  and then use the resulting cloned
130
memcached_quit(3) on a \ ``memcached_st``\  and then use the resulting cloned
72
124
structure.
131
structure.
73
125
132
74
126
133
75
=== modified file 'docs/memcached_callback.rst'
76
--- docs/memcached_callback.rst	2011-04-14 04:27:08 +0000
77
+++ docs/memcached_callback.rst	2011-04-18 19:22:31 +0000
78
@@ -41,73 +41,71 @@
79
41
memcached_callback_set() changes the function/structure assigned by a
41
memcached_callback_set() changes the function/structure assigned by a
80
42
callback flag. No connections are reset.
42
callback flag. No connections are reset.
81
43
43
84
44
You can use MEMCACHED_CALLBACK_USER_DATA to provide custom context if required for any 
44
You can use MEMCACHED_CALLBACK_USER_DATA to provide custom context if required for any of the callbacks.
83
45
of the callbacks
85
46
45
86
47
46
87
48
.. c:var:: MEMCACHED_CALLBACK_CLEANUP_FUNCTION
47
.. c:var:: MEMCACHED_CALLBACK_CLEANUP_FUNCTION
88
49
 
48
 
91
50
 When memcached_delete() is called this function will be excuted. At the
49
When memcached_delete() is called this function will be excuted. At the point of its execution all connections are closed.
90
51
 point of its execution all connections have been closed.
92
52
 
50
 
93
53
51
94
54
52
95
55
.. c:var:: MEMCACHED_CALLBACK_CLONE_FUNCTION
53
.. c:var:: MEMCACHED_CALLBACK_CLONE_FUNCTION
96
56
 
54
 
99
57
 When memcached_delete() is called this function will be excuted. At the
55
When memcached_delete() is called this function will be excuted. At the
100
58
 point of its execution all connections have been closed.
56
point of its execution all connections are closed.
101
59
 
57
 
102
60
58
103
61
59
104
62
.. c:var:: MEMCACHED_CALLBACK_PREFIX_KEY
60
.. c:var:: MEMCACHED_CALLBACK_PREFIX_KEY
105
63
 
61
 
112
64
 You can set a value which will be used to create a domain for your keys.
62
You can set a value which will be used to create a domain for your keys.
113
65
 The value specified here will be prefixed to each of your keys. The value can not
63
The value specified here will be prefixed to each of your keys. The value can not be greater then MEMCACHED_PREFIX_KEY_MAX_SIZE - 1 and will reduce MEMCACHED_MAX_KEY by the value of your key. 
114
66
 be greater then MEMCACHED_PREFIX_KEY_MAX_SIZE - 1 and will reduce MEMCACHED_MAX_KEY by
64
115
67
 the value of your key. The prefix key is only applied to the primary key,
65
The prefix key is only applied to the primary key, not the master key. MEMCACHED_FAILURE will be returned if no key is set. In the case of a key which is too long, MEMCACHED_BAD_KEY_PROVIDED will be returned.
110
68
 not the master key. MEMCACHED_FAILURE will be returned if no key is set. In the case
111
69
 of a key which is too long MEMCACHED_BAD_KEY_PROVIDED will be returned.
116
70
 
66
 
118
71
 If you set a value with the value being NULL then the prefix key is disabled.
67
If you set a value with the value being NULL then the prefix key is disabled.
119
72
68
120
73
69
121
74
.. c:var:: MEMCACHED_CALLBACK_USER_DATA
70
.. c:var:: MEMCACHED_CALLBACK_USER_DATA
122
75
 
71
 
126
76
 This allows you to store a pointer to a specifc piece of data. This can be
72
This allows you to store a pointer to a specifc piece of data. This can be
127
77
 retrieved from inside of memcached_fetch_execute(). Cloning a memcached_st
73
retrieved from inside of memcached_fetch_execute(). Cloning a memcached_st
128
78
 will copy the pointer to the clone.
74
will copy the pointer to the clone.
129
79
 
75
 
130
80
76
131
81
77
132
82
.. c:var:: MEMCACHED_CALLBACK_MALLOC_FUNCTION
78
.. c:var:: MEMCACHED_CALLBACK_MALLOC_FUNCTION
133
83
 
79
 
135
84
 DEPRECATED: use memcached_set_memory_allocators instead.
80
DEPRECATED: use memcached_set_memory_allocators instead.
136
85
 
81
 
137
86
82
138
87
83
139
88
.. c:var:: MEMCACHED_CALLBACK_REALLOC_FUNCTION
84
.. c:var:: MEMCACHED_CALLBACK_REALLOC_FUNCTION
140
89
 
85
 
142
90
 DEPRECATED: use memcached_set_memory_allocators instead.
86
DEPRECATED: use memcached_set_memory_allocators instead.
143
91
 
87
 
144
92
88
145
93
89
146
94
.. c:var:: MEMCACHED_CALLBACK_FREE_FUNCTION
90
.. c:var:: MEMCACHED_CALLBACK_FREE_FUNCTION
147
95
 
91
 
149
96
 DEPRECATED: use memcached_set_memory_allocators instead.
92
DEPRECATED: use memcached_set_memory_allocators instead.
150
97
 
93
 
151
98
94
152
99
95
153
100
.. c:var:: MEMCACHED_CALLBACK_GET_FAILURE
96
.. c:var:: MEMCACHED_CALLBACK_GET_FAILURE
154
101
 
97
 
161
102
 This function implements the read through cache behavior. On failure of retrieval this callback will be called. 
98
This function implements the read through cache behavior. On failure of retrieval this callback will be called. 
162
103
 You are responsible for populating the result object provided. This result object will then be stored in the server and
99
163
104
 returned to the calling process. You must clone the memcached_st in order to
100
You are responsible for populating the result object provided. This result object will then be stored in the server and returned to the calling process. 
164
105
 make use of it. The value will be stored only if you return
101
165
106
 MEMCACHED_SUCCESS or MEMCACHED_BUFFERED. Returning MEMCACHED_BUFFERED will
102
You must clone the memcached_st in order to
166
107
 cause the object to be buffered and not sent immediatly (if this is the default behavior based on your connection setup this will happen automatically).
103
make use of it. The value will be stored only if you return
167
104
MEMCACHED_SUCCESS or MEMCACHED_BUFFERED. Returning MEMCACHED_BUFFERED will
168
105
cause the object to be buffered and not sent immediatly (if this is the default behavior based on your connection setup this will happen automatically).
169
108
 
106
 
172
109
 The prototype for this is:
107
The prototype for this is:
173
110
 memcached_return_t (\*memcached_trigger_key)(memcached_st \*ptr, char \*key, size_t key_length, memcached_result_st \*result);
108
memcached_return_t (\*memcached_trigger_key)(memcached_st \*ptr, char \*key, size_t key_length, memcached_result_st \*result);
174
111
 
109
 
175
112
110
176
113
111
177
114
112
178
=== modified file 'docs/memcached_delete.rst'
179
--- docs/memcached_delete.rst	2011-04-14 04:27:08 +0000
180
+++ docs/memcached_delete.rst	2011-04-18 19:22:31 +0000
181
@@ -25,8 +25,8 @@
182
25
find the given value.
25
find the given value.
183
26
26
184
27
Expiration works by placing the item into a delete queue, which means that
27
Expiration works by placing the item into a delete queue, which means that
187
28
it won't possible to retrieve it by the "get" command, but "add" and 
28
it won't be possible to retrieve it by the "get" command. The "add" and 
188
29
"replace" command with this key will also fail (the "set" command will 
29
"replace" commands with this key will also fail (the "set" command will 
189
30
succeed, however). After the time passes, the item is finally deleted from server memory.
30
succeed, however). After the time passes, the item is finally deleted from server memory.
190
31
31
191
32
Please note the the Danga memcached server removed tests for expiration in
32
Please note the the Danga memcached server removed tests for expiration in
192
33
33
193
=== modified file 'docs/memcached_dump.rst'
194
--- docs/memcached_dump.rst	2011-04-14 04:27:08 +0000
195
+++ docs/memcached_dump.rst	2011-04-18 19:22:31 +0000
196
@@ -42,12 +42,12 @@
197
42
-----------
42
-----------
198
43
43
199
44
44
201
45
memcached_dump() is used to get a list of keys found  memcached(1) servers.
45
memcached_dump() is used to get a list of keys found in memcached(1) servers.
202
46
Because memcached(1) does not guarentee to dump all keys you can not assume
46
Because memcached(1) does not guarentee to dump all keys you can not assume
203
47
you have fetched all keys from the server. The function takes an array
47
you have fetched all keys from the server. The function takes an array
204
48
of callbacks that it will use to execute on keys as they are found.
48
of callbacks that it will use to execute on keys as they are found.
205
49
49
207
50
Currently the binar protocol is not testsed.
50
Currently the binary protocol is not testsed.
208
51
51
209
52
52
210
53
------
53
------
211
54
54
212
=== modified file 'docs/memcached_get.rst'
213
--- docs/memcached_get.rst	2011-04-14 04:27:08 +0000
214
+++ docs/memcached_get.rst	2011-04-18 19:22:31 +0000
215
@@ -65,7 +65,7 @@
216
65
upon success and NULL will be returned on failure. MEMCACHD_END is returned
65
upon success and NULL will be returned on failure. MEMCACHD_END is returned
217
66
by the \*error value when all objects that have been found are returned.
66
by the \*error value when all objects that have been found are returned.
218
67
The final value upon MEMCACHED_END is null. Values returned by
67
The final value upon MEMCACHED_END is null. Values returned by
220
68
memcached_fetch() musted be free'ed by the caller. memcached_fetch() will
68
memcached_fetch() must be freed by the caller. memcached_fetch() will
221
69
be DEPRECATED in the near future, memcached_fetch_result() should be used
69
be DEPRECATED in the near future, memcached_fetch_result() should be used
222
70
instead.
70
instead.
223
71
71
224
@@ -89,7 +89,7 @@
225
89
similar to memcached_mget(), but it may trigger the supplied callbacks
89
similar to memcached_mget(), but it may trigger the supplied callbacks
226
90
with result sets while sending out the queries. If you try to perform
90
with result sets while sending out the queries. If you try to perform
227
91
a really large multiget with memcached_mget() you may encounter a
91
a really large multiget with memcached_mget() you may encounter a
229
92
deadlock in the OS kernel (we fail to write data to the socket because
92
deadlock in the OS kernel (it will fail to write data to the socket because
230
93
the input buffer is full). memcached_mget_execute() solves this
93
the input buffer is full). memcached_mget_execute() solves this
231
94
problem by processing some of the results before continuing sending
94
problem by processing some of the results before continuing sending
232
95
out requests. Please note that this function is only available in the
95
out requests. Please note that this function is only available in the
233
@@ -100,9 +100,9 @@
234
100
a master key that is used for determining which server an object was stored
100
a master key that is used for determining which server an object was stored
235
101
if key partitioning was used for storage.
101
if key partitioning was used for storage.
236
102
102
238
103
All of the above functions are not testsed when the \ ``MEMCACHED_BEHAVIOR_USE_UDP``\ 
103
All of the above functions are not tested when the \ ``MEMCACHED_BEHAVIOR_USE_UDP``\ 
239
104
has been set. Executing any of these functions with this behavior on will result in
104
has been set. Executing any of these functions with this behavior on will result in
241
105
\ ``MEMCACHED_NOT_SUPPORTED``\  being returned or, for those functions which do not return
105
\ ``MEMCACHED_NOT_SUPPORTED``\  being returned, or for those functions which do not return
242
106
a \ ``memcached_return_t``\ , the error function parameter will be set to
106
a \ ``memcached_return_t``\ , the error function parameter will be set to
243
107
\ ``MEMCACHED_NOT_SUPPORTED``\ .
107
\ ``MEMCACHED_NOT_SUPPORTED``\ .
244
108
108
245
109
109
246
=== modified file 'docs/memcached_memory_allocators.rst'
247
--- docs/memcached_memory_allocators.rst	2011-04-14 04:27:08 +0000
248
+++ docs/memcached_memory_allocators.rst	2011-04-18 19:22:31 +0000
249
@@ -45,7 +45,7 @@
250
45
-----------
45
-----------
251
46
46
252
47
47
254
48
libmemcached(3) allows you to specify your own memory allocators optimized
48
libmemcached(3) allows you to specify your own memory allocators, optimized
255
49
for your application. This enables libmemcached to be used inside of applications that have their own malloc implementation.
49
for your application. This enables libmemcached to be used inside of applications that have their own malloc implementation.
256
50
50
257
51
memcached_set_memory_allocators() is used to set the memory allocators used
51
memcached_set_memory_allocators() is used to set the memory allocators used
258
52
52
259
=== modified file 'docs/memcached_result_st.rst'
260
--- docs/memcached_result_st.rst	2011-04-14 04:27:08 +0000
261
+++ docs/memcached_result_st.rst	2011-04-18 19:22:31 +0000
262
@@ -59,9 +59,9 @@
263
59
59
264
60
libmemcached(3) can optionally return a memcached_result_st which acts as a
60
libmemcached(3) can optionally return a memcached_result_st which acts as a
265
61
result object. The result objects have added benefits over the character
61
result object. The result objects have added benefits over the character
267
62
pointer returns in that they are forward compatible with new return items
62
pointer returns, in that they are forward compatible with new return items
268
63
that future memcached servers may implement (the best current example of
63
that future memcached servers may implement (the best current example of
270
64
this is the CAS return item). The structures can also be reused which will
64
this is the CAS return item). The structures can also be reused, which will
271
65
save on calls to malloc(3). It is suggested that you use result objects over
65
save on calls to malloc(3). It is suggested that you use result objects over
272
66
char \* return functions.
66
char \* return functions.
273
67
67
274
@@ -72,7 +72,7 @@
275
72
memcached_result_st or will initialize a structure passed to it.
72
memcached_result_st or will initialize a structure passed to it.
276
73
73
277
74
memcached_result_free() will deallocate any memory attached to the
74
memcached_result_free() will deallocate any memory attached to the
279
75
structure. If the structure was also alloacted, it will deallocate it.
75
structure. If the structure was also allocated, it will deallocate it.
280
76
76
281
77
memcached_result_key_value() returns the key value associated with the
77
memcached_result_key_value() returns the key value associated with the
282
78
current result object.
78
current result object.
283
@@ -91,7 +91,7 @@
284
91
91
285
92
memcached_result_cas() returns the cas associated with the
92
memcached_result_cas() returns the cas associated with the
286
93
current result object. This value will only be available if the server
93
current result object. This value will only be available if the server
288
94
testss it.
94
tests it.
289
95
95
290
96
memcached_result_set_value() takes a byte array and a size and sets
96
memcached_result_set_value() takes a byte array and a size and sets
291
97
the result to this value. This function is used for trigger responses.
97
the result to this value. This function is used for trigger responses.
292
98
98
293
=== modified file 'docs/memcached_sasl.rst'
294
--- docs/memcached_sasl.rst	2011-04-09 00:46:34 +0000
295
+++ docs/memcached_sasl.rst	2011-04-18 19:22:31 +0000
296
@@ -44,7 +44,7 @@
297
44
Please note that SASL requires the memcached binary protocol, and you have
44
Please note that SASL requires the memcached binary protocol, and you have
298
45
to specify the callbacks before you connect to the server.
45
to specify the callbacks before you connect to the server.
299
46
46
301
47
memcached_set_sasl_auth_data() is a helper function for you defining
47
memcached_set_sasl_auth_data() is a helper function defining
302
48
the basic functionality for you, but it will store the username and password
48
the basic functionality for you, but it will store the username and password
303
49
in memory. If you choose to use this method you have to call
49
in memory. If you choose to use this method you have to call
304
50
memcached_destroy_sasl_auth_data before calling memcached_free to avoid
50
memcached_destroy_sasl_auth_data before calling memcached_free to avoid
305
51
51
306
=== modified file 'docs/memcached_set.rst'
307
--- docs/memcached_set.rst	2011-04-14 04:27:08 +0000
308
+++ docs/memcached_set.rst	2011-04-18 19:22:31 +0000
309
@@ -49,8 +49,8 @@
310
49
memcached_set(), memcached_add(), and memcached_replace() are all used to
49
memcached_set(), memcached_add(), and memcached_replace() are all used to
311
50
store information on the server. All methods take a key, and its length to
50
store information on the server. All methods take a key, and its length to
312
51
store the object. Keys are currently limited to 250 characters by the
51
store the object. Keys are currently limited to 250 characters by the
315
52
memcached(1) server. You must also supply a value and a length. Optionally you
52
memcached(1) server. You must supply both a value and a length. Optionally you
316
53
may tests an expiration time for the object and a 16 byte value (it is
53
may test an expiration time for the object and a 16 byte value (it is
317
54
meant to be used as a bitmap).
54
meant to be used as a bitmap).
318
55
55
319
56
memcached_set() will write an object to the server. If an object already
56
memcached_set() will write an object to the server. If an object already
320
@@ -87,12 +87,12 @@
321
87
the fastest way to store data on the server.
87
the fastest way to store data on the server.
322
88
88
323
89
All of the above functions are testsed with the \ ``MEMCACHED_BEHAVIOR_USE_UDP``\ 
89
All of the above functions are testsed with the \ ``MEMCACHED_BEHAVIOR_USE_UDP``\ 
325
90
behavior enabled. But when using these operations with this behavior on, there 
90
behavior enabled. However, when using these operations with this behavior on, there 
326
91
are limits to the size of the payload being sent to the server.  The reason for 
91
are limits to the size of the payload being sent to the server.  The reason for 
328
92
these limits is that the Memcahed Server does not allow multi-datagram requests
92
these limits is that the Memcached Server does not allow multi-datagram requests
329
93
and the current server implementation sets a datagram size to 1400 bytes. Due 
93
and the current server implementation sets a datagram size to 1400 bytes. Due 
330
94
to protocol overhead, the actual limit of the user supplied data is less than 
94
to protocol overhead, the actual limit of the user supplied data is less than 
332
95
1400 bytes and depends on the protocol in use as well as the operation being 
95
1400 bytes and depends on the protocol in use as, well as the operation being 
333
96
executed. When running with the binary protocol, \ `` MEMCACHED_BEHAVIOR_BINARY_PROTOCOL``\ , 
96
executed. When running with the binary protocol, \ `` MEMCACHED_BEHAVIOR_BINARY_PROTOCOL``\ , 
334
97
the size of the key,value, flags and expiry combined may not exceed 1368 bytes. 
97
the size of the key,value, flags and expiry combined may not exceed 1368 bytes. 
335
98
When running with the ASCII protocol, the exact limit fluctuates depending on 
98
When running with the ASCII protocol, the exact limit fluctuates depending on 
336
99
99
337
=== modified file 'docs/memcached_version.rst'
338
--- docs/memcached_version.rst	2011-04-14 04:27:08 +0000
339
+++ docs/memcached_version.rst	2011-04-18 19:22:31 +0000
340
@@ -39,7 +39,7 @@
341
39
39
342
40
40
343
41
memcached_lib_version() is used to return a simple version string representing
41
memcached_lib_version() is used to return a simple version string representing
345
42
the libmemcached version (version of the client library, not server)
42
the libmemcached version (client library version, not server version)
346
43
43
347
44
memcached_version() is used to set the major, minor, and micro versions of each
44
memcached_version() is used to set the major, minor, and micro versions of each
348
45
memcached server being used by the memcached_st connection structure. It returns the 
45
memcached server being used by the memcached_st connection structure. It returns the 
349
46
46
350
=== modified file 'docs/memcapable.rst'
351
--- docs/memcapable.rst	2011-04-14 04:27:08 +0000
352
+++ docs/memcapable.rst	2011-04-18 19:22:31 +0000
353
@@ -16,29 +16,29 @@
354
16
16
355
17
.. option:: -h hostname
17
.. option:: -h hostname
356
18
 
18
 
358
19
 Specify the hostname to connect to. The default is \ *localhost*\ 
19
Specify the hostname to connect to. The default is \ *localhost*\ 
359
20
20
360
21
.. option:: -p port
21
.. option:: -p port
361
22
 
22
 
363
23
 Specify the port number to connect to. The default is \ *11211*\ 
23
Specify the port number to connect to. The default is \ *11211*\ 
364
24
 
24
 
365
25
25
366
26
26
367
27
.. option:: -c
27
.. option:: -c
368
28
 
28
 
370
29
 Generate a coredump when it detects an error from the server.
29
Generate a coredump when it detects an error from the server.
371
30
 
30
 
372
31
31
373
32
32
374
33
.. option:: -v
33
.. option:: -v
375
34
 
34
 
377
35
  Print out the comparison when it detects an error from the server.
35
Print out the comparison when it detects an error from the server.
378
36
 
36
 
379
37
37
380
38
38
381
39
.. option:: -t n
39
.. option:: -t n
382
40
 
40
 
384
41
 Set the timeout from an IO operation to/from the server to \ *n*\  seconds.
41
Set the timeout from an IO operation to/from the server to \ *n*\  seconds.
385
42
 
42
 
386
43
-----------
43
-----------
387
44
DESCRIPTION
44
DESCRIPTION
388
45
45
389
=== modified file 'docs/memcp.rst'
390
--- docs/memcp.rst	2011-04-14 04:27:08 +0000
391
+++ docs/memcp.rst	2011-04-18 19:22:31 +0000
392
@@ -26,11 +26,10 @@
393
26
It is similar to the standard UNIX cp(1) command.
26
It is similar to the standard UNIX cp(1) command.
394
27
27
395
28
The key names will be the names of the files,
28
The key names will be the names of the files,
397
29
without any directory path part.
29
without any directory path.
398
30
30
399
31
You can specify servers via the \ **--servers**\  option or via the
31
You can specify servers via the \ **--servers**\  option or via the
402
32
environment variable \ ``MEMCACHED_SERVERS``\ . If you specify neither of
32
environment variable \ ``MEMCACHED_SERVERS``\. If you do not specify either these, the final value in the command line list is the name of a
401
33
these, the final value in the command line list is the name of a
403
34
server(s).
33
server(s).
404
35
34
405
36
For a full list of operations run the tool with the \ **--help**\  option.
35
For a full list of operations run the tool with the \ **--help**\  option.
406
37
36
407
=== modified file 'docs/memdump.rst'
408
--- docs/memdump.rst	2011-04-14 04:27:08 +0000
409
+++ docs/memdump.rst	2011-04-18 19:22:31 +0000
410
@@ -21,7 +21,7 @@
411
21
-----------
21
-----------
412
22
22
413
23
23
415
24
\ **memdump**\  currently dumps a list of "keys" from all servers that 
24
\ **memdump**\  dumps a list of "keys" from all servers that 
416
25
it is told to fetch from. Because memcached does not guarentee to
25
it is told to fetch from. Because memcached does not guarentee to
417
26
provide all keys it is not possible to get a complete "dump".
26
provide all keys it is not possible to get a complete "dump".
418
27
27
419
28
28
420
=== modified file 'docs/memerror.rst'
421
--- docs/memerror.rst	2011-04-14 04:27:08 +0000
422
+++ docs/memerror.rst	2011-04-18 19:22:31 +0000
423
@@ -3,7 +3,7 @@
424
3
==============================================
3
==============================================
425
4
4
426
5
5
428
6
Translate a memcached error code to a string
6
Translates a memcached error code into a string
429
7
7
430
8
8
431
9
--------
9
--------
432
@@ -21,7 +21,7 @@
433
21
-----------
21
-----------
434
22
22
435
23
23
437
24
\ **memerror**\  translate an error code from libmemcached(3) to  a human
24
\ **memerror**\  translate an error code from libmemcached(3) into a human
438
25
readable string.
25
readable string.
439
26
26
440
27
For a full list of operations run the tool with the \ **--help**\  option.
27
For a full list of operations run the tool with the \ **--help**\  option.
441
28
28
442
=== modified file 'docs/memflush.rst'
443
--- docs/memflush.rst	2011-04-14 04:27:08 +0000
444
+++ docs/memflush.rst	2011-04-18 19:22:31 +0000
445
@@ -22,7 +22,7 @@
446
22
22
447
23
23
448
24
\ **memflush**\  resets the contents of memcached(1) servers.
24
\ **memflush**\  resets the contents of memcached(1) servers.
450
25
This means all data in these servers will be deleted.
25
This means that all data in the specified servers will be deleted.
451
26
26
452
27
You can specify servers via the \ **--servers**\  option or via the
27
You can specify servers via the \ **--servers**\  option or via the
453
28
environment variable \ ``MEMCACHED_SERVERS``\ .
28
environment variable \ ``MEMCACHED_SERVERS``\ .
454
29
29
455
=== modified file 'docs/memslap.rst'
456
--- docs/memslap.rst	2011-04-11 05:22:20 +0000
457
+++ docs/memslap.rst	2011-04-18 19:22:31 +0000
458
@@ -20,12 +20,9 @@
459
20
20
460
21
21
461
22
\ **memslap**\  is a load generation and benchmark tool for memcached(1)
22
\ **memslap**\  is a load generation and benchmark tool for memcached(1)
465
23
servers. It generates configurable workload such as threads, concurrencies, connections,
23
servers. It generates configurable workload such as threads, concurrencies, connections, run time, overwrite, miss rate, key size, value size, get/set proportion, expected throughput, and so on. 
463
24
run time, overwrite, miss rate, key size, value size, get/set proportion,
464
25
expected throughput, and so on. 
466
26
24
469
27
You can specify servers via the \ **--servers**\  option or via the
25
You can specify servers via the \ **--servers**\  option or via the environment variable \ ``MEMCACHED_SERVERS``\ .
468
28
environment variable \ ``MEMCACHED_SERVERS``\ .
470
29
26
471
30
27
472
31
--------
28
--------
Status:	Merged
Merge reported by:	Brian Aker
Merged at revision:	not available
Proposed branch:	lp:~kent/libmemcached/KBDocs1
Merge into:	lp:~tangent-org/libmemcached/trunk
Diff against target:	472 lines (+78/-77) 17 files modified docs/hashkit_create.rst (+2/-2) docs/libmemcached.rst (+18/-11) docs/memcached_callback.rst (+25/-27) docs/memcached_delete.rst (+2/-2) docs/memcached_dump.rst (+2/-2) docs/memcached_get.rst (+4/-4) docs/memcached_memory_allocators.rst (+1/-1) docs/memcached_result_st.rst (+4/-4) docs/memcached_sasl.rst (+1/-1) docs/memcached_set.rst (+5/-5) docs/memcached_version.rst (+1/-1) docs/memcapable.rst (+5/-5) docs/memcp.rst (+2/-3) docs/memdump.rst (+1/-1) docs/memerror.rst (+2/-2) docs/memflush.rst (+1/-1) docs/memslap.rst (+2/-5)
To merge this branch:	bzr merge lp:~kent/libmemcached/KBDocs1
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Libmemcached-developers		2011-04-16	Pending
Review via email: mp+58012@code.launchpad.net