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

[Timothy Gu]

On Oct 18, 2013 2:48 AM, "Paul B Mahol" <onemda at gmail.com> wrote:
>
> On 10/18/13, Timothy Gu <timothygu99 at gmail.com> wrote:
> > From 9a63a45e48acaee563a7c692a3aaaeaff67545b2, the doc shows that the
> > syntax
> > is "@", which is not correct.
> >
> > At first, I tried to use @samp{@@@@}, but a bug in texi2pod.pl prevents
me
> > from using that. Then I found
> >
https://github.com/mirrors/gcc/commit/12786727a1605d8ab91ba9a7e66cb17a328caf01
> > which seems to be promising, but doesn't work as pod2man does not
support
> > HTML-style escapes like &atsign; .
> >
> > Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
> > ---
> >  doc/utils.texi | 5 +++--
> >  1 file changed, 3 insertions(+), 2 deletions(-)
> >
> > diff --git a/doc/utils.texi b/doc/utils.texi
> > index 16101f0..8b0f655 100644
> > --- a/doc/utils.texi
> > +++ b/doc/utils.texi
> > @@ -284,8 +284,9 @@ 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
> > -representing the alpha component.
> > + at code{[0x|#]RRGGBB[AA]} sequence, possibly followed by "@@@@"
> > + at c On the last line, it's actually "@@", but Texinfo needs escaping.
> > +and a string representing the alpha component.
>
> Mentioning texinfo in documentation is sloppy. How you managed to get
> such idea...

If you know Texinfo, you know that lines starting with @c means that is is
a comment and does not present in the final documentation. I'm sorry but I
must say that you are sloppy in reviewing things you don't know.

[...]

Timothy