[sr-dev] git:master: cfgutils: updated docs to specify correct time unit for usleep

Module: sip-router Branch: master Commit: 8e937d260d0ff41f50be56e0a46ede44554f3f99 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=8e937d2… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: Thu Jun 6 11:47:10 2013 +0200 cfgutils: updated docs to specify correct time unit for usleep - it is microseconds, pointed by David K --- modules/cfgutils/README | 7 ++++--- modules/cfgutils/doc/cfgutils_admin.xml | 8 +++++--- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/modules/cfgutils/README b/modules/cfgutils/README index 4c79a2f..48307f1 100644 --- a/modules/cfgutils/README +++ b/modules/cfgutils/README @@ -355,17 +355,18 @@ sleep("1"); 4.6. usleep(time) - Waits "time" milli-seconds. + Waits "time" micro-seconds. Meaning of the parameters is as follows: - * time - Time to wait in milli-seconds. + * time - Time to wait in micro-seconds (1/1000000 of a second). This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE. Example 1.10. usleep usage ... -usleep("500"); +# wait 5 miliseconds +usleep("5000"); ... 4.7. abort() diff --git a/modules/cfgutils/doc/cfgutils_admin.xml b/modules/cfgutils/doc/cfgutils_admin.xml index cab8ed2..bc50a85 100644 --- a/modules/cfgutils/doc/cfgutils_admin.xml +++ b/modules/cfgutils/doc/cfgutils_admin.xml @@ -266,12 +266,13 @@ sleep("1"); <function moreinfo="none">usleep(time)</function> </title> <para> - Waits "time" milli-seconds. + Waits "time" micro-seconds. </para> <para>Meaning of the parameters is as follows:</para> <itemizedlist> <listitem> - <para><emphasis>time</emphasis> - Time to wait in milli-seconds. + <para><emphasis>time</emphasis> - Time to wait in micro-seconds + (1/1000000 of a second). </para> </listitem> </itemizedlist> @@ -283,7 +284,8 @@ sleep("1"); <title><function>usleep</function> usage</title> <programlisting format="linespecific"> ... -usleep("500"); +# wait 5 miliseconds +usleep("5000"); ... </programlisting> </example>