Module: sip-router Branch: master Commit: 7945158083b5f7b34bd3f9b2b754c459293ba428 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=79451580...

Author: Peter Dunkley peter.dunkley@crocodile-rcs.com Committer: Peter Dunkley peter.dunkley@crocodile-rcs.com Date: Mon Apr 23 19:28:39 2012 +0100

modules_k/presence: Updated documentation for "cleanup" MI command

---

modules_k/presence/README | 7 ++++--- modules_k/presence/doc/presence_admin.xml | 12 +++++------- 2 files changed, 9 insertions(+), 10 deletions(-)

diff --git a/modules_k/presence/README b/modules_k/presence/README index 17c3365..761c1ce 100644 --- a/modules_k/presence/README +++ b/modules_k/presence/README @@ -728,12 +728,13 @@ pres_update_presentity("$xcapuri(u=>xuid)", "$xcapuri(u=>uri_adoc)", "$xcapuri(u

5.2. cleanup

- Manually triggers the cleanup functions for watchers and presentity - tables. Useful if you have set clean_period to zero or less. + Manually triggers the cleanup functions for the active_watchers, + presentity, and watchers tables. Useful if you have set clean_period + and/or db_update_period to zero or less.

Name: cleanup

- Parameters:none.emphasis> + Parameters: none

MI FIFO Command Format: :cleanup:fifo_reply diff --git a/modules_k/presence/doc/presence_admin.xml b/modules_k/presence/doc/presence_admin.xml index c0982a3..cb9f90d 100644 --- a/modules_k/presence/doc/presence_admin.xml +++ b/modules_k/presence/doc/presence_admin.xml @@ -878,13 +878,14 @@ pres_update_presentity("$xcapuri(u=>xuid)", "$xcapuri(u=>uri_adoc)", "$xcapuri(u <function moreinfo="none">cleanup</function> </title> <para> - Manually triggers the cleanup functions for watchers and presentity tables. Useful if you - have set <varname>clean_period</varname> to zero or less. + Manually triggers the cleanup functions for the active_watchers, presentity, + and watchers tables. Useful if you have set <varname>clean_period</varname> + and/or <varname>db_update_period</varname> to zero or less. </para> <para> Name: <emphasis>cleanup</emphasis> </para> - <para>Parameters:<emphasis>none.</emphasis>emphasis></para> + <para>Parameters: <emphasis>none</emphasis></para>

<para> MI FIFO Command Format: @@ -894,10 +895,7 @@ pres_update_presentity("$xcapuri(u=>xuid)", "$xcapuri(u=>uri_adoc)", "$xcapuri(u _empty_line_ </programlisting> </section> - - </section> - - +</section>

<section> <title>Installation</title>