texi2pod.pl: import support for @t{...} from gcc

Message ID 20190917032137.306625-1-simon.marchi@polymtl.ca
State New
Headers show
Series
  • texi2pod.pl: import support for @t{...} from gcc
Related show

Commit Message

Simon Marchi Sept. 17, 2019, 3:21 a.m.
GDB's man page source (in gdb.texinfo) contains:

    @t{++}

The @t{...} part is supposed to display the wrapped text with a
fixed-width font.  The texi2pod.pl script currently doesn't handle
@t{...}, so it appears as-is in the man page:

    You can use GDB to debug programs written in C, C@t{++}, Fortran and Modula-2.

gcc's version of texi2pod.pl (at contrib/texi2pod.pl in gcc's repo)
replaces @t{...} with the wrapped text as-is, which I think is an
acceptable behavior.  The fixed-width font distinction is not really
important for a man page, where the text will be displayed with whatever
font the user is using.

Import the line that does that from gcc's version.

I have verified that there is no other, unwanted change in man pages
generated in binutils' and GDB's doc, with this patch applied.

etc/ChangeLog:

	* texi2pod.pl: Handle @t{...} tags.
---
 etc/texi2pod.pl | 1 +
 1 file changed, 1 insertion(+)

-- 
2.23.0

Comments

Simon Marchi Jan. 15, 2020, 5:58 p.m. | #1
On 2019-09-16 11:21 p.m., Simon Marchi wrote:
> GDB's man page source (in gdb.texinfo) contains:

> 

>     @t{++}

> 

> The @t{...} part is supposed to display the wrapped text with a

> fixed-width font.  The texi2pod.pl script currently doesn't handle

> @t{...}, so it appears as-is in the man page:

> 

>     You can use GDB to debug programs written in C, C@t{++}, Fortran and Modula-2.

> 

> gcc's version of texi2pod.pl (at contrib/texi2pod.pl in gcc's repo)

> replaces @t{...} with the wrapped text as-is, which I think is an

> acceptable behavior.  The fixed-width font distinction is not really

> important for a man page, where the text will be displayed with whatever

> font the user is using.

> 

> Import the line that does that from gcc's version.

> 

> I have verified that there is no other, unwanted change in man pages

> generated in binutils' and GDB's doc, with this patch applied.

> 

> etc/ChangeLog:

> 

> 	* texi2pod.pl: Handle @t{...} tags.

> ---

>  etc/texi2pod.pl | 1 +

>  1 file changed, 1 insertion(+)

> 

> diff --git a/etc/texi2pod.pl b/etc/texi2pod.pl

> index b0540338c8ec..8d92bcf6023b 100644

> --- a/etc/texi2pod.pl

> +++ b/etc/texi2pod.pl

> @@ -381,6 +381,7 @@ sub postprocess

>      s/\@file\{([^\}]*)\}/F<$1>/g;

>      s/\@w\{([^\}]*)\}/S<$1>/g;

>      s/\@(?:dmn|math)\{([^\}]*)\}/$1/g;

> +    s/\@t\{([^\}]*)\}/$1/g;

>  

>      # keep references of the form @ref{...}, print them bold

>      s/\@(?:ref)\{([^\}]*)\}/B<$1>/g;

> -- 

> 2.23.0

> 


I've pushed this patch.

Simon

Patch

diff --git a/etc/texi2pod.pl b/etc/texi2pod.pl
index b0540338c8ec..8d92bcf6023b 100644
--- a/etc/texi2pod.pl
+++ b/etc/texi2pod.pl
@@ -381,6 +381,7 @@  sub postprocess
     s/\@file\{([^\}]*)\}/F<$1>/g;
     s/\@w\{([^\}]*)\}/S<$1>/g;
     s/\@(?:dmn|math)\{([^\}]*)\}/$1/g;
+    s/\@t\{([^\}]*)\}/$1/g;
 
     # keep references of the form @ref{...}, print them bold
     s/\@(?:ref)\{([^\}]*)\}/B<$1>/g;