async: small extension of the description for the ms_timer parameter
authorHenning Westerholt <hw@skalatan.de>
Sun, 28 Jul 2019 17:52:44 +0000 (19:52 +0200)
committerHenning Westerholt <hw@skalatan.de>
Sun, 28 Jul 2019 17:52:44 +0000 (19:52 +0200)
src/modules/async/doc/async_admin.xml

index 0ad1d3b..5e9277a 100644 (file)
@@ -92,9 +92,10 @@ modparam("async", "workers", 2)
                <title><varname>ms_timer</varname> (int)</title>
                <para>
                        Enables millisecond timer for async_ms_sleep() and async_ms_route() functions.
-                       The integer value is the timer resolution in milliseconds.
-                       ms_timer = 1 enables 1 millisecond timer but generates higher load on the system.
-                       ms_timer = 20 enables 20 ms timer.
+                       The integer value is the timer resolution in milliseconds. A smaller timer
+                       resultion will generate a higher load on the system. If you set ms_timer
+                       to 1 you will get a timer with 1 millisecond resultion, a setting of 20
+                       provides a resultion of 20ms.
                </para>
                <para>
                <emphasis>
@@ -105,7 +106,7 @@ modparam("async", "workers", 2)
                <title>Set <varname>ms_timer</varname> parameter</title>
                <programlisting format="linespecific">
 ...
-modparam("async", "ms_timer", 1)
+modparam("async", "ms_timer", 10)
 ...
 </programlisting>
                </example>