From f48987f609cbbc05f08cb233846a7679907fb96f Mon Sep 17 00:00:00 2001 From: Andreas Rheinhardt Date: Sat, 13 Apr 2024 00:10:49 +0200 Subject: [PATCH] doc/muxers.texi: Don't use confusing variable name reserve_index_space is a size, not an index. Also refer to the variable in the description. Signed-off-by: Andreas Rheinhardt --- doc/muxers.texi | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/muxers.texi b/doc/muxers.texi index 4b30970b78..489f22288b 100644 --- a/doc/muxers.texi +++ b/doc/muxers.texi @@ -2816,14 +2816,14 @@ ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_ @subsection Options @table @option -@item reserve_index_space @var{index} +@item reserve_index_space @var{size} By default, this muxer writes the index for seeking (called cues in Matroska terms) at the end of the file, because it cannot know in advance how much space to leave for the index at the beginning of the file. However for some use cases -- e.g. streaming where seeking is possible but slow -- it is useful to put the index at the beginning of the file. -If this option is set to a non-zero value, the muxer will reserve a given amount +If this option is set to a non-zero value, the muxer will reserve @var{size} bytes of space in the file header and then try to write the cues there when the muxing finishes. If the reserved space does not suffice, no Cues will be written, the file will be finalized and writing the trailer will return an error.