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

Submitted by Moritz Barsnick on March 10, 2018, 6:32 p.m.

Details

Message ID 20180310183209.GC2159@sunshine.barsnick.net
State New
Headers show

Commit Message

Moritz Barsnick March 10, 2018, 6:32 p.m.
These suffixes were recently introduced in 61c972384d311508d07f9360d196909e27195655
and completed in 8218249f1f04de65904f58519bde21948e5a0783.

Signed-off-by: Moritz Barsnick <barsnick@gmx.net>
---

I chose not to document the suffixes in the section describing the
HH:MM:SS.mmm syntax, even though they work there (with expected, but
quite difficult to explain effects).

 doc/utils.texi | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

Comments

Moritz Barsnick March 14, 2018, 1:37 p.m.
On Sat, Mar 10, 2018 at 19:32:09 +0100, Moritz Barsnick wrote:
> These suffixes were recently introduced in 61c972384d311508d07f9360d196909e27195655
> and completed in 8218249f1f04de65904f58519bde21948e5a0783.

Ping.
Marton Balint March 18, 2018, 7:06 p.m.
On Sat, 10 Mar 2018, Moritz Barsnick wrote:

> These suffixes were recently introduced in 61c972384d311508d07f9360d196909e27195655
> and completed in 8218249f1f04de65904f58519bde21948e5a0783.
>
> Signed-off-by: Moritz Barsnick <barsnick@gmx.net>
> ---
>
> I chose not to document the suffixes in the section describing the
> HH:MM:SS.mmm syntax, even though they work there (with expected, but
> quite difficult to explain effects).
>
> doc/utils.texi | 5 +++--
> 1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/doc/utils.texi b/doc/utils.texi
> index d55dd315c3..a094ee151c 100644
> --- a/doc/utils.texi
> +++ b/doc/utils.texi
> @@ -110,11 +110,12 @@ 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}...][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{ms} or @samp{us} indicate to
> +interpret the value as milliseconds or microseconds, respectively.

I think you missed the normal "s" suffix (as in seconds) which is also 
supported from now on.

Regards,
Marton

Patch hide | download patch | download mbox

diff --git a/doc/utils.texi b/doc/utils.texi
index d55dd315c3..a094ee151c 100644
--- a/doc/utils.texi
+++ b/doc/utils.texi
@@ -110,11 +110,12 @@  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}...][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{ms} or @samp{us} indicate to
+interpret the value as milliseconds or microseconds, respectively.
 
 In both expressions, the optional @samp{-} indicates negative duration.