diff mbox series

[FFmpeg-devel] doc/codecs: -channel_layout -> should be -ch_layout

Message ID 20240112235125.2711735-1-marth64@proxyid.net
State New
Headers show
Series [FFmpeg-devel] doc/codecs: -channel_layout -> should be -ch_layout | expand

Checks

Context Check Description
yinshiyou/make_loongarch64 success Make finished
yinshiyou/make_fate_loongarch64 success Make fate finished
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished

Commit Message

Marth64 Jan. 12, 2024, 11:51 p.m. UTC
Signed-off-by: Marth64 <marth64@proxyid.net>
---
 doc/codecs.texi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Stefano Sabatini Jan. 14, 2024, 2:04 p.m. UTC | #1
On date Friday 2024-01-12 17:51:26 -0600, Marth64 wrote:
> Signed-off-by: Marth64 <marth64@proxyid.net>
> ---
>  doc/codecs.texi | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/doc/codecs.texi b/doc/codecs.texi
> index 6bdeb664e7..ca8c08a59f 100644
> --- a/doc/codecs.texi
> +++ b/doc/codecs.texi
> @@ -766,7 +766,7 @@ Set rate-distortion optimal quantization.
>  @item mv0_threshold @var{integer} (@emph{encoding,video})
>  @item compression_level @var{integer} (@emph{encoding,audio,video})
>  @item bits_per_raw_sample @var{integer}
> -@item channel_layout @var{integer} (@emph{decoding/encoding,audio})
> +@item ch_layout @var{integer} (@emph{decoding/encoding,audio})
>  See @ref{channel layout syntax,,the Channel Layout section in the ffmpeg-utils(1) manual,ffmpeg-utils}
>  for the required syntax.

This is not correct, this is referencing the deprecated channel_layout
API (which should be kept while we should document the new one), the
new option takes a string.

Check options_table.c.
diff mbox series

Patch

diff --git a/doc/codecs.texi b/doc/codecs.texi
index 6bdeb664e7..ca8c08a59f 100644
--- a/doc/codecs.texi
+++ b/doc/codecs.texi
@@ -766,7 +766,7 @@  Set rate-distortion optimal quantization.
 @item mv0_threshold @var{integer} (@emph{encoding,video})
 @item compression_level @var{integer} (@emph{encoding,audio,video})
 @item bits_per_raw_sample @var{integer}
-@item channel_layout @var{integer} (@emph{decoding/encoding,audio})
+@item ch_layout @var{integer} (@emph{decoding/encoding,audio})
 See @ref{channel layout syntax,,the Channel Layout section in the ffmpeg-utils(1) manual,ffmpeg-utils}
 for the required syntax.