From: Brian Aker Date: Fri, 8 Apr 2011 23:07:18 +0000 (-0700) Subject: More documentation fixing. X-Git-Tag: 0.51~15^2~16 X-Git-Url: https://git.m6w6.name/?a=commitdiff_plain;h=d66b08d5fa6b3a8d5c7d622c17ece15a2a393f16;p=m6w6%2Flibmemcached More documentation fixing. --- diff --git a/docs/hashkit_create.rst b/docs/hashkit_create.rst index 44402b37..3d801b1f 100644 --- a/docs/hashkit_create.rst +++ b/docs/hashkit_create.rst @@ -22,7 +22,7 @@ SYNOPSIS .. code-block:: perl - #include + #include hashkit_st *hashkit_create(hashkit_st *hash); diff --git a/docs/index.rst b/docs/index.rst index eaa17f68..f4fda2df 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,7 +7,7 @@ Libmemcached ------------ .. toctree:: - :maxdepth: 2 + :maxdepth: 1 libmemcached libmemcached_examples @@ -43,7 +43,7 @@ Client Applications ------------------- .. toctree:: - :maxdepth: 2 + :maxdepth: 1 memcapable memcat @@ -61,7 +61,7 @@ Libhashkit ---------- .. toctree:: - :maxdepth: 2 + :maxdepth: 1 hashkit_create hashkit_functions diff --git a/docs/libmemcachedutil.rst b/docs/libmemcachedutil.rst index 046108da..4fc6c792 100644 --- a/docs/libmemcachedutil.rst +++ b/docs/libmemcachedutil.rst @@ -6,17 +6,17 @@ libmemcachedutil Utility library for libmemcached -======= +------- LIBRARY -======= +------- C Client Library containing utility functions for libmemcached (libmemcachedutil, -lmemcachedutil) -======== +-------- SYNOPSIS -======== +-------- .. code-block:: perl @@ -27,18 +27,18 @@ SYNOPSIS -=========== +----------- DESCRIPTION -=========== +----------- \ **libmemcachedutil**\ is a small and thread-safe client library that provides extra functionality built on top of \ **libmemcached**\ . -======= +------- THREADS -======= +------- Do not try to access an instance of \ ``memcached_st``\ from multiple threads @@ -47,18 +47,18 @@ you should either clone the \ ``memcached_st``\ , or use the memcached pool implementation. see memcached_pool_create(3). -==== +---- HOME -==== +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -======== +-------- SEE ALSO -======== +-------- :manpage:`libmemcached(3)` diff --git a/docs/man/hashkit_clone.3 b/docs/man/hashkit_clone.3 index 70ea4506..87f1e86a 100644 --- a/docs/man/hashkit_clone.3 +++ b/docs/man/hashkit_clone.3 @@ -39,7 +39,7 @@ C Library for hashing algorithms (libmemcached, \-lhashkit) .sp .nf .ft C -#include +#include hashkit_st *hashkit_create(hashkit_st *hash); diff --git a/docs/man/hashkit_create.3 b/docs/man/hashkit_create.3 index 336ab394..b1864ca1 100644 --- a/docs/man/hashkit_create.3 +++ b/docs/man/hashkit_create.3 @@ -39,7 +39,7 @@ C Library for hashing algorithms (libmemcached, \-lhashkit) .sp .nf .ft C -#include +#include hashkit_st *hashkit_create(hashkit_st *hash); diff --git a/docs/man/hashkit_free.3 b/docs/man/hashkit_free.3 index 1c7953da..8736d611 100644 --- a/docs/man/hashkit_free.3 +++ b/docs/man/hashkit_free.3 @@ -39,7 +39,7 @@ C Library for hashing algorithms (libmemcached, \-lhashkit) .sp .nf .ft C -#include +#include hashkit_st *hashkit_create(hashkit_st *hash); diff --git a/docs/man/hashkit_is_allocated.3 b/docs/man/hashkit_is_allocated.3 index a754feab..b9ec2c74 100644 --- a/docs/man/hashkit_is_allocated.3 +++ b/docs/man/hashkit_is_allocated.3 @@ -39,7 +39,7 @@ C Library for hashing algorithms (libmemcached, \-lhashkit) .sp .nf .ft C -#include +#include hashkit_st *hashkit_create(hashkit_st *hash); diff --git a/docs/man/libmemcachedutil.3 b/docs/man/libmemcachedutil.3 index 25936d85..f427034c 100644 --- a/docs/man/libmemcachedutil.3 +++ b/docs/man/libmemcachedutil.3 @@ -32,8 +32,10 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] . .sp Utility library for libmemcached +.SH LIBRARY .sp C Client Library containing utility functions for libmemcached (libmemcachedutil, \-lmemcachedutil) +.SH SYNOPSIS .sp .nf .ft C @@ -42,17 +44,21 @@ cc [ flag ... ] file ... \-lmemcachedutil #include .ft P .fi +.SH DESCRIPTION .sp \fBlibmemcachedutil\fP is a small and thread\-safe client library that provides extra functionality built on top of \fBlibmemcached\fP. +.SH THREADS .sp Do not try to access an instance of \fBmemcached_st\fP from multiple threads at the same time. If you want to access memcached from multiple threads you should either clone the \fBmemcached_st\fP, or use the memcached pool implementation. see memcached_pool_create(3). +.SH HOME .sp To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP +.SH SEE ALSO .sp \fIlibmemcached(3)\fP \fImemcached_pool_create(3)\fP \fImemcached_pool_destroy(3)\fP \fImemcached_pool_pop(3)\fP \fImemcached_pool_push(3)\fP diff --git a/docs/man/memaslap.1 b/docs/man/memaslap.1 index cc8c0cb7..3b5a2b8a 100644 --- a/docs/man/memaslap.1 +++ b/docs/man/memaslap.1 @@ -44,7 +44,7 @@ memaslap [options] \fBmemaslap\fP is a load generation and benchmark tool for memcached(1) 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. Furthermore, it also supports data +expected throughput, and so on. Furthermore, it also testss data verification, expire\-time verification, UDP, binary protocol, facebook test, replication test, multi\-get and reconnection, etc. .sp @@ -94,7 +94,7 @@ memaslap can handle network very efficiently. .sp Memslap has the similar implementation of multi\-threads to memcached. Memslap creates one or more self\-governed threads; -each thread is bound with one CPU core if the system supports setting CPU +each thread is bound with one CPU core if the system testss setting CPU core affinity. .sp In addition, each thread has a libevent to manage the events of the network; @@ -165,9 +165,9 @@ layer. .sp Because each thread is self\-governed, memaslap can assign different threads to handle different memcached servers. This is just one of -the ways in which memaslap supports multiple servers. The only +the ways in which memaslap testss multiple servers. The only limitation is that the number of servers cannot be greater than the number -of threads. The other way to support multiple servers is for replication +of threads. The other way to tests multiple servers is for replication test. Each concurrency has one socket connection to each memcached server. For the implementation, memaslap can set some objects to one memcached server, and get these objects from the other servers. @@ -176,10 +176,10 @@ By default, Memslap does single get. If the user specifies multi\-get option, memaslap will collect enough get commands and pack and send the commands together. .sp -Memslap supports both the ASCII protocol and binary protocol, +Memslap testss both the ASCII protocol and binary protocol, but it runs on the ASCII protocol by default. Memslap by default runs on the TCP protocol, but it also -supports UDP. Because UDP is unreliable, dropped packages and out\-of\-order +testss UDP. Because UDP is unreliable, dropped packages and out\-of\-order packages may occur. Memslap creates a memory buffer to handle these problems. Memslap tries to read all the response data of one command from the server and reorders the response data. If some packages @@ -246,8 +246,8 @@ rounded to 3 decimal places. The minimum value size is 1 bytes; the maximum value size is 1M bytes. The precision of proportion is 0.001. The proportion of distribution will be rounded to 3 decimal places. -Currently, memaslap only supports set and get commands. And it -supports 100% set and 100% get. For 100% get, it will preset some objects to +Currently, memaslap only testss set and get commands. And it +testss 100% set and 100% get. For 100% get, it will preset some objects to the server. .SS Multi\-thread and concurrency .sp @@ -257,7 +257,7 @@ number of them. The default number of threads is 1; the default number of concurrency is 16. The user can use “—threads” and “\-\-concurrency” to specify these variables. .sp -If the system supports setting CPU affinity and the number of threads +If the system testss setting CPU affinity and the number of threads specified by the user is greater than 1, memaslap will try to bind each thread to a different CPU core. So if you want to get the best performance memaslap, it is better to specify the number of @@ -316,7 +316,7 @@ throughput using “\-\-tps” option. Most of the time, the user does not need to specify the window size. The default window size is 10k. For Schooner Memcached, the user can specify different window sizes to get different cache miss rates based on the test -case. Memslap supports cache miss rate between 0% and 100%. +case. Memslap testss cache miss rate between 0% and 100%. If you use this utility to test the performance of Schooner Memcached, you can specify a proper window size to get the expected cache miss rate. The formula for calculating window size is as follows: @@ -364,11 +364,11 @@ The formula for calculating window size for cache miss rate 5%: cache_size / concurrency / (key_size + value_size) * 0.7 .SS Verification .sp -Memslap supports both data verification and expire\-time +Memslap testss both data verification and expire\-time verification. The user can use "\-\-verify=" or "\-v" to specify the proportion -of data verification. In theory, it supports 100% data verification. The +of data verification. In theory, it testss 100% data verification. The user can use "\-\-exp_verify=" or "\-e" to specify the proportion of -expire\-time verification. In theory, it supports 100% expire\-time +expire\-time verification. In theory, it testss 100% expire\-time verification. Specify the "\-\-verbose" options to get more detailed error information. .sp @@ -376,9 +376,9 @@ For example: \-\-exp_verify=0.01 –verify=0.1 , it means that 1% of the objects set with expire\-time, 10% of the objects gotten will be verified. If the objects are gotten, memaslap will verify the expire\-time and value. -.SS multi\-servers and multi\-clients +.SS multi\-servers and multi\-config .sp -Memslap supports multi\-servers based on self\-governed thread. +Memslap testss multi\-servers based on self\-governed thread. There is a limitation that the number of servers cannot be greater than the number of threads. Memslap assigns one thread to handle one server at least. The user can use the "\-\-servers=" or "\-s" option to specify @@ -427,10 +427,10 @@ For more information on the format of dumping statistic information, refer to .SS Multi\-get .sp The user can use "\-\-division=" or "\-d" to specify multi\-get keys count. -Memslap by default does single get with TCP. Memslap also supports data +Memslap by default does single get with TCP. Memslap also testss data verification and expire\-time verification for multi\-get. .sp -Memslap supports multi\-get with both TCP and UDP. Because of +Memslap testss multi\-get with both TCP and UDP. Because of the different implementation of the ASCII protocol and binary protocol, there are some differences between the two. For the ASCII protocol, memaslap sends one “multi\-get” to the server once. For the @@ -438,7 +438,7 @@ binary protocol, memaslap sends several single get commands together as “multi\-get” to the server. .SS UDP and TCP .sp -Memslap supports both UDP and TCP. For TCP, +Memslap testss both UDP and TCP. For TCP, memaslap does not reconnect the memcached server if socket connections are lost. If all the socket connections are lost or memcached server crashes, memaslap will exit. If the user specifies the “\-\-reconnect” @@ -449,10 +449,10 @@ limitations: .sp UDP cannot set data more than 1400 bytes. .sp -UDP is not supported by the binary protocol because the binary protocol of -memcached does not support that. +UDP is not testsed by the binary protocol because the binary protocol of +memcached does not tests that. .sp -UDP doesn’t support reconnection. +UDP doesn’t tests reconnection. .SS Facebook test .sp Set data with TCP and multi\-get with UDP. Specify the following options: @@ -492,8 +492,8 @@ server 0 and server 1 crash, memaslap will exit. .SS Supports thousands of TCP connections .sp Start memaslap with "\-\-conn_sock=" or "\-n" to enable this -feature. Make sure that your system can support opening thousands of files -and creating thousands of sockets. However, this feature does not support +feature. Make sure that your system can tests opening thousands of files +and creating thousands of sockets. However, this feature does not tests reconnection if sockets disconnect. .sp For example: @@ -507,7 +507,7 @@ connections, and the total number of TCP socket connections is 128 * 128 = .SS Supports binary protocol .sp Start memaslap with "\-\-binary" or "\-B" options to enable this -feature. It supports all the above features except UDP, because the latest +feature. It testss all the above features except UDP, because the latest memcached 1.3.3 does not implement binary UDP protocol. .sp For example: @@ -515,7 +515,7 @@ For example: \-\-binary .sp Since memcached 1.3.3 doesn\(aqt implement binary UDP protocol, -memaslap does not support UDP. In addition, memcached 1.3.3 does not support +memaslap does not tests UDP. In addition, memcached 1.3.3 does not tests multi\-get. If you specify "\-\-division=50" option, it just sends 50 get commands together as “mulit\-get” to the server. .SH CONFIGURATION FILE @@ -583,7 +583,7 @@ value #cmd #cmd_type cmd_proportion # -#currently memaslap only supports get and set command. +#currently memaslap only testss get and set command. # #cmd_type #set 0 @@ -1150,11 +1150,11 @@ Default never overwrite object. .TP .B \-R, \-\-reconnect . -Reconnect support, when connection is closed it will be reconnected. +Reconnect tests, when connection is closed it will be reconnected. .TP .B \-U, \-\-udp . -UDP support, default memaslap uses TCP, TCP port and UDP port of +UDP tests, default memaslap uses TCP, TCP port and UDP port of server must be same. .TP .B \-a, \-\-facebook diff --git a/docs/man/memcached_result_cas.3 b/docs/man/memcached_result_cas.3 index 1976022e..a9bdbe6e 100644 --- a/docs/man/memcached_result_cas.3 +++ b/docs/man/memcached_result_cas.3 @@ -35,7 +35,7 @@ Work with memcached_result_st .SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS +.SH SYNOPSIS .sp .nf .ft C @@ -68,7 +68,7 @@ void memcached_result_set_flags (memcached_result_st *ptr, uint32_t flags) void memcached_result_set_expiration (memcached_result_st *ptr, time_t) .ft P .fi -.SS DESCRIPTION +.SH DESCRIPTION .sp libmemcached(3) can optionally return a memcached_result_st which acts as a result object. The result objects have added benefits over the character @@ -128,10 +128,7 @@ do this will result in leaked memory. .sp To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP -.SH AUTHOR -.sp -Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR diff --git a/docs/man/memcached_result_create.3 b/docs/man/memcached_result_create.3 index 5532aa1b..1298b2e3 100644 --- a/docs/man/memcached_result_create.3 +++ b/docs/man/memcached_result_create.3 @@ -35,7 +35,7 @@ Work with memcached_result_st .SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS +.SH SYNOPSIS .sp .nf .ft C @@ -68,7 +68,7 @@ void memcached_result_set_flags (memcached_result_st *ptr, uint32_t flags) void memcached_result_set_expiration (memcached_result_st *ptr, time_t) .ft P .fi -.SS DESCRIPTION +.SH DESCRIPTION .sp libmemcached(3) can optionally return a memcached_result_st which acts as a result object. The result objects have added benefits over the character @@ -128,10 +128,7 @@ do this will result in leaked memory. .sp To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP -.SH AUTHOR -.sp -Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR diff --git a/docs/man/memcached_result_flags.3 b/docs/man/memcached_result_flags.3 index 122dd555..ab43a42d 100644 --- a/docs/man/memcached_result_flags.3 +++ b/docs/man/memcached_result_flags.3 @@ -35,7 +35,7 @@ Work with memcached_result_st .SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS +.SH SYNOPSIS .sp .nf .ft C @@ -68,7 +68,7 @@ void memcached_result_set_flags (memcached_result_st *ptr, uint32_t flags) void memcached_result_set_expiration (memcached_result_st *ptr, time_t) .ft P .fi -.SS DESCRIPTION +.SH DESCRIPTION .sp libmemcached(3) can optionally return a memcached_result_st which acts as a result object. The result objects have added benefits over the character @@ -128,10 +128,7 @@ do this will result in leaked memory. .sp To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP -.SH AUTHOR -.sp -Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR diff --git a/docs/man/memcached_result_free.3 b/docs/man/memcached_result_free.3 index 9217fdd9..dd04da78 100644 --- a/docs/man/memcached_result_free.3 +++ b/docs/man/memcached_result_free.3 @@ -35,7 +35,7 @@ Work with memcached_result_st .SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS +.SH SYNOPSIS .sp .nf .ft C @@ -68,7 +68,7 @@ void memcached_result_set_flags (memcached_result_st *ptr, uint32_t flags) void memcached_result_set_expiration (memcached_result_st *ptr, time_t) .ft P .fi -.SS DESCRIPTION +.SH DESCRIPTION .sp libmemcached(3) can optionally return a memcached_result_st which acts as a result object. The result objects have added benefits over the character @@ -128,10 +128,7 @@ do this will result in leaked memory. .sp To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP -.SH AUTHOR -.sp -Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR diff --git a/docs/man/memcached_result_key_length.3 b/docs/man/memcached_result_key_length.3 index 50fa7be4..b0049557 100644 --- a/docs/man/memcached_result_key_length.3 +++ b/docs/man/memcached_result_key_length.3 @@ -35,7 +35,7 @@ Work with memcached_result_st .SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS +.SH SYNOPSIS .sp .nf .ft C @@ -68,7 +68,7 @@ void memcached_result_set_flags (memcached_result_st *ptr, uint32_t flags) void memcached_result_set_expiration (memcached_result_st *ptr, time_t) .ft P .fi -.SS DESCRIPTION +.SH DESCRIPTION .sp libmemcached(3) can optionally return a memcached_result_st which acts as a result object. The result objects have added benefits over the character @@ -128,10 +128,7 @@ do this will result in leaked memory. .sp To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP -.SH AUTHOR -.sp -Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR diff --git a/docs/man/memcached_result_key_value.3 b/docs/man/memcached_result_key_value.3 index 8b2d9bd0..feaccfb2 100644 --- a/docs/man/memcached_result_key_value.3 +++ b/docs/man/memcached_result_key_value.3 @@ -35,7 +35,7 @@ Work with memcached_result_st .SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS +.SH SYNOPSIS .sp .nf .ft C @@ -68,7 +68,7 @@ void memcached_result_set_flags (memcached_result_st *ptr, uint32_t flags) void memcached_result_set_expiration (memcached_result_st *ptr, time_t) .ft P .fi -.SS DESCRIPTION +.SH DESCRIPTION .sp libmemcached(3) can optionally return a memcached_result_st which acts as a result object. The result objects have added benefits over the character @@ -128,10 +128,7 @@ do this will result in leaked memory. .sp To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP -.SH AUTHOR -.sp -Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR diff --git a/docs/man/memcached_result_length.3 b/docs/man/memcached_result_length.3 index 2e6faa3f..0d6a4ced 100644 --- a/docs/man/memcached_result_length.3 +++ b/docs/man/memcached_result_length.3 @@ -35,7 +35,7 @@ Work with memcached_result_st .SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS +.SH SYNOPSIS .sp .nf .ft C @@ -68,7 +68,7 @@ void memcached_result_set_flags (memcached_result_st *ptr, uint32_t flags) void memcached_result_set_expiration (memcached_result_st *ptr, time_t) .ft P .fi -.SS DESCRIPTION +.SH DESCRIPTION .sp libmemcached(3) can optionally return a memcached_result_st which acts as a result object. The result objects have added benefits over the character @@ -128,10 +128,7 @@ do this will result in leaked memory. .sp To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP -.SH AUTHOR -.sp -Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR diff --git a/docs/man/memcached_result_st.3 b/docs/man/memcached_result_st.3 index 8f17eca0..5a00cb00 100644 --- a/docs/man/memcached_result_st.3 +++ b/docs/man/memcached_result_st.3 @@ -35,7 +35,7 @@ Work with memcached_result_st .SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS +.SH SYNOPSIS .sp .nf .ft C @@ -68,7 +68,7 @@ void memcached_result_set_flags (memcached_result_st *ptr, uint32_t flags) void memcached_result_set_expiration (memcached_result_st *ptr, time_t) .ft P .fi -.SS DESCRIPTION +.SH DESCRIPTION .sp libmemcached(3) can optionally return a memcached_result_st which acts as a result object. The result objects have added benefits over the character @@ -128,10 +128,7 @@ do this will result in leaked memory. .sp To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP -.SH AUTHOR -.sp -Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR diff --git a/docs/man/memcached_result_value.3 b/docs/man/memcached_result_value.3 index b7608c88..3194d29f 100644 --- a/docs/man/memcached_result_value.3 +++ b/docs/man/memcached_result_value.3 @@ -35,7 +35,7 @@ Work with memcached_result_st .SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS +.SH SYNOPSIS .sp .nf .ft C @@ -68,7 +68,7 @@ void memcached_result_set_flags (memcached_result_st *ptr, uint32_t flags) void memcached_result_set_expiration (memcached_result_st *ptr, time_t) .ft P .fi -.SS DESCRIPTION +.SH DESCRIPTION .sp libmemcached(3) can optionally return a memcached_result_st which acts as a result object. The result objects have added benefits over the character @@ -128,10 +128,7 @@ do this will result in leaked memory. .sp To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP -.SH AUTHOR -.sp -Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR diff --git a/docs/man/memcapable.1 b/docs/man/memcapable.1 index 25910ff1..2ec8d996 100644 --- a/docs/man/memcapable.1 +++ b/docs/man/memcapable.1 @@ -31,57 +31,56 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" Man page generated from reStructeredText. . .sp -Check memcached server capabilities +Check the server for compatibility and capabilities .SH SYNOPSIS -.sp -.nf -.ft C -memcat [\-h hostname] [\-p port] [\-c] [\-v] [\-t n] -.ft P -.fi -.SH DESCRIPTION -.sp -\fBmemcapable\fP connects to the specified memcached server and tries to -determine its capabilities by running the various commands and verifying -the response. -.SS OPTIONS -.sp -The following options are testsed: .INDENT 0.0 .TP -.BI \-h \ hostname -. +.B \-h hostname +.sp Specify the hostname to connect to. The default is \fIlocalhost\fP +.UNINDENT +.INDENT 0.0 .TP -.BI \-p \ port -. +.B \-p port +.sp Specify the port number to connect to. The default is \fI11211\fP +.UNINDENT +.INDENT 0.0 .TP .B \-c . Generate a coredump when it detects an error from the server. +.UNINDENT +.INDENT 0.0 .TP .B \-v . Print out the comparison when it detects an error from the server. +.UNINDENT +.INDENT 0.0 .TP -.BI \-t \ n -. +.B \-t n +.sp Set the timeout from an IO operation to/from the server to \fIn\fP seconds. .UNINDENT +.SH DESCRIPTION +.sp +\fBmemcapable\fP connects to the specified memcached server and tries to +determine its capabilities by running the various commands and verifying +the response. .SH LIMITATIONS .sp The current version of memcapable will only verify the binary protocol. -.SS HOME +.SH HOME .sp To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP -.SS AUTHOR +.SH AUTHOR .sp Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> .SH SEE ALSO .sp -memcached(1) libmemcached(3) +\fImemcached(1)\fP \fIlibmemcached(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT diff --git a/docs/man/memcat.1 b/docs/man/memcat.1 index 95d52d3b..3185c232 100644 --- a/docs/man/memcat.1 +++ b/docs/man/memcat.1 @@ -50,11 +50,11 @@ You can specify servers via the \fB\-\-servers\fP option or via the environment variable \fBMEMCACHED_SERVERS\fP. .sp For a full list of operations run the tool with the \fB\-\-help\fP option. -.SS HOME +.SH HOME .sp To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP -.SS AUTHOR +.SH AUTHOR .sp Brian Aker, <\fI\%brian@tangent.org\fP> .sp diff --git a/docs/man/memcp.1 b/docs/man/memcp.1 index be3975b8..0deddac8 100644 --- a/docs/man/memcp.1 +++ b/docs/man/memcp.1 @@ -53,11 +53,11 @@ these, the final value in the command line list is the name of a server(s). .sp For a full list of operations run the tool with the \fB\-\-help\fP option. -.SS HOME +.SH HOME .sp To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP -.SS AUTHOR +.SH AUTHOR .sp Brian Aker, <\fI\%brian@tangent.org\fP> .sp diff --git a/docs/man/memdump.1 b/docs/man/memdump.1 index 683053e2..c00846c9 100644 --- a/docs/man/memdump.1 +++ b/docs/man/memdump.1 @@ -33,12 +33,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .sp Dump a list of keys from a server. .SH SYNOPSIS -.sp -.nf -.ft C -memdump [options] -.ft P -.fi .SH DESCRIPTION .sp \fBmemdump\fP currently dumps a list of "keys" from all servers that @@ -46,16 +40,13 @@ it is told to fetch from. Because memcached does not guarentee to provide all keys it is not possible to get a complete "dump". .sp For a full list of operations run the tool with the \fB\-\-help\fP option. -.SS HOME +.SH HOME .sp To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP -.SS AUTHOR -.sp -Brian Aker, <\fI\%brian@tangent.org\fP> .SH SEE ALSO .sp -memcached(1) libmemcached(3) +\fImemcached(1)\fP \fIlibmemcached(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT diff --git a/docs/man/memflush.1 b/docs/man/memflush.1 index d506a6f5..80e3f1bf 100644 --- a/docs/man/memflush.1 +++ b/docs/man/memflush.1 @@ -32,14 +32,12 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] . .sp Reset a server or list of servers -.SH SYNOPSIS .sp .nf .ft C memflush [options] .ft P .fi -.SH DESCRIPTION .sp \fBmemflush\fP resets the contents of memcached(1) servers. This means all data in these servers will be deleted. @@ -48,16 +46,15 @@ You can specify servers via the \fB\-\-servers\fP option or via the environment variable \fBMEMCACHED_SERVERS\fP. .sp For a full list of operations run the tool with the \fB\-\-help\fP option. -.SS HOME +.SH HOME .sp To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP -.SS AUTHOR +.SH AUTHOR .sp Brian Aker, <\fI\%brian@tangent.org\fP> .sp Mark Atwood <\fI\%mark@fallenpegasus.com\fP> -.SH SEE ALSO .sp memcached(1) libmemcached(3) .SH AUTHOR diff --git a/docs/man/memrm.1 b/docs/man/memrm.1 index 05292141..4d91ebb7 100644 --- a/docs/man/memrm.1 +++ b/docs/man/memrm.1 @@ -47,11 +47,11 @@ You can specify servers via the \fB\-\-servers\fP option or via the environment variable \fBMEMCACHED_SERVERS\fP. .sp For a full list of operations run the tool with the \fB\-\-help\fP option. -.SS HOME +.SH HOME .sp To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP -.SS AUTHOR +.SH AUTHOR .sp Brian Aker, <\fI\%brian@tangent.org\fP> .sp diff --git a/docs/memaslap.rst b/docs/memaslap.rst index 03eb6d98..76579d56 100644 --- a/docs/memaslap.rst +++ b/docs/memaslap.rst @@ -26,7 +26,7 @@ DESCRIPTION \ **memaslap**\ is a load generation and benchmark tool for memcached(1) 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. Furthermore, it also supports data +expected throughput, and so on. Furthermore, it also testss data verification, expire-time verification, UDP, binary protocol, facebook test, replication test, multi-get and reconnection, etc. @@ -118,7 +118,7 @@ _________________________________________________________ Memslap has the similar implementation of multi-threads to memcached. Memslap creates one or more self-governed threads; -each thread is bound with one CPU core if the system supports setting CPU +each thread is bound with one CPU core if the system testss setting CPU core affinity. In addition, each thread has a libevent to manage the events of the network; @@ -201,9 +201,9 @@ ________________________________________________________________________________ Because each thread is self-governed, memaslap can assign different threads to handle different memcached servers. This is just one of -the ways in which memaslap supports multiple servers. The only +the ways in which memaslap testss multiple servers. The only limitation is that the number of servers cannot be greater than the number -of threads. The other way to support multiple servers is for replication +of threads. The other way to tests multiple servers is for replication test. Each concurrency has one socket connection to each memcached server. For the implementation, memaslap can set some objects to one memcached server, and get these objects from the other servers. @@ -212,10 +212,10 @@ By default, Memslap does single get. If the user specifies multi-get option, memaslap will collect enough get commands and pack and send the commands together. -Memslap supports both the ASCII protocol and binary protocol, +Memslap testss both the ASCII protocol and binary protocol, but it runs on the ASCII protocol by default. Memslap by default runs on the TCP protocol, but it also -supports UDP. Because UDP is unreliable, dropped packages and out-of-order +testss UDP. Because UDP is unreliable, dropped packages and out-of-order packages may occur. Memslap creates a memory buffer to handle these problems. Memslap tries to read all the response data of one command from the server and reorders the response data. If some packages @@ -306,8 +306,8 @@ rounded to 3 decimal places. The minimum value size is 1 bytes; the maximum value size is 1M bytes. The precision of proportion is 0.001. The proportion of distribution will be rounded to 3 decimal places. -Currently, memaslap only supports set and get commands. And it -supports 100% set and 100% get. For 100% get, it will preset some objects to +Currently, memaslap only testss set and get commands. And it +testss 100% set and 100% get. For 100% get, it will preset some objects to the server. @@ -321,7 +321,7 @@ number of them. The default number of threads is 1; the default number of concurrency is 16. The user can use “—threads” and “--concurrency” to specify these variables. -If the system supports setting CPU affinity and the number of threads +If the system testss setting CPU affinity and the number of threads specified by the user is greater than 1, memaslap will try to bind each thread to a different CPU core. So if you want to get the best performance memaslap, it is better to specify the number of @@ -378,7 +378,7 @@ ___________ Most of the time, the user does not need to specify the window size. The default window size is 10k. For Schooner Memcached, the user can specify different window sizes to get different cache miss rates based on the test -case. Memslap supports cache miss rate between 0% and 100%. +case. Memslap testss cache miss rate between 0% and 100%. If you use this utility to test the performance of Schooner Memcached, you can specify a proper window size to get the expected cache miss rate. The formula for calculating window size is as follows: @@ -424,11 +424,11 @@ Verification ____________ -Memslap supports both data verification and expire-time +Memslap testss both data verification and expire-time verification. The user can use "--verify=" or "-v" to specify the proportion -of data verification. In theory, it supports 100% data verification. The +of data verification. In theory, it testss 100% data verification. The user can use "--exp_verify=" or "-e" to specify the proportion of -expire-time verification. In theory, it supports 100% expire-time +expire-time verification. In theory, it testss 100% expire-time verification. Specify the "--verbose" options to get more detailed error information. @@ -438,11 +438,11 @@ objects are gotten, memaslap will verify the expire-time and value. -multi-servers and multi-clients +multi-servers and multi-config _______________________________ -Memslap supports multi-servers based on self-governed thread. +Memslap testss multi-servers based on self-governed thread. There is a limitation that the number of servers cannot be greater than the number of threads. Memslap assigns one thread to handle one server at least. The user can use the "--servers=" or "-s" option to specify @@ -503,10 +503,10 @@ _________ The user can use "--division=" or "-d" to specify multi-get keys count. -Memslap by default does single get with TCP. Memslap also supports data +Memslap by default does single get with TCP. Memslap also testss data verification and expire-time verification for multi-get. -Memslap supports multi-get with both TCP and UDP. Because of +Memslap testss multi-get with both TCP and UDP. Because of the different implementation of the ASCII protocol and binary protocol, there are some differences between the two. For the ASCII protocol, memaslap sends one “multi-get” to the server once. For the @@ -518,7 +518,7 @@ UDP and TCP ___________ -Memslap supports both UDP and TCP. For TCP, +Memslap testss both UDP and TCP. For TCP, memaslap does not reconnect the memcached server if socket connections are lost. If all the socket connections are lost or memcached server crashes, memaslap will exit. If the user specifies the “--reconnect” @@ -529,10 +529,10 @@ limitations: UDP cannot set data more than 1400 bytes. -UDP is not supported by the binary protocol because the binary protocol of -memcached does not support that. +UDP is not testsed by the binary protocol because the binary protocol of +memcached does not tests that. -UDP doesn’t support reconnection. +UDP doesn’t tests reconnection. Facebook test @@ -584,8 +584,8 @@ _____________________________________ Start memaslap with "--conn_sock=" or "-n" to enable this -feature. Make sure that your system can support opening thousands of files -and creating thousands of sockets. However, this feature does not support +feature. Make sure that your system can tests opening thousands of files +and creating thousands of sockets. However, this feature does not tests reconnection if sockets disconnect. For example: @@ -603,7 +603,7 @@ ________________________ Start memaslap with "--binary" or "-B" options to enable this -feature. It supports all the above features except UDP, because the latest +feature. It testss all the above features except UDP, because the latest memcached 1.3.3 does not implement binary UDP protocol. For example: @@ -611,7 +611,7 @@ For example: --binary Since memcached 1.3.3 doesn't implement binary UDP protocol, -memaslap does not support UDP. In addition, memcached 1.3.3 does not support +memaslap does not tests UDP. In addition, memcached 1.3.3 does not tests multi-get. If you specify "--division=50" option, it just sends 50 get commands together as “mulit-get” to the server. @@ -686,7 +686,7 @@ Below is a sample configuration file: #cmd #cmd_type cmd_proportion # - #currently memaslap only supports get and set command. + #currently memaslap only testss get and set command. # #cmd_type #set 0 @@ -1182,10 +1182,10 @@ OPTIONS Default never overwrite object. -R, --reconnect - Reconnect support, when connection is closed it will be reconnected. + Reconnect tests, when connection is closed it will be reconnected. -U, --udp - UDP support, default memaslap uses TCP, TCP port and UDP port of + UDP tests, default memaslap uses TCP, TCP port and UDP port of server must be same. -a, --facebook diff --git a/docs/memcached_result_st.rst b/docs/memcached_result_st.rst index 058b743f..818b4991 100644 --- a/docs/memcached_result_st.rst +++ b/docs/memcached_result_st.rst @@ -6,9 +6,9 @@ Working with result sets Work with memcached_result_st -******* +------- LIBRARY -******* +------- C Client Library for memcached (libmemcached, -lmemcached) @@ -108,9 +108,9 @@ stack based allocation. The most common issues related to ABI safety involve heap allocated structures. -****** +------ RETURN -****** +------ Varies, see particular functions. All structures must have @@ -118,23 +118,15 @@ memcached_result_free() called on them for cleanup purposes. Failure to do this will result in leaked memory. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** -AUTHOR -****** - - -Brian Aker, - - -------- SEE ALSO -------- diff --git a/docs/memcapable.rst b/docs/memcapable.rst index 619adc6a..97dbc066 100644 --- a/docs/memcapable.rst +++ b/docs/memcapable.rst @@ -1,70 +1,50 @@ -============================================================ -Checking you Memcached server capibilities and compatibility -============================================================ +======================================================================= +memcapable - Checking a Memcached server capibilities and compatibility +======================================================================= -Check memcached server capabilities +Check the server for compatibility and capabilities -------- SYNOPSIS -------- +.. program:: memcat - -.. code-block:: perl - - memcat [-h hostname] [-p port] [-c] [-v] [-t n] - - - ------------ -DESCRIPTION ------------ - - -\ **memcapable**\ connects to the specified memcached server and tries to -determine its capabilities by running the various commands and verifying -the response. - - -******* -OPTIONS -******* - - -The following options are testsed: - - --h hostname +.. option:: -h hostname Specify the hostname to connect to. The default is \ *localhost*\ - - --p port +.. option:: -p port Specify the port number to connect to. The default is \ *11211*\ --c +.. option:: -c Generate a coredump when it detects an error from the server. --v +.. option:: -v - Print out the comparison when it detects an error from the server. + Print out the comparison when it detects an error from the server. --t n +.. option:: -t n Set the timeout from an IO operation to/from the server to \ *n*\ seconds. +----------- +DESCRIPTION +----------- +\ **memcapable**\ connects to the specified memcached server and tries to +determine its capabilities by running the various commands and verifying +the response. ----------- @@ -75,18 +55,18 @@ LIMITATIONS The current version of memcapable will only verify the binary protocol. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** +------ AUTHOR -****** +------ Trond Norbye, @@ -96,6 +76,5 @@ Trond Norbye, SEE ALSO -------- - -memcached(1) libmemcached(3) +:manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/docs/memcat.rst b/docs/memcat.rst index 96d3422e..d2535945 100644 --- a/docs/memcat.rst +++ b/docs/memcat.rst @@ -1,6 +1,6 @@ -====== -memcat -====== +================================= +memcat - "cat" data from a server +================================= Copy a set of keys to stdout @@ -34,18 +34,18 @@ environment variable \ ``MEMCACHED_SERVERS``\ . For a full list of operations run the tool with the \ **--help**\ option. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** +------ AUTHOR -****** +------ Brian Aker, diff --git a/docs/memcp.rst b/docs/memcp.rst index 80305589..16cedf7a 100644 --- a/docs/memcp.rst +++ b/docs/memcp.rst @@ -1,6 +1,6 @@ -===== -memcp -===== +============================= +memcp - Copy data to a server +============================= Copies files to a collection of memcached servers @@ -37,18 +37,18 @@ server(s). For a full list of operations run the tool with the \ **--help**\ option. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** +------ AUTHOR -****** +------ Brian Aker, diff --git a/docs/memdump.rst b/docs/memdump.rst index be34873c..5b7fb960 100644 --- a/docs/memdump.rst +++ b/docs/memdump.rst @@ -10,13 +10,7 @@ Dump a list of keys from a server. SYNOPSIS -------- - - -.. code-block:: perl - - memdump [options] - - +.. program:: memdump [options] ----------- DESCRIPTION @@ -30,27 +24,17 @@ provide all keys it is not possible to get a complete "dump". For a full list of operations run the tool with the \ **--help**\ option. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** -AUTHOR -****** - - -Brian Aker, - - -------- SEE ALSO -------- - -memcached(1) libmemcached(3) - +:manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/docs/memerror.rst b/docs/memerror.rst index 7e6ca011..7e675109 100644 --- a/docs/memerror.rst +++ b/docs/memerror.rst @@ -1,6 +1,6 @@ -======== -memerror -======== +============================================== +memerror - translate an error code to a string +============================================== Translate a memcached error code to a string diff --git a/docs/memflush.rst b/docs/memflush.rst index 8f8b0312..635c7f76 100644 --- a/docs/memflush.rst +++ b/docs/memflush.rst @@ -1,6 +1,6 @@ -======== -memflush -======== +--------------------------------------- +memflush - flush all data from a server +--------------------------------------- Reset a server or list of servers diff --git a/docs/memrm.rst b/docs/memrm.rst index ac358c29..df40ed3c 100644 --- a/docs/memrm.rst +++ b/docs/memrm.rst @@ -1,6 +1,6 @@ -===== -memrm -===== +================================= +memrm - Remove data from a server +================================= memrm - Remove a key(s) from a collection of memcached servers @@ -31,18 +31,18 @@ environment variable \ ``MEMCACHED_SERVERS``\ . For a full list of operations run the tool with the \ **--help**\ option. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** +------ AUTHOR -****** +------ Brian Aker,