diff mbox series

[FFmpeg-devel,1/1] lavc/libaribcaption: Fix mistake in document decoders.texi

Message ID 20231101150340.69430-2-xqq@xqq.im
State New
Headers show
Series Fix document mistake for lavc/libaribcaption | expand

Checks

Context Check Description
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished

Commit Message

zheng qian Nov. 1, 2023, 3:03 p.m. UTC
Fix the mistake in the description of `-caption_encoding encoding_scheme` option.

Signed-off-by: zheng qian <xqq@xqq.im>
---
 doc/decoders.texi | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Gyan Doshi Nov. 1, 2023, 3:13 p.m. UTC | #1
On 2023-11-01 08:33 pm, zheng qian wrote:
> Fix the mistake in the description of `-caption_encoding encoding_scheme` option.
>
> Signed-off-by: zheng qian<xqq@xqq.im>
> ---
>   doc/decoders.texi | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/doc/decoders.texi b/doc/decoders.texi
> index eb00e2a9e9..59279bde24 100644
> --- a/doc/decoders.texi
> +++ b/doc/decoders.texi
> @@ -403,8 +403,8 @@ Latin character encoding defined in ABNT NBR 15606-1.
>   This encoding is used in South America for SBTVD / ISDB-Tb captions.
>   @end table
>   
> -The default is @dfn{ass} as same as @dfn{libaribb24} decoder.
> -Some present players (e.g., @dfn{mpv}) expect ASS format for ARIB caption.
> +The default is @dfn{auto} which tries to determine text encoding automatically.

Convention is simply to add default in the default value's description i.e.

"
@item auto
Automatically detect text encoding (default).
"

> +You can specify a specific encoding scheme if the source of the broadcast is known.
This line can go.

Regards,
Gyan
diff mbox series

Patch

diff --git a/doc/decoders.texi b/doc/decoders.texi
index eb00e2a9e9..59279bde24 100644
--- a/doc/decoders.texi
+++ b/doc/decoders.texi
@@ -403,8 +403,8 @@  Latin character encoding defined in ABNT NBR 15606-1.
 This encoding is used in South America for SBTVD / ISDB-Tb captions.
 @end table
 
-The default is @dfn{ass} as same as @dfn{libaribb24} decoder.
-Some present players (e.g., @dfn{mpv}) expect ASS format for ARIB caption.
+The default is @dfn{auto} which tries to determine text encoding automatically.
+You can specify a specific encoding scheme if the source of the broadcast is known.
 
 @item -font @var{font_name[,font_name2,...]}
 Specify comma-separated list of font family names to be used for @dfn{bitmap}