[PATCH 1/2] etc/texi2pod.pl: convert @t{} to C<>

[PATCH 1/2] etc/texi2pod.pl: convert @t{} to C<>

[Carl Bordum Hansen]

Both are intended to be stylized in a typewriter font.
---

I noticed that this was missing when I was looking into the man page
rendering issue.

 etc/texi2pod.pl | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/etc/texi2pod.pl b/etc/texi2pod.pl
index b0540338c8..34ba7efd0f 100644
--- a/etc/texi2pod.pl
+++ b/etc/texi2pod.pl
@@ -375,7 +375,7 @@ sub postprocess
     # Temporary escape for @r.
     s/\@r\{([^\}]*)\}/R<$1>/g;
     s/\@(?:dfn|var|emph|cite|i)\{([^\}]*)\}/I<$1>/g;
-    s/\@(?:code|kbd)\{([^\}]*)\}/C<$1>/g;
+    s/\@(?:code|kbd|t)\{([^\}]*)\}/C<$1>/g;
     s/\@(?:gccoptlist|samp|strong|key|option|env|command|b)\{([^\}]*)\}/B<$1>/g;
     s/\@sc\{([^\}]*)\}/\U$1/g;
     s/\@file\{([^\}]*)\}/F<$1>/g;
-- 
2.17.1

Re: [PATCH 1/2] etc/texi2pod.pl: convert @t{} to C<>

[Simon Marchi]

On 2019-09-16 6:04 p.m., Carl Bordum Hansen wrote:
> Both are intended to be stylized in a typewriter font.
> ---
> 
> I noticed that this was missing when I was looking into the man page
> rendering issue.

[adding binutils, since it's concerns shared files]

Hi Carl,

With this patch applied, the result in the man page is:

  ...programs written in C, C"++"...

There are two ways I can see to get rid of those quotes:

1. Substitute @t{...} with the content as-is, not C<...>
2. Use the option "--quotes none" of pod2man

This file happens to be present in the gcc repo as well [1], and the gcc version should
probably be considered the upstream.  If you diff the binutils-gdb version with
the gcc version, you'll see that the gcc version seems to have received additional
fixes compared to the binutils-gdb version.  And there's one fix [2] that happens to be
for the @t{...} issue, that's same as solution #1.

Since it's preferable to stay as close as possible to the gcc version, I suggest we
instead sync our version with the gcc one.

Simon

[1] https://gcc.gnu.org/git/?p=gcc.git;a=blob;f=contrib/texi2pod.pl;h=91bdbb5cea933d0381f2924ab94490fca31d5800;hb=HEAD
[2] https://gcc.gnu.org/git/?p=gcc.git;a=commit;h=6be49d577254ca021cf0904f920d9785d5fc74c8

Re: [PATCH 1/2] etc/texi2pod.pl: convert @t{} to C<>

[Simon Marchi]

On 2019-09-16 9:40 p.m., Simon Marchi wrote:
> On 2019-09-16 6:04 p.m., Carl Bordum Hansen wrote:
>> Both are intended to be stylized in a typewriter font.
>> ---
>>
>> I noticed that this was missing when I was looking into the man page
>> rendering issue.
> 
> [adding binutils, since it's concerns shared files]
> 
> Hi Carl,
> 
> With this patch applied, the result in the man page is:
> 
>   ...programs written in C, C"++"...
> 
> There are two ways I can see to get rid of those quotes:
> 
> 1. Substitute @t{...} with the content as-is, not C<...>
> 2. Use the option "--quotes none" of pod2man
> 
> This file happens to be present in the gcc repo as well [1], and the gcc version should
> probably be considered the upstream.  If you diff the binutils-gdb version with
> the gcc version, you'll see that the gcc version seems to have received additional
> fixes compared to the binutils-gdb version.  And there's one fix [2] that happens to be
> for the @t{...} issue, that's same as solution #1.
> 
> Since it's preferable to stay as close as possible to the gcc version, I suggest we
> instead sync our version with the gcc one.
> 
> Simon
> 
> [1] https://gcc.gnu.org/git/?p=gcc.git;a=blob;f=contrib/texi2pod.pl;h=91bdbb5cea933d0381f2924ab94490fca31d5800;hb=HEAD
> [2] https://gcc.gnu.org/git/?p=gcc.git;a=commit;h=6be49d577254ca021cf0904f920d9785d5fc74c8
> 

I have submitted the following patch to this effect:

https://sourceware.org/ml/gdb-patches/2019-09/msg00305.html

Simon

Re: [PATCH 1/2] etc/texi2pod.pl: convert @t{} to C<>

[Tom Tromey]

>>>>> "Carl" == Carl Bordum Hansen <carl@bordum.dk> writes:

Carl> Both are intended to be stylized in a typewriter font.

Thank you for doing this.

This seems fine but I wonder if we should simply copy the entire script
from gcc, and move it to contrib/ as well to further parallel gcc.
Would there be a drawback to doing this?

Carl>  etc/texi2pod.pl | 2 +-
Carl>  1 file changed, 1 insertion(+), 1 deletion(-)

This needs a ChangeLog entry regardless.

Tom

Re: [PATCH 1/2] etc/texi2pod.pl: convert @t{} to C<>

[Simon Marchi]

On 2019-09-17 2:33 p.m., Tom Tromey wrote:
>>>>>> "Carl" == Carl Bordum Hansen <carl@bordum.dk> writes:
> 
> Carl> Both are intended to be stylized in a typewriter font.
> 
> Thank you for doing this.
> 
> This seems fine but I wonder if we should simply copy the entire script
> from gcc, and move it to contrib/ as well to further parallel gcc.
> Would there be a drawback to doing this?
> 
> Carl>  etc/texi2pod.pl | 2 +-
> Carl>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> This needs a ChangeLog entry regardless.
> 
> Tom

Hi Tom,

I don't know if you said this before of after seeing the patch I proposed here:

  https://sourceware.org/ml/gdb-patches/2019-09/msg00305.html

Ideally we'd have the exact same version as gcc.  But I chose not to blindly copy the
gcc version, because it causes other changes to the generated files, and I don't know
if they are desirable or not.  Also, there are some changes local to binutils-gdb that
should be either removed if no longer useful, or ported over to gcc.  In the interest
of fixing the reported issue without opening a pandora's box, I opted for the smallest
fix possible (which is still a small step towards syncing both versions).

Simon

Re: [PATCH 1/2] etc/texi2pod.pl: convert @t{} to C<>

[Tom Tromey]

>>>>> "Simon" == Simon Marchi <simark@simark.ca> writes:

Simon> I don't know if you said this before of after seeing the patch I proposed here:

Simon>   https://sourceware.org/ml/gdb-patches/2019-09/msg00305.html

Ah, thanks.  I must have skipped this.

Simon> In the interest of fixing the reported issue without opening a
Simon> pandora's box, I opted for the smallest fix possible (which is
Simon> still a small step towards syncing both versions).

Sounds good.

Tom