* [PATCH 00/11] man3: fix wrong/non-existent section references
@ 2024-06-16 1:18 Kir Kolyshkin
2024-06-16 1:18 ` [PATCH 01/11] exec.3: fix section reference Kir Kolyshkin
` (11 more replies)
0 siblings, 12 replies; 19+ messages in thread
From: Kir Kolyshkin @ 2024-06-16 1:18 UTC (permalink / raw
To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man
Commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY:
Reorganize sections") results in many wrong section references.
Mostly, this is about references to no-longer-existent section NOTES,
but there are some other issues as well, such as references to a wrong
section, or a discussion which is now split in between two sections,
etc.
This patch series tries to fix some of these issues in man3 section
only (I haven't checked other section numbers).
Found accidentally when reading exec(3).
Kir Kolyshkin (11):
exec.3: fix section reference
posix_fallocate.3: fix section references
floor.3: fix section reference
ceil.3,rint.3,round.3: rm NOTES section
getdtablesize.3: fix section reference
readdir.3: fix section references
setjmp.3: fix section references
sigpause.3: fix section reference
stailq.3: fix section reference
strtok.3: fix section reference
strtod.3: fix wrong section reference
man/man3/ceil.3 | 4 ++--
man/man3/exec.3 | 2 +-
man/man3/floor.3 | 2 +-
man/man3/getdtablesize.3 | 2 +-
man/man3/posix_fallocate.3 | 4 ++--
man/man3/readdir.3 | 8 ++++----
man/man3/rint.3 | 4 ++--
man/man3/round.3 | 4 ++--
man/man3/setjmp.3 | 6 +++---
man/man3/sigpause.3 | 2 +-
man/man3/stailq.3 | 2 +-
man/man3/strtod.3 | 2 +-
man/man3/strtok.3 | 2 +-
13 files changed, 22 insertions(+), 22 deletions(-)
--
2.45.2
^ permalink raw reply [flat|nested] 19+ messages in thread
* [PATCH 01/11] exec.3: fix section reference
2024-06-16 1:18 [PATCH 00/11] man3: fix wrong/non-existent section references Kir Kolyshkin
@ 2024-06-16 1:18 ` Kir Kolyshkin
2024-06-16 1:18 ` [PATCH 02/11] posix_fallocate.3: fix section references Kir Kolyshkin
` (10 subsequent siblings)
11 siblings, 0 replies; 19+ messages in thread
From: Kir Kolyshkin @ 2024-06-16 1:18 UTC (permalink / raw
To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man
There is a reference to NOTES section, which no longer exists since
the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY:
Reorganize sections").
Fixes: 4131356cd
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
man/man3/exec.3 | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/man/man3/exec.3 b/man/man3/exec.3
index 0ff3b1f48..29e11e3aa 100644
--- a/man/man3/exec.3
+++ b/man/man3/exec.3
@@ -120,7 +120,7 @@ .SS p - execlp(), execvp(), execvpe()
.I confstr(_CS_PATH)
(which typically returns the value "/bin:/usr/bin")
and possibly also the current working directory;
-see NOTES for further details.
+see VERSIONS for further details.
.P
.BR execvpe ()
searches for the program using the value of
--
2.45.2
^ permalink raw reply related [flat|nested] 19+ messages in thread
* [PATCH 02/11] posix_fallocate.3: fix section references
2024-06-16 1:18 [PATCH 00/11] man3: fix wrong/non-existent section references Kir Kolyshkin
2024-06-16 1:18 ` [PATCH 01/11] exec.3: fix section reference Kir Kolyshkin
@ 2024-06-16 1:18 ` Kir Kolyshkin
2024-06-16 1:18 ` [PATCH 03/11] floor.3: fix section reference Kir Kolyshkin
` (9 subsequent siblings)
11 siblings, 0 replies; 19+ messages in thread
From: Kir Kolyshkin @ 2024-06-16 1:18 UTC (permalink / raw
To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man
There are references to NOTES section, which no longer exists since
the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY:
Reorganize sections").
Fixes: 4131356cd
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
man/man3/posix_fallocate.3 | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/man/man3/posix_fallocate.3 b/man/man3/posix_fallocate.3
index 46ce6ac7f..7222b6232 100644
--- a/man/man3/posix_fallocate.3
+++ b/man/man3/posix_fallocate.3
@@ -86,7 +86,7 @@ .SH ERRORS
.I fd
does not support this operation.
This error code can be returned by C libraries that don't perform the
-emulation shown in NOTES, such as musl libc.
+emulation shown in CAVEATS, such as musl libc.
.TP
.B ESPIPE
.I fd
@@ -106,7 +106,7 @@ .SH ATTRIBUTES
T} Thread safety T{
.na
.nh
-MT-Safe (but see NOTES)
+MT-Safe (but see CAVEATS)
T}
.TE
.SH STANDARDS
--
2.45.2
^ permalink raw reply related [flat|nested] 19+ messages in thread
* [PATCH 03/11] floor.3: fix section reference
2024-06-16 1:18 [PATCH 00/11] man3: fix wrong/non-existent section references Kir Kolyshkin
2024-06-16 1:18 ` [PATCH 01/11] exec.3: fix section reference Kir Kolyshkin
2024-06-16 1:18 ` [PATCH 02/11] posix_fallocate.3: fix section references Kir Kolyshkin
@ 2024-06-16 1:18 ` Kir Kolyshkin
2024-06-16 10:07 ` Alejandro Colomar
2024-06-16 1:18 ` [PATCH 04/11] ceil.3,rint.3,round.3: rm NOTES section Kir Kolyshkin
` (8 subsequent siblings)
11 siblings, 1 reply; 19+ messages in thread
From: Kir Kolyshkin @ 2024-06-16 1:18 UTC (permalink / raw
To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man
There is a reference to NOTES section, which no longer exists since
the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY:
Reorganize sections").
Fixes: 4131356cd
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
man/man3/floor.3 | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/man/man3/floor.3 b/man/man3/floor.3
index 2df4489ba..f4b6ac0b8 100644
--- a/man/man3/floor.3
+++ b/man/man3/floor.3
@@ -52,7 +52,7 @@ .SH RETURN VALUE
itself is returned.
.SH ERRORS
No errors occur.
-POSIX.1-2001 documents a range error for overflows, but see NOTES.
+POSIX.1-2001 documents a range error for overflows, but see HISTORY.
.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
--
2.45.2
^ permalink raw reply related [flat|nested] 19+ messages in thread
* [PATCH 04/11] ceil.3,rint.3,round.3: rm NOTES section
2024-06-16 1:18 [PATCH 00/11] man3: fix wrong/non-existent section references Kir Kolyshkin
` (2 preceding siblings ...)
2024-06-16 1:18 ` [PATCH 03/11] floor.3: fix section reference Kir Kolyshkin
@ 2024-06-16 1:18 ` Kir Kolyshkin
2024-06-16 1:18 ` [PATCH 05/11] getdtablesize.3: fix section reference Kir Kolyshkin
` (7 subsequent siblings)
11 siblings, 0 replies; 19+ messages in thread
From: Kir Kolyshkin @ 2024-06-16 1:18 UTC (permalink / raw
To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man
Commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY:
Reorganize sections") removed the NOTES section from floor(3), moving
the explanation of overflow errors to HISTORY.
The very same explanation is also there in ceil(3), rint(3), and
round(3). Let's move it to HISTORY as well, for uniformity.
Fixes: 4131356cd
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
man/man3/ceil.3 | 4 ++--
man/man3/rint.3 | 4 ++--
man/man3/round.3 | 4 ++--
3 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/man/man3/ceil.3 b/man/man3/ceil.3
index 197920616..22d9e351f 100644
--- a/man/man3/ceil.3
+++ b/man/man3/ceil.3
@@ -53,7 +53,7 @@ .SH RETURN VALUE
itself is returned.
.SH ERRORS
No errors occur.
-POSIX.1-2001 documents a range error for overflows, but see NOTES.
+POSIX.1-2001 documents a range error for overflows, but see HISTORY.
.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
@@ -79,7 +79,7 @@ .SH HISTORY
.I double
also conforms to
SVr4, 4.3BSD, C89.
-.SH NOTES
+.P
SUSv2 and POSIX.1-2001 contain text about overflow (which might set
.I errno
to
diff --git a/man/man3/rint.3 b/man/man3/rint.3
index 262670571..8095e68ce 100644
--- a/man/man3/rint.3
+++ b/man/man3/rint.3
@@ -91,7 +91,7 @@ .SH RETURN VALUE
itself is returned.
.SH ERRORS
No errors occur.
-POSIX.1-2001 documents a range error for overflows, but see NOTES.
+POSIX.1-2001 documents a range error for overflows, but see HISTORY.
.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
@@ -115,7 +115,7 @@ .SH STANDARDS
C11, POSIX.1-2008.
.SH HISTORY
C99, POSIX.1-2001.
-.SH NOTES
+.P
SUSv2 and POSIX.1-2001 contain text about overflow (which might set
.I errno
to
diff --git a/man/man3/round.3 b/man/man3/round.3
index 268ec083c..1dd086e3c 100644
--- a/man/man3/round.3
+++ b/man/man3/round.3
@@ -56,7 +56,7 @@ .SH RETURN VALUE
itself is returned.
.SH ERRORS
No errors occur.
-POSIX.1-2001 documents a range error for overflows, but see NOTES.
+POSIX.1-2001 documents a range error for overflows, but see HISTORY.
.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
@@ -78,7 +78,7 @@ .SH STANDARDS
.SH HISTORY
glibc 2.1.
C99, POSIX.1-2001.
-.SH NOTES
+.P
POSIX.1-2001 contains text about overflow (which might set
.I errno
to
--
2.45.2
^ permalink raw reply related [flat|nested] 19+ messages in thread
* [PATCH 05/11] getdtablesize.3: fix section reference
2024-06-16 1:18 [PATCH 00/11] man3: fix wrong/non-existent section references Kir Kolyshkin
` (3 preceding siblings ...)
2024-06-16 1:18 ` [PATCH 04/11] ceil.3,rint.3,round.3: rm NOTES section Kir Kolyshkin
@ 2024-06-16 1:18 ` Kir Kolyshkin
2024-06-16 1:18 ` [PATCH 06/11] readdir.3: fix section references Kir Kolyshkin
` (6 subsequent siblings)
11 siblings, 0 replies; 19+ messages in thread
From: Kir Kolyshkin @ 2024-06-16 1:18 UTC (permalink / raw
To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man
There is a reference to NOTES section, which no longer exists since
the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY:
Reorganize sections").
Fixes: 4131356cd
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
man/man3/getdtablesize.3 | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/man/man3/getdtablesize.3 b/man/man3/getdtablesize.3
index 9482886f7..032514530 100644
--- a/man/man3/getdtablesize.3
+++ b/man/man3/getdtablesize.3
@@ -44,7 +44,7 @@ .SH ERRORS
.BR getdtablesize ()
can return any of the errors described for
.BR getrlimit (2);
-see NOTES below.
+see VERSIONS below.
.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
--
2.45.2
^ permalink raw reply related [flat|nested] 19+ messages in thread
* [PATCH 06/11] readdir.3: fix section references
2024-06-16 1:18 [PATCH 00/11] man3: fix wrong/non-existent section references Kir Kolyshkin
` (4 preceding siblings ...)
2024-06-16 1:18 ` [PATCH 05/11] getdtablesize.3: fix section reference Kir Kolyshkin
@ 2024-06-16 1:18 ` Kir Kolyshkin
2024-06-16 10:44 ` Alejandro Colomar
2024-06-16 1:19 ` [PATCH 07/11] setjmp.3: fix " Kir Kolyshkin
` (5 subsequent siblings)
11 siblings, 1 reply; 19+ messages in thread
From: Kir Kolyshkin @ 2024-06-16 1:18 UTC (permalink / raw
To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man
There are references to NOTES section, which no longer exists since
the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY:
Reorganize sections").
While at it, unify the "see XXX" style.
Fixes: 4131356cd
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
man/man3/readdir.3 | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/man/man3/readdir.3 b/man/man3/readdir.3
index 731e25c85..094f21080 100644
--- a/man/man3/readdir.3
+++ b/man/man3/readdir.3
@@ -59,7 +59,7 @@ .SH DESCRIPTION
and
.IR d_ino .
The other fields are unstandardized, and not present on all systems;
-see NOTES below for some further details.
+see VERSIONS.
.P
The fields of the
.I dirent
@@ -85,7 +85,7 @@ .SH DESCRIPTION
.I d_reclen
This is the size (in bytes) of the returned record.
This may not match the size of the structure definition shown above;
-see NOTES.
+see VERSIONS.
.TP
.I d_type
This field contains a value indicating the file type,
@@ -137,8 +137,8 @@ .SH DESCRIPTION
.BR DT_UNKNOWN .
.TP
.I d_name
-This field contains the null terminated filename.
-.IR "See NOTES" .
+This field contains the null terminated filename;
+see VERSIONS.
.P
The data returned by
.BR readdir ()
--
2.45.2
^ permalink raw reply related [flat|nested] 19+ messages in thread
* [PATCH 07/11] setjmp.3: fix section references
2024-06-16 1:18 [PATCH 00/11] man3: fix wrong/non-existent section references Kir Kolyshkin
` (5 preceding siblings ...)
2024-06-16 1:18 ` [PATCH 06/11] readdir.3: fix section references Kir Kolyshkin
@ 2024-06-16 1:19 ` Kir Kolyshkin
2024-06-16 10:47 ` Alejandro Colomar
2024-06-16 1:19 ` [PATCH 08/11] sigpause.3: fix section reference Kir Kolyshkin
` (4 subsequent siblings)
11 siblings, 1 reply; 19+ messages in thread
From: Kir Kolyshkin @ 2024-06-16 1:19 UTC (permalink / raw
To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man
Commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY:
Reorganize sections") results in a few problems with setjmp(3):
1. "Feature Test Macro Requirements for glibc" refers to NOTES, while
those macros are now described in HISTORY.
2. The discussion about saving signal mask is now split between HISTORY
and NOTES.
To fix all this, let's remove NOTES and fix references to point to
HISTORY.
Fixes: 4131356cd
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
man/man3/setjmp.3 | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/man/man3/setjmp.3 b/man/man3/setjmp.3
index 2319feb47..1403d6ba7 100644
--- a/man/man3/setjmp.3
+++ b/man/man3/setjmp.3
@@ -26,7 +26,7 @@ .SH SYNOPSIS
.RE
.P
.BR setjmp ():
-see NOTES.
+see HISTORY.
.P
.BR sigsetjmp ():
.nf
@@ -65,7 +65,7 @@ .SH DESCRIPTION
was called and to restore ("rewind") the stack to its state at the time of the
.BR setjmp ()
call.
-In addition, and depending on the implementation (see NOTES),
+In addition, and depending on the implementation (see HISTORY),
the values of some other registers and the process signal mask
may be restored to their state at the time of the
.BR setjmp ()
@@ -201,7 +201,7 @@ .SH HISTORY
with a nonzero
.I savesigs
argument.
-.SH NOTES
+.P
.BR setjmp ()
and
.BR longjmp ()
--
2.45.2
^ permalink raw reply related [flat|nested] 19+ messages in thread
* [PATCH 08/11] sigpause.3: fix section reference
2024-06-16 1:18 [PATCH 00/11] man3: fix wrong/non-existent section references Kir Kolyshkin
` (6 preceding siblings ...)
2024-06-16 1:19 ` [PATCH 07/11] setjmp.3: fix " Kir Kolyshkin
@ 2024-06-16 1:19 ` Kir Kolyshkin
2024-06-16 1:19 ` [PATCH 09/11] stailq.3: " Kir Kolyshkin
` (3 subsequent siblings)
11 siblings, 0 replies; 19+ messages in thread
From: Kir Kolyshkin @ 2024-06-16 1:19 UTC (permalink / raw
To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man
There is a reference to NOTES section, which no longer exists since
the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY:
Reorganize sections").
Currently, the relevant information is kind of split between VERSIONS
and HISTORY, so it's not very clear to which section refer to. My guess
is VERSIONS is somewhat more relevant.
Fixes: 4131356cd
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
man/man3/sigpause.3 | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/man/man3/sigpause.3 b/man/man3/sigpause.3
index 7c1d78d3f..060562a87 100644
--- a/man/man3/sigpause.3
+++ b/man/man3/sigpause.3
@@ -13,7 +13,7 @@ .SH SYNOPSIS
.nf
.B #include <signal.h>
.P
-.BI "[[deprecated]] int sigpause(int " sigmask "); /* BSD (but see NOTES) */"
+.BI "[[deprecated]] int sigpause(int " sigmask "); /* BSD (but see VERSIONS) */"
.P
.BI "[[deprecated]] int sigpause(int " sig "); /* POSIX.1 / SysV / UNIX 95 */"
.fi
--
2.45.2
^ permalink raw reply related [flat|nested] 19+ messages in thread
* [PATCH 09/11] stailq.3: fix section reference
2024-06-16 1:18 [PATCH 00/11] man3: fix wrong/non-existent section references Kir Kolyshkin
` (7 preceding siblings ...)
2024-06-16 1:19 ` [PATCH 08/11] sigpause.3: fix section reference Kir Kolyshkin
@ 2024-06-16 1:19 ` Kir Kolyshkin
2024-06-16 1:19 ` [PATCH 10/11] strtok.3: " Kir Kolyshkin
` (2 subsequent siblings)
11 siblings, 0 replies; 19+ messages in thread
From: Kir Kolyshkin @ 2024-06-16 1:19 UTC (permalink / raw
To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man
There is a reference to NOTES section, which no longer exists since
the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY:
Reorganize sections").
Fixes: 4131356cd
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
man/man3/stailq.3 | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/man/man3/stailq.3 b/man/man3/stailq.3
index eca802cbd..c4dbf9450 100644
--- a/man/man3/stailq.3
+++ b/man/man3/stailq.3
@@ -96,7 +96,7 @@ .SH SYNOPSIS
.\" .BI " STAILQ_ENTRY " NAME );
.fi
.IR Note :
-Identical macros prefixed with SIMPLEQ instead of STAILQ exist; see NOTES.
+Identical macros prefixed with SIMPLEQ instead of STAILQ exist; see VERSIONS.
.SH DESCRIPTION
These macros define and operate on singly linked tail queues.
.P
--
2.45.2
^ permalink raw reply related [flat|nested] 19+ messages in thread
* [PATCH 10/11] strtok.3: fix section reference
2024-06-16 1:18 [PATCH 00/11] man3: fix wrong/non-existent section references Kir Kolyshkin
` (8 preceding siblings ...)
2024-06-16 1:19 ` [PATCH 09/11] stailq.3: " Kir Kolyshkin
@ 2024-06-16 1:19 ` Kir Kolyshkin
2024-06-16 1:19 ` [PATCH 11/11] strtod.3: fix wrong " Kir Kolyshkin
2024-06-16 11:08 ` [PATCH 00/11] man3: fix wrong/non-existent section references Alejandro Colomar
11 siblings, 0 replies; 19+ messages in thread
From: Kir Kolyshkin @ 2024-06-16 1:19 UTC (permalink / raw
To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man
There is a reference to NOTES section, which no longer exists since
the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY:
Reorganize sections").
Fixes: 4131356cd
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
man/man3/strtok.3 | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/man/man3/strtok.3 b/man/man3/strtok.3
index 34a90198c..ee9179d5f 100644
--- a/man/man3/strtok.3
+++ b/man/man3/strtok.3
@@ -131,7 +131,7 @@ .SH DESCRIPTION
.I str
should point to the string to be parsed, and the value of
.I *saveptr
-is ignored (but see NOTES).
+is ignored (but see VERSIONS).
In subsequent calls,
.I str
should be NULL, and
--
2.45.2
^ permalink raw reply related [flat|nested] 19+ messages in thread
* [PATCH 11/11] strtod.3: fix wrong section reference
2024-06-16 1:18 [PATCH 00/11] man3: fix wrong/non-existent section references Kir Kolyshkin
` (9 preceding siblings ...)
2024-06-16 1:19 ` [PATCH 10/11] strtok.3: " Kir Kolyshkin
@ 2024-06-16 1:19 ` Kir Kolyshkin
2024-06-16 11:08 ` [PATCH 00/11] man3: fix wrong/non-existent section references Alejandro Colomar
11 siblings, 0 replies; 19+ messages in thread
From: Kir Kolyshkin @ 2024-06-16 1:19 UTC (permalink / raw
To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man
Since the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY:
Reorganize sections"), the discussion about n-char-sequence refers to
NOTES, while the relevant information is now in VERSIONS.
Fixes: 4131356cd
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
man/man3/strtod.3 | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/man/man3/strtod.3 b/man/man3/strtod.3
index fdcf5574b..9ddd21eea 100644
--- a/man/man3/strtod.3
+++ b/man/man3/strtod.3
@@ -94,7 +94,7 @@ .SH DESCRIPTION
where
.I n-char-sequence
specifies in an implementation-dependent
-way the type of NAN (see NOTES).
+way the type of NAN (see VERSIONS).
.SH RETURN VALUE
These functions return the converted value, if any.
.P
--
2.45.2
^ permalink raw reply related [flat|nested] 19+ messages in thread
* Re: [PATCH 03/11] floor.3: fix section reference
2024-06-16 1:18 ` [PATCH 03/11] floor.3: fix section reference Kir Kolyshkin
@ 2024-06-16 10:07 ` Alejandro Colomar
0 siblings, 0 replies; 19+ messages in thread
From: Alejandro Colomar @ 2024-06-16 10:07 UTC (permalink / raw
To: Kir Kolyshkin; +Cc: linux-man
[-- Attachment #1: Type: text/plain, Size: 1320 bytes --]
Hi Kir,
On Sat, Jun 15, 2024 at 06:18:56PM GMT, Kir Kolyshkin wrote:
> There is a reference to NOTES section, which no longer exists since
> the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY:
> Reorganize sections").
>
> Fixes: 4131356cd
> Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
Thanks for the patch. In this page, I've noticed that we can remove the
reference, since POSIX.1-2008 doesn't have that problem any more. I've
applied an alternative patch instead:
<https://www.alejandro-colomar.es/src/alx/linux/man-pages/man-pages.git/commit/?h=contrib&id=c3049eef0ad06131609bb16a94475778f737b8c8>
Have a lovely day!
Alex
> ---
> man/man3/floor.3 | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/man/man3/floor.3 b/man/man3/floor.3
> index 2df4489ba..f4b6ac0b8 100644
> --- a/man/man3/floor.3
> +++ b/man/man3/floor.3
> @@ -52,7 +52,7 @@ .SH RETURN VALUE
> itself is returned.
> .SH ERRORS
> No errors occur.
> -POSIX.1-2001 documents a range error for overflows, but see NOTES.
> +POSIX.1-2001 documents a range error for overflows, but see HISTORY.
> .SH ATTRIBUTES
> For an explanation of the terms used in this section, see
> .BR attributes (7).
> --
> 2.45.2
>
--
<https://www.alejandro-colomar.es/>
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [PATCH 06/11] readdir.3: fix section references
2024-06-16 1:18 ` [PATCH 06/11] readdir.3: fix section references Kir Kolyshkin
@ 2024-06-16 10:44 ` Alejandro Colomar
2024-06-16 20:13 ` [PATCH v2 06/11] readdir.3: fix wrong " Kir Kolyshkin
0 siblings, 1 reply; 19+ messages in thread
From: Alejandro Colomar @ 2024-06-16 10:44 UTC (permalink / raw
To: Kir Kolyshkin; +Cc: linux-man
[-- Attachment #1: Type: text/plain, Size: 1657 bytes --]
Hi Kir,
On Sat, Jun 15, 2024 at 06:18:59PM GMT, Kir Kolyshkin wrote:
> There are references to NOTES section, which no longer exists since
> the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY:
> Reorganize sections").
Hmmm, in this case, there's still a NOTES section. It's smaller, but
still exists. This text will need to be different.
Have a lovely day!
Alex
>
> While at it, unify the "see XXX" style.
>
> Fixes: 4131356cd
> Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
> ---
> man/man3/readdir.3 | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/man/man3/readdir.3 b/man/man3/readdir.3
> index 731e25c85..094f21080 100644
> --- a/man/man3/readdir.3
> +++ b/man/man3/readdir.3
> @@ -59,7 +59,7 @@ .SH DESCRIPTION
> and
> .IR d_ino .
> The other fields are unstandardized, and not present on all systems;
> -see NOTES below for some further details.
> +see VERSIONS.
> .P
> The fields of the
> .I dirent
> @@ -85,7 +85,7 @@ .SH DESCRIPTION
> .I d_reclen
> This is the size (in bytes) of the returned record.
> This may not match the size of the structure definition shown above;
> -see NOTES.
> +see VERSIONS.
> .TP
> .I d_type
> This field contains a value indicating the file type,
> @@ -137,8 +137,8 @@ .SH DESCRIPTION
> .BR DT_UNKNOWN .
> .TP
> .I d_name
> -This field contains the null terminated filename.
> -.IR "See NOTES" .
> +This field contains the null terminated filename;
> +see VERSIONS.
> .P
> The data returned by
> .BR readdir ()
> --
> 2.45.2
>
--
<https://www.alejandro-colomar.es/>
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [PATCH 07/11] setjmp.3: fix section references
2024-06-16 1:19 ` [PATCH 07/11] setjmp.3: fix " Kir Kolyshkin
@ 2024-06-16 10:47 ` Alejandro Colomar
2024-06-16 20:19 ` [PATCH v2 " Kir Kolyshkin
0 siblings, 1 reply; 19+ messages in thread
From: Alejandro Colomar @ 2024-06-16 10:47 UTC (permalink / raw
To: Kir Kolyshkin; +Cc: linux-man
[-- Attachment #1: Type: text/plain, Size: 1774 bytes --]
Hi Kir,
On Sat, Jun 15, 2024 at 06:19:00PM GMT, Kir Kolyshkin wrote:
> Commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY:
> Reorganize sections") results in a few problems with setjmp(3):
>
> 1. "Feature Test Macro Requirements for glibc" refers to NOTES, while
> those macros are now described in HISTORY.
>
> 2. The discussion about saving signal mask is now split between HISTORY
> and NOTES.
>
> To fix all this, let's remove NOTES and fix references to point to
> HISTORY.
>
> Fixes: 4131356cd
> Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
> ---
> man/man3/setjmp.3 | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/man/man3/setjmp.3 b/man/man3/setjmp.3
> index 2319feb47..1403d6ba7 100644
> --- a/man/man3/setjmp.3
> +++ b/man/man3/setjmp.3
> @@ -26,7 +26,7 @@ .SH SYNOPSIS
> .RE
> .P
> .BR setjmp ():
> -see NOTES.
> +see HISTORY.
> .P
> .BR sigsetjmp ():
> .nf
> @@ -65,7 +65,7 @@ .SH DESCRIPTION
> was called and to restore ("rewind") the stack to its state at the time of the
> .BR setjmp ()
> call.
> -In addition, and depending on the implementation (see NOTES),
> +In addition, and depending on the implementation (see HISTORY),
> the values of some other registers and the process signal mask
> may be restored to their state at the time of the
> .BR setjmp ()
> @@ -201,7 +201,7 @@ .SH HISTORY
> with a nonzero
> .I savesigs
> argument.
> -.SH NOTES
> +.P
But the paragraph below is not about HISTORY. It's current stuff (which
is why I kept it). How about saying "see NOTES and HISTORY"?
Cheers,
Alex
> .BR setjmp ()
> and
> .BR longjmp ()
> --
> 2.45.2
>
--
<https://www.alejandro-colomar.es/>
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [PATCH 00/11] man3: fix wrong/non-existent section references
2024-06-16 1:18 [PATCH 00/11] man3: fix wrong/non-existent section references Kir Kolyshkin
` (10 preceding siblings ...)
2024-06-16 1:19 ` [PATCH 11/11] strtod.3: fix wrong " Kir Kolyshkin
@ 2024-06-16 11:08 ` Alejandro Colomar
11 siblings, 0 replies; 19+ messages in thread
From: Alejandro Colomar @ 2024-06-16 11:08 UTC (permalink / raw
To: Kir Kolyshkin; +Cc: linux-man
[-- Attachment #1: Type: text/plain, Size: 2016 bytes --]
Hi Kir,
On Sat, Jun 15, 2024 at 06:18:53PM GMT, Kir Kolyshkin wrote:
> Commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY:
> Reorganize sections") results in many wrong section references.
>
> Mostly, this is about references to no-longer-existent section NOTES,
> but there are some other issues as well, such as references to a wrong
> section, or a discussion which is now split in between two sections,
> etc.
>
> This patch series tries to fix some of these issues in man3 section
> only (I haven't checked other section numbers).
>
> Found accidentally when reading exec(3).
Thanks for the patches!
> Kir Kolyshkin (11):
> exec.3: fix section reference
> posix_fallocate.3: fix section references
> floor.3: fix section reference
> ceil.3,rint.3,round.3: rm NOTES section
> getdtablesize.3: fix section reference
> readdir.3: fix section references
> setjmp.3: fix section references
> sigpause.3: fix section reference
> stailq.3: fix section reference
> strtok.3: fix section reference
> strtod.3: fix wrong section reference
I've applied the following patches:
01, 02, 04, 05, 08, 09, 10, 11
I've applied an alternative patch to 03, so it's no longer needed.
Patches 06 and 07 need some more work, and I've provided comments on
each of them.
Have a lovely day!
Alex
>
> man/man3/ceil.3 | 4 ++--
> man/man3/exec.3 | 2 +-
> man/man3/floor.3 | 2 +-
> man/man3/getdtablesize.3 | 2 +-
> man/man3/posix_fallocate.3 | 4 ++--
> man/man3/readdir.3 | 8 ++++----
> man/man3/rint.3 | 4 ++--
> man/man3/round.3 | 4 ++--
> man/man3/setjmp.3 | 6 +++---
> man/man3/sigpause.3 | 2 +-
> man/man3/stailq.3 | 2 +-
> man/man3/strtod.3 | 2 +-
> man/man3/strtok.3 | 2 +-
> 13 files changed, 22 insertions(+), 22 deletions(-)
>
> --
> 2.45.2
>
>
--
<https://www.alejandro-colomar.es/>
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
^ permalink raw reply [flat|nested] 19+ messages in thread
* [PATCH v2 06/11] readdir.3: fix wrong section references
2024-06-16 10:44 ` Alejandro Colomar
@ 2024-06-16 20:13 ` Kir Kolyshkin
0 siblings, 0 replies; 19+ messages in thread
From: Kir Kolyshkin @ 2024-06-16 20:13 UTC (permalink / raw
To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man
There are references to NOTES section, but since the commit 4131356cd
("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize
sections") the relevant information is in VERSIONS.
While at it, unify the "see XXX" style.
Fixes: 4131356cd
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
man/man3/readdir.3 | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/man/man3/readdir.3 b/man/man3/readdir.3
index 731e25c85..094f21080 100644
--- a/man/man3/readdir.3
+++ b/man/man3/readdir.3
@@ -59,7 +59,7 @@ .SH DESCRIPTION
and
.IR d_ino .
The other fields are unstandardized, and not present on all systems;
-see NOTES below for some further details.
+see VERSIONS.
.P
The fields of the
.I dirent
@@ -85,7 +85,7 @@ .SH DESCRIPTION
.I d_reclen
This is the size (in bytes) of the returned record.
This may not match the size of the structure definition shown above;
-see NOTES.
+see VERSIONS.
.TP
.I d_type
This field contains a value indicating the file type,
@@ -137,8 +137,8 @@ .SH DESCRIPTION
.BR DT_UNKNOWN .
.TP
.I d_name
-This field contains the null terminated filename.
-.IR "See NOTES" .
+This field contains the null terminated filename;
+see VERSIONS.
.P
The data returned by
.BR readdir ()
--
2.45.2
^ permalink raw reply related [flat|nested] 19+ messages in thread
* [PATCH v2 07/11] setjmp.3: fix section references
2024-06-16 10:47 ` Alejandro Colomar
@ 2024-06-16 20:19 ` Kir Kolyshkin
2024-06-16 20:43 ` Alejandro Colomar
0 siblings, 1 reply; 19+ messages in thread
From: Kir Kolyshkin @ 2024-06-16 20:19 UTC (permalink / raw
To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man
Commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY:
Reorganize sections") results in a few problems with setjmp(3):
1. "Feature Test Macro Requirements for glibc" refers to NOTES, while
those macros are now described in HISTORY.
2. The discussion about saving signal mask is now split between HISTORY
and NOTES.
Fix the references accordingly.
Fixes: 4131356cd
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
man/man3/setjmp.3 | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/man/man3/setjmp.3 b/man/man3/setjmp.3
index 2319feb47..39511e49d 100644
--- a/man/man3/setjmp.3
+++ b/man/man3/setjmp.3
@@ -26,7 +26,7 @@ .SH SYNOPSIS
.RE
.P
.BR setjmp ():
-see NOTES.
+see HISTORY.
.P
.BR sigsetjmp ():
.nf
@@ -65,7 +65,7 @@ .SH DESCRIPTION
was called and to restore ("rewind") the stack to its state at the time of the
.BR setjmp ()
call.
-In addition, and depending on the implementation (see NOTES),
+In addition, and depending on the implementation (see NOTES and HISTORY),
the values of some other registers and the process signal mask
may be restored to their state at the time of the
.BR setjmp ()
--
2.45.2
^ permalink raw reply related [flat|nested] 19+ messages in thread
* Re: [PATCH v2 07/11] setjmp.3: fix section references
2024-06-16 20:19 ` [PATCH v2 " Kir Kolyshkin
@ 2024-06-16 20:43 ` Alejandro Colomar
0 siblings, 0 replies; 19+ messages in thread
From: Alejandro Colomar @ 2024-06-16 20:43 UTC (permalink / raw
To: Kir Kolyshkin; +Cc: linux-man
[-- Attachment #1: Type: text/plain, Size: 1527 bytes --]
Hi Kir,
On Sun, Jun 16, 2024 at 01:19:45PM GMT, Kir Kolyshkin wrote:
> Commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY:
> Reorganize sections") results in a few problems with setjmp(3):
>
> 1. "Feature Test Macro Requirements for glibc" refers to NOTES, while
> those macros are now described in HISTORY.
>
> 2. The discussion about saving signal mask is now split between HISTORY
> and NOTES.
>
> Fix the references accordingly.
>
> Fixes: 4131356cd
> Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
I've applied both v2 06 and 07. Thanks for the revised patches.
Have a lovely night!
Alex
> ---
> man/man3/setjmp.3 | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/man/man3/setjmp.3 b/man/man3/setjmp.3
> index 2319feb47..39511e49d 100644
> --- a/man/man3/setjmp.3
> +++ b/man/man3/setjmp.3
> @@ -26,7 +26,7 @@ .SH SYNOPSIS
> .RE
> .P
> .BR setjmp ():
> -see NOTES.
> +see HISTORY.
> .P
> .BR sigsetjmp ():
> .nf
> @@ -65,7 +65,7 @@ .SH DESCRIPTION
> was called and to restore ("rewind") the stack to its state at the time of the
> .BR setjmp ()
> call.
> -In addition, and depending on the implementation (see NOTES),
> +In addition, and depending on the implementation (see NOTES and HISTORY),
> the values of some other registers and the process signal mask
> may be restored to their state at the time of the
> .BR setjmp ()
> --
> 2.45.2
>
--
<https://www.alejandro-colomar.es/>
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
^ permalink raw reply [flat|nested] 19+ messages in thread
end of thread, other threads:[~2024-06-16 20:43 UTC | newest]
Thread overview: 19+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-06-16 1:18 [PATCH 00/11] man3: fix wrong/non-existent section references Kir Kolyshkin
2024-06-16 1:18 ` [PATCH 01/11] exec.3: fix section reference Kir Kolyshkin
2024-06-16 1:18 ` [PATCH 02/11] posix_fallocate.3: fix section references Kir Kolyshkin
2024-06-16 1:18 ` [PATCH 03/11] floor.3: fix section reference Kir Kolyshkin
2024-06-16 10:07 ` Alejandro Colomar
2024-06-16 1:18 ` [PATCH 04/11] ceil.3,rint.3,round.3: rm NOTES section Kir Kolyshkin
2024-06-16 1:18 ` [PATCH 05/11] getdtablesize.3: fix section reference Kir Kolyshkin
2024-06-16 1:18 ` [PATCH 06/11] readdir.3: fix section references Kir Kolyshkin
2024-06-16 10:44 ` Alejandro Colomar
2024-06-16 20:13 ` [PATCH v2 06/11] readdir.3: fix wrong " Kir Kolyshkin
2024-06-16 1:19 ` [PATCH 07/11] setjmp.3: fix " Kir Kolyshkin
2024-06-16 10:47 ` Alejandro Colomar
2024-06-16 20:19 ` [PATCH v2 " Kir Kolyshkin
2024-06-16 20:43 ` Alejandro Colomar
2024-06-16 1:19 ` [PATCH 08/11] sigpause.3: fix section reference Kir Kolyshkin
2024-06-16 1:19 ` [PATCH 09/11] stailq.3: " Kir Kolyshkin
2024-06-16 1:19 ` [PATCH 10/11] strtok.3: " Kir Kolyshkin
2024-06-16 1:19 ` [PATCH 11/11] strtod.3: fix wrong " Kir Kolyshkin
2024-06-16 11:08 ` [PATCH 00/11] man3: fix wrong/non-existent section references Alejandro Colomar
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).