[FFmpeg-devel] [PATCH] Add documentation for -ast, -vst, -sst

[Stefano Sabatini]

On date Thursday 2009-02-19 20:52:35 -0500, Steve Zakulec encoded:
> This patch adds documentation for the three options listed above.

> Index: ffplay.c
> ===================================================================
> --- ffplay.c	(revision 17468)
> +++ ffplay.c	(working copy)
> @@ -2503,9 +2503,9 @@
>      { "fs", OPT_BOOL, {(void*)&is_full_screen}, "force full screen" },
>      { "an", OPT_BOOL, {(void*)&audio_disable}, "disable audio" },
>      { "vn", OPT_BOOL, {(void*)&video_disable}, "disable video" },
> -    { "ast", OPT_INT | HAS_ARG | OPT_EXPERT, {(void*)&wanted_audio_stream}, "", "" },
> -    { "vst", OPT_INT | HAS_ARG | OPT_EXPERT, {(void*)&wanted_video_stream}, "", "" },
> -    { "sst", OPT_INT | HAS_ARG | OPT_EXPERT, {(void*)&wanted_subtitle_stream}, "", "" },
> +    { "ast", OPT_INT | HAS_ARG | OPT_EXPERT, {(void*)&wanted_audio_stream}, "desired audio stream", "" },

The help name should be a verbal description of what the option does, for example:
"select audio stream to play"

the argname is the nominal description of the arg, so maybe "audio
stream number" may work.

Also the man page should be updated and extended, for example the
number is the global stream index or the number of the audio stream in
the list of audio streams? Also what happens when the value is invalid
(negative or too big), does it starts with zero or with 1?

> +    { "vst", OPT_INT | HAS_ARG | OPT_EXPERT, {(void*)&wanted_video_stream}, "desired video stream", "" },
> +    { "sst", OPT_INT | HAS_ARG | OPT_EXPERT, {(void*)&wanted_subtitle_stream}, "desired subtitle stream", "" },
>      { "ss", HAS_ARG | OPT_FUNC2, {(void*)&opt_seek}, "seek to a given position in seconds", "pos" },
>      { "bytes", OPT_BOOL, {(void*)&seek_by_bytes}, "seek by bytes" },
>      { "nodisp", OPT_BOOL, {(void*)&display_disable}, "disable graphical display" },

Thanks for taking care of this, regards.
-- 
FFmpeg = Fostering and Fierce Muttering Programmable Evangelical Game