X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Flibmemcached%2Fmemcached_analyze.rst;h=9caeafa4090e722d9b5d7a266be9bb3454aced03;hb=bdf3398dac90a54d82aed65099290d51e92d4601;hp=90189d96d2609a750f647cd53ea9cc4cff80e248;hpb=28c4d79e109e11d7d2a9f3189de57da28302ec68;p=awesomized%2Flibmemcached diff --git a/docs/source/libmemcached/memcached_analyze.rst b/docs/source/libmemcached/memcached_analyze.rst index 90189d96..9caeafa4 100644 --- a/docs/source/libmemcached/memcached_analyze.rst +++ b/docs/source/libmemcached/memcached_analyze.rst @@ -27,18 +27,18 @@ DESCRIPTION collection of servers) for their current state. Queries to find state return a :type:`memcached_analysis_st` structure. You are responsible for freeing this structure. -:func:`memcached_analyze` analyzes useful information based on the +:func:`memcached_analyze` analyzes useful information based on the provided servers and sets the result to the :type:`memcached_analysis_st` structure. The return value must be freed by the calling application. -A command line tool, :program:`memstat` with the option :option:`memstat --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. ------ RETURN ------ -A pointer to the allocated :type:`memcached_analysis_st` structure on +A pointer to the allocated :type:`memcached_analysis_st` structure on success and a NULL pointer on failure. You may inspect the error detail by checking the :type:`memcached_return_t` value.