Re: [PATCH 1/5] stdio.3, signal-safety.7: srcfix

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Sat, Aug 31, 2024 at 01:20:27PM GMT, G. Branden Robinson wrote:
> Prepare for `MR` macro migration.
> 
> Migrate table entries from using font selection escape sequences to font
> alternation macros to set man page cross references.
> 
> This change was automatically driven by the following sed(1) script.
> 
> $ cat fix-man-page-refs-in-tbl-tables-2.sed
> \# Rewrite man page cross references on tbl(1) rows that precede text

Hi Branden,

I guess \# doesn't appear in your actual script.
What I usually do to avoid problems with git(1) is to indent everything.

> \# blocks to themselves use text blocks, and convert them to use man(7)
> \# macros instead of troff(1) font selection escape sequences (which
> \# cannot be done outside a text block).
> /^\.\\"/b
> /^\\fB[^\\]*\\fP([0-9][a-z]*).*T{/s/\\fB\([^\\]*\)\\fP\(([0-9][a-z]*)\)\(.*\)/T{\
> .BR \1 \2\
> T}\3/
> 
> Signed-off-by: "G. Branden Robinson" <g.branden.robinson@xxxxxxxxx>

Patch applied.  Thanks!

Have a lovely night!
Alex
> ---
>  man/man3/stdio.3         | 236 +++++++++++++++++++++++++++++----------
>  man/man7/signal-safety.7 |  12 +-
>  2 files changed, 186 insertions(+), 62 deletions(-)
> 
> diff --git a/man/man3/stdio.3 b/man/man3/stdio.3
> index 6e534296f..728424c2c 100644
> --- a/man/man3/stdio.3
> +++ b/man/man3/stdio.3
> @@ -162,181 +162,299 @@ .SS List of functions
>  l l.
>  Function	Description
>  _
> -\fBclearerr\fP(3)	T{
> +T{
> +.BR clearerr (3)
> +T}	T{
>  check and reset stream status
>  T}
> -\fBfclose\fP(3)	T{
> +T{
> +.BR fclose (3)
> +T}	T{
>  close a stream
>  T}
> -\fBfdopen\fP(3)	T{
> +T{
> +.BR fdopen (3)
> +T}	T{
>  stream open functions
>  T}
> -\fBfeof\fP(3)	T{
> +T{
> +.BR feof (3)
> +T}	T{
>  check and reset stream status
>  T}
> -\fBferror\fP(3)	T{
> +T{
> +.BR ferror (3)
> +T}	T{
>  check and reset stream status
>  T}
> -\fBfflush\fP(3)	T{
> +T{
> +.BR fflush (3)
> +T}	T{
>  flush a stream
>  T}
> -\fBfgetc\fP(3)	T{
> +T{
> +.BR fgetc (3)
> +T}	T{
>  get next character or word from input stream
>  T}
> -\fBfgetpos\fP(3)	T{
> +T{
> +.BR fgetpos (3)
> +T}	T{
>  reposition a stream
>  T}
> -\fBfgets\fP(3)	T{
> +T{
> +.BR fgets (3)
> +T}	T{
>  get a line from a stream
>  T}
> -\fBfileno\fP(3)	T{
> +T{
> +.BR fileno (3)
> +T}	T{
>  return the integer descriptor of the argument stream
>  T}
> -\fBfmemopen\fP(3)	T{
> +T{
> +.BR fmemopen (3)
> +T}	T{
>  open memory as stream
>  T}
> -\fBfopen\fP(3)	T{
> +T{
> +.BR fopen (3)
> +T}	T{
>  stream open functions
>  T}
> -\fBfopencookie\fP(3)	T{
> +T{
> +.BR fopencookie (3)
> +T}	T{
>  open a custom stream
>  T}
> -\fBfprintf\fP(3)	T{
> +T{
> +.BR fprintf (3)
> +T}	T{
>  formatted output conversion
>  T}
> -\fBfpurge\fP(3)	T{
> +T{
> +.BR fpurge (3)
> +T}	T{
>  flush a stream
>  T}
> -\fBfputc\fP(3)	T{
> +T{
> +.BR fputc (3)
> +T}	T{
>  output a character or word to a stream
>  T}
> -\fBfputs\fP(3)	T{
> +T{
> +.BR fputs (3)
> +T}	T{
>  output a line to a stream
>  T}
> -\fBfread\fP(3)	T{
> +T{
> +.BR fread (3)
> +T}	T{
>  binary stream input/output
>  T}
> -\fBfreopen\fP(3)	T{
> +T{
> +.BR freopen (3)
> +T}	T{
>  stream open functions
>  T}
> -\fBfscanf\fP(3)	T{
> +T{
> +.BR fscanf (3)
> +T}	T{
>  input format conversion
>  T}
> -\fBfseek\fP(3)	T{
> +T{
> +.BR fseek (3)
> +T}	T{
>  reposition a stream
>  T}
> -\fBfsetpos\fP(3)	T{
> +T{
> +.BR fsetpos (3)
> +T}	T{
>  reposition a stream
>  T}
> -\fBftell\fP(3)	T{
> +T{
> +.BR ftell (3)
> +T}	T{
>  reposition a stream
>  T}
> -\fBfwrite\fP(3)	T{
> +T{
> +.BR fwrite (3)
> +T}	T{
>  binary stream input/output
>  T}
> -\fBgetc\fP(3)	T{
> +T{
> +.BR getc (3)
> +T}	T{
>  get next character or word from input stream
>  T}
> -\fBgetchar\fP(3)	T{
> +T{
> +.BR getchar (3)
> +T}	T{
>  get next character or word from input stream
>  T}
> -\fBgets\fP(3)	T{
> +T{
> +.BR gets (3)
> +T}	T{
>  get a line from a stream
>  T}
> -\fBgetw\fP(3)	T{
> +T{
> +.BR getw (3)
> +T}	T{
>  get next character or word from input stream
>  T}
> -\fBmktemp\fP(3)	T{
> +T{
> +.BR mktemp (3)
> +T}	T{
>  make temporary filename (unique)
>  T}
> -\fBopen_memstream\fP(3)	T{
> +T{
> +.BR open_memstream (3)
> +T}	T{
>  open a dynamic memory buffer stream
>  T}
> -\fBopen_wmemstream\fP(3)	T{
> +T{
> +.BR open_wmemstream (3)
> +T}	T{
>  open a dynamic memory buffer stream
>  T}
> -\fBperror\fP(3)	T{
> +T{
> +.BR perror (3)
> +T}	T{
>  system error messages
>  T}
> -\fBprintf\fP(3)	T{
> +T{
> +.BR printf (3)
> +T}	T{
>  formatted output conversion
>  T}
> -\fBputc\fP(3)	T{
> +T{
> +.BR putc (3)
> +T}	T{
>  output a character or word to a stream
>  T}
> -\fBputchar\fP(3)	T{
> +T{
> +.BR putchar (3)
> +T}	T{
>  output a character or word to a stream
>  T}
> -\fBputs\fP(3)	T{
> +T{
> +.BR puts (3)
> +T}	T{
>  output a line to a stream
>  T}
> -\fBputw\fP(3)	T{
> +T{
> +.BR putw (3)
> +T}	T{
>  output a character or word to a stream
>  T}
> -\fBremove\fP(3)	T{
> +T{
> +.BR remove (3)
> +T}	T{
>  remove directory entry
>  T}
> -\fBrewind\fP(3)	T{
> +T{
> +.BR rewind (3)
> +T}	T{
>  reposition a stream
>  T}
> -\fBscanf\fP(3)	T{
> +T{
> +.BR scanf (3)
> +T}	T{
>  input format conversion
>  T}
> -\fBsetbuf\fP(3)	T{
> +T{
> +.BR setbuf (3)
> +T}	T{
>  stream buffering operations
>  T}
> -\fBsetbuffer\fP(3)	T{
> +T{
> +.BR setbuffer (3)
> +T}	T{
>  stream buffering operations
>  T}
> -\fBsetlinebuf\fP(3)	T{
> +T{
> +.BR setlinebuf (3)
> +T}	T{
>  stream buffering operations
>  T}
> -\fBsetvbuf\fP(3)	T{
> +T{
> +.BR setvbuf (3)
> +T}	T{
>  stream buffering operations
>  T}
> -\fBsprintf\fP(3)	T{
> +T{
> +.BR sprintf (3)
> +T}	T{
>  formatted output conversion
>  T}
> -\fBsscanf\fP(3)	T{
> +T{
> +.BR sscanf (3)
> +T}	T{
>  input format conversion
>  T}
> -\fBstrerror\fP(3)	T{
> +T{
> +.BR strerror (3)
> +T}	T{
>  system error messages
>  T}
> -\fBsys_errlist\fP(3)	T{
> +T{
> +.BR sys_errlist (3)
> +T}	T{
>  system error messages
>  T}
> -\fBsys_nerr\fP(3)	T{
> +T{
> +.BR sys_nerr (3)
> +T}	T{
>  system error messages
>  T}
> -\fBtempnam\fP(3)	T{
> +T{
> +.BR tempnam (3)
> +T}	T{
>  temporary file routines
>  T}
> -\fBtmpfile\fP(3)	T{
> +T{
> +.BR tmpfile (3)
> +T}	T{
>  temporary file routines
>  T}
> -\fBtmpnam\fP(3)	T{
> +T{
> +.BR tmpnam (3)
> +T}	T{
>  temporary file routines
>  T}
> -\fBungetc\fP(3)	T{
> +T{
> +.BR ungetc (3)
> +T}	T{
>  un-get character from input stream
>  T}
> -\fBvfprintf\fP(3)	T{
> +T{
> +.BR vfprintf (3)
> +T}	T{
>  formatted output conversion
>  T}
> -\fBvfscanf\fP(3)	T{
> +T{
> +.BR vfscanf (3)
> +T}	T{
>  input format conversion
>  T}
> -\fBvprintf\fP(3)	T{
> +T{
> +.BR vprintf (3)
> +T}	T{
>  formatted output conversion
>  T}
> -\fBvscanf\fP(3)	T{
> +T{
> +.BR vscanf (3)
> +T}	T{
>  input format conversion
>  T}
> -\fBvsprintf\fP(3)	T{
> +T{
> +.BR vsprintf (3)
> +T}	T{
>  formatted output conversion
>  T}
> -\fBvsscanf\fP(3)	T{
> +T{
> +.BR vsscanf (3)
> +T}	T{
>  input format conversion
>  T}
>  .TE
> diff --git a/man/man7/signal-safety.7 b/man/man7/signal-safety.7
> index cde19a575..440894529 100644
> --- a/man/man7/signal-safety.7
> +++ b/man/man7/signal-safety.7
> @@ -95,7 +95,9 @@ .SH DESCRIPTION
>  \fBcreat\fP(2)
>  \fBdup\fP(2)
>  \fBdup2\fP(2)
> -\fBexecl\fP(3)	T{
> +T{
> +.BR execl (3)
> +T}	T{
>  Added in POSIX.1-2008; see notes below
>  T}
>  \fBexecle\fP(3)	See notes below
> @@ -136,7 +138,9 @@ .SH DESCRIPTION
>  \fBlink\fP(2)
>  \fBlinkat\fP(2)	Added in POSIX.1-2008
>  \fBlisten\fP(2)
> -\fBlongjmp\fP(3)	T{
> +T{
> +.BR longjmp (3)
> +T}	T{
>  Added in POSIX.1-2008 TC2; see notes below
>  T}
>  \fBlseek\fP(2)
> @@ -192,7 +196,9 @@ .SH DESCRIPTION
>  \fBsigemptyset\fP(3)
>  \fBsigfillset\fP(3)
>  \fBsigismember\fP(3)
> -\fBsiglongjmp\fP(3)	T{
> +T{
> +.BR siglongjmp (3)
> +T}	T{
>  Added in POSIX.1-2008 TC2; see notes below
>  T}
>  \fBsignal\fP(2)
> -- 
> 2.30.2
> 



-- 
<https://www.alejandro-colomar.es/>

Attachment: signature.asc
Description: PGP signature


[Index of Archives]     [Kernel Documentation]     [Netdev]     [Linux Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux