presence: update documentation for new parameter, `force_delete` 601/head
authorEmmanuel Schmidbauer <emmanuel@getweave.com>
Fri, 6 May 2016 14:11:29 +0000 (10:11 -0400)
committerEmmanuel Schmidbauer <emmanuel@getweave.com>
Fri, 6 May 2016 14:11:29 +0000 (10:11 -0400)
modules/presence/doc/presence_admin.xml

index d4ce6bb..b6426ac 100644 (file)
@@ -278,6 +278,28 @@ modparam("presence", "notifier_processes", 2)
                </example>
        </section>
 
+       <section id="presence.p.force_delete">
+               <title><varname>force_delete</varname> (int)</title>
+               <para>
+               Enabling this parameter will delete expired presentity records without updating watchers.
+               </para>
+               <para>
+               Set this parameter to <quote>1<quote> to enable.
+               </para>
+               <para>
+               <emphasis>Default value is <quote>0</quote>.
+               </emphasis>
+               </para>
+               <example>
+               <title>Set <varname>force_delete</varname> parameter</title>
+               <programlisting format="linespecific">
+...
+modparam("presence", "force_delete", 1)
+...
+</programlisting>
+               </example>
+       </section>
+
        <section id="presence.p.to_tag_pref">
                <title><varname>to_tag_pref</varname> (str)</title>
                <para>