X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_analyze.rst;h=88f3ad9d6b74076d8666606bc5db1c7cce375ce0;hb=cfe08f8ecd0fd090430c417ac99999644041ba17;hp=9a0c49d232f007a9ca21433e37622a219be5f9b1;hpb=7c12c89412585d136f8572f0ff3aee26427769de;p=m6w6%2Flibmemcached diff --git a/docs/memcached_analyze.rst b/docs/memcached_analyze.rst index 9a0c49d2..88f3ad9d 100644 --- a/docs/memcached_analyze.rst +++ b/docs/memcached_analyze.rst @@ -14,8 +14,10 @@ SYNOPSIS #include + +.. c:type:: memcached_analysis_st -.. c:function:: memcached_analysis_st * memcached_analyze (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error); +.. c:function:: memcached_analysis_st * memcached_analyze (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error) Compile and link with -lmemcached @@ -28,11 +30,11 @@ DESCRIPTION collection of servers) for their current state. Queries to find state return a :c:type:`memcached_analysis_st` structure. You are responsible for freeing this structure. -:c:func:`memcached_analyze()` analyzes useful information based on the +:c:func:`memcached_analyze` analyzes useful information based on the provided servers and sets the result to the :c:type:`memcached_analysis_st` structure. The return value must be freed by the calling application. -A command line tool, :c:func:`memstat()` with the option :option:`--analyze`, +A command line tool, :program:`memstat` with the option :option:`memstat --analyze`, is provided so that you do not have to write an application to use this method.