X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_analyze.rst;h=9a0c49d232f007a9ca21433e37622a219be5f9b1;hb=36dd2e646b1290791dfcd2e8d94ab02591f32904;hp=56fbf1f3edf378c38cb946cba24d107992ff7500;hpb=da3714e6dc31ab2f9d115707ab79a838420c7b5a;p=m6w6%2Flibmemcached diff --git a/docs/memcached_analyze.rst b/docs/memcached_analyze.rst index 56fbf1f3..9a0c49d2 100644 --- a/docs/memcached_analyze.rst +++ b/docs/memcached_analyze.rst @@ -24,16 +24,16 @@ DESCRIPTION ----------- -libmemcached(3) has the ability to query a memcached server (or collection -of servers) for their current state. Queries to find state return a -\ ``memcached_analysis_st``\ structure. You are responsible for freeing this structure. +:program:`libmemcached` has the ability to query a memcached server (or +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. -memcached_analyze() analyzes useful information based on the provided servers -and sets the result to the \ ``memcached_analysis_st``\ structure. The return value -must be freed by the calling application. +: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, memstat(1) with the option --analyze, is provided so that -you do not have to write an application to use this method. +A command line tool, :c:func:`memstat()` with the option :option:`--analyze`, +is provided so that you do not have to write an application to use this method. ------ @@ -41,11 +41,11 @@ RETURN ------ -A pointer to the allocated \ ``memcached_analysis_st``\ structure on success and -a NULL pointer on failure. You may inspect the error detail by checking the -\ ``memcached_return_t``\ value. +A pointer to the allocated :c:type:`memcached_analysis_st` structure on +success and a NULL pointer on failure. You may inspect the error detail by +checking the :c:type:`memcached_return_t` value. -Any method returning a \ ``memcached_analysis_st``\ expects you to free the +Any method returning a :c:type:`memcached_analysis_st` expects you to free the memory allocated for it.