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

[Clément Bœsch]

On Thu, Oct 24, 2013 at 08:03:42PM -0700, Timothy Gu wrote:
> On Thu, Oct 24, 2013 at 2:36 AM, Stefano Sabatini <stefasab at gmail.com> wrote:
> > On date Wednesday 2013-10-23 20:59:22 -0700, Timothy Gu encoded:
> >> On Thu, Oct 17, 2013 at 7:00 PM, 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(-)
> >>
> >> Ping.
> >
> > Please resend the patch since I lost it.
> 
> How can you lost it when you can grep Message-ID?
> 
> Unchanges patch attached.
> 
> Timothy

> From 2065138840367f86bdfef5a1d1578e9229f84c2d Mon Sep 17 00:00:00 2001
> From: Timothy Gu <timothygu99 at gmail.com>
> Date: Thu, 17 Oct 2013 19:00:50 -0700
> Subject: [PATCH] doc/utils: properly escape '@' character
> 
> 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.
>  

Sorry to be a nag about such a trivial commit, but I believe the comment
is not useful: if previous patches made '@' as output it was because we
thought '@' was the correct output.

We use that double @@ escaping all around in the .texi, there is no reason
to comment in that place in particular.

Remember, the changes made in that area were about these '@' mangled into
a markup tag, not because of '@' vs '@@'.

-- 
Clément B.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 490 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20131025/ec336a9c/attachment.asc>