diff mbox series

[FFmpeg-devel,v2] doc/utils: document the "s", "ms" and "us" suffixes for durations

Message ID 20200608153900.3746-1-barsnick@gmx.net
State Accepted
Headers show
Series [FFmpeg-devel,v2] doc/utils: document the "s", "ms" and "us" suffixes for durations
Related show

Commit Message

Moritz Barsnick June 8, 2020, 3:39 p.m. UTC
These suffixes were introduced in 61c972384d311508d07f9360d196909e27195655
and completed in 8218249f1f04de65904f58519bde21948e5a0783.

Signed-off-by: Moritz Barsnick <barsnick@gmx.net>
---
 doc/utils.texi | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

--
2.26.2

Comments

Gyan Doshi June 8, 2020, 4:25 p.m. UTC | #1
On 08-06-2020 09:09 pm, Moritz Barsnick wrote:
> These suffixes were introduced in 61c972384d311508d07f9360d196909e27195655
> and completed in 8218249f1f04de65904f58519bde21948e5a0783.
>
> Signed-off-by: Moritz Barsnick <barsnick@gmx.net>
> ---
>   doc/utils.texi | 6 ++++--
>   1 file changed, 4 insertions(+), 2 deletions(-)
>
> diff --git a/doc/utils.texi b/doc/utils.texi
> index e7a9b40b35..44ce285d26 100644
> --- 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.
>
> --

Will apply.

Thanks,
Gyan
diff mbox series

Patch

diff --git a/doc/utils.texi b/doc/utils.texi
index e7a9b40b35..44ce285d26 100644
--- 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.