From: "G. Branden Robinson" <g.branden.robinson@gmail.com>
To: Alejandro Colomar <alx@kernel.org>
Cc: linux-man@vger.kernel.org
Subject: [PATCH 1/5] stdio.3, signal-safety.7: srcfix
Date: Sat, 31 Aug 2024 13:20:27 -0500 [thread overview]
Message-ID: <20240831182027.b6pduwkthk5b3tcf@illithid> (raw)
[-- Attachment #1: Type: text/plain, Size: 7099 bytes --]
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
\# 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@gmail.com>
---
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
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
next reply other threads:[~2024-08-31 18:20 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-08-31 18:20 G. Branden Robinson [this message]
2024-08-31 20:43 ` [PATCH 1/5] stdio.3, signal-safety.7: srcfix Alejandro Colomar
-- strict thread matches above, loose matches on Subject: below --
2024-08-31 18:20 [PATCH 2/5] syscalls.2, signal-safety.7, namespaces.7: srcfix G. Branden Robinson
2024-08-31 20:48 ` Alejandro Colomar
2024-08-31 18:20 [PATCH 3/5] namespaces.7: ffix G. Branden Robinson
2024-08-31 20:51 ` Alejandro Colomar
2024-08-31 21:23 ` [PATCH 1/5] stdio.3, signal-safety.7: srcfix G. Branden Robinson
2024-08-31 21:43 ` Alejandro Colomar
2024-08-31 22:17 ` G. Branden Robinson
2024-08-31 22:27 ` Alejandro Colomar
2024-09-01 2:56 ` G. Branden Robinson
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240831182027.b6pduwkthk5b3tcf@illithid \
--to=g.branden.robinson@gmail.com \
--cc=alx@kernel.org \
--cc=linux-man@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox