doc/utils: document the "s", "ms" and "us" suffixes for durations

These suffixes were introduced in 61c972384d and completed in 8218249f1f. Signed-off-by: Moritz Barsnick <barsnick@gmx.net>
5 years ago · 7ab375f574
parent aab0885c19
commit 7ab375f574
1 changed files with 4 additions and 2 deletions
--- a/doc/utils.texi
+++ b/doc/utils.texi
@ -110,11 +110,13 @@ maximum of 2 digits. The @var{m} at the end expresses decimal value for
@emph{or}

@example
-[-]@var{S}+[.@var{m}...]
+[-]@var{S}+[.@var{m}...][s|ms|us]
@end example

@var{S} expresses the number of seconds, with the optional decimal part
-@var{m}.
+@var{m}.  The optional literal suffixes @samp{s}, @samp{ms} or @samp{us}
+indicate to interpret the value as seconds, milliseconds or microseconds,
+respectively.

 In both expressions, the optional @samp{-} indicates negative duration.