[FFmpeg-devel] [PATCH] doc/utils: properly escape '@' character

[Timothy Gu]

On Oct 18, 2013 1:34 AM, "Stefano Sabatini" <stefasab at gmail.com> wrote:
>
> On date Wednesday 2013-10-16 20:38:40 -0700, Timothy Gu encoded:
> > Addresses 9a63a45e48acaee563a7c692a3aaaeaff67545b2
> >
> > Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
> > ---
> >  doc/utils.texi | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/doc/utils.texi b/doc/utils.texi
> > index 16101f0..58cb991 100644
> > --- a/doc/utils.texi
> > +++ b/doc/utils.texi
> > @@ -284,7 +284,7 @@ The undefined value can be expressed using the
"0:0" string.
> >  @section Color
> >
> >  It can be the name of a color as defined below (case insensitive
match) or a
> > - at code{[0x|#]RRGGBB[AA]} sequence, possibly followed by @@ and a string
> > + at code{[0x|#]RRGGBB[AA]} sequence, possibly followed by @samp{@@@@} and
a string @c It's actually @@, but Texinfo needs escaping
> >  representing the alpha component.
>
> This doesn't work with texi2pod.pl and the advantage of fixing it is
> far beyond the little rendering gain we would have in this case.

This is not "rendering gain". Look at
http://ffmpeg.org/ffmpeg-utils.html#Color right now. It says "@" and it's
wrong.

>
> Also I think the correct syntax is @samp{@@}, but this is a very
> obscure corner case (possibly overlooked by the same creators of
> texinfo) and the manual doesn't mention how the user is supposed to
> escape special characters, thus we should avoid its use.

So I removed the @samp from the first itineration of the patch in the 2rd
one.

Also, Texinfo's manual does say how to escape characters. It's just
texi2pod/pod2man does not support it well enough.
http://www.gnu.org/software/texinfo/manual/texinfo/html_node/Inserting-an-Atsign.html#Inserting-an-Atsign

> --
> FFmpeg = Fantastic and Fundamental Mysterious Portable EnGraver
> _______________________________________________
> ffmpeg-devel mailing list
> ffmpeg-devel at ffmpeg.org
> http://ffmpeg.org/mailman/listinfo/ffmpeg-devel