Linux-man Archive mirror
 help / color / mirror / Atom feed
* [PATCH 00/16] man2: fix wrong/non-existent section references
@ 2024-06-17 23:10 Kir Kolyshkin
  2024-06-17 23:10 ` [PATCH 01/16] cacheflush.2: fix section reference Kir Kolyshkin
                   ` (16 more replies)
  0 siblings, 17 replies; 21+ messages in thread
From: Kir Kolyshkin @ 2024-06-17 23:10 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.

This patch series tries to fix some of these issues in man2 section
which I was able to find.

*** BLURB HERE ***

Kir Kolyshkin (16):
  cacheflush.2: fix section reference
  clone.2: fix wrong section reference
  execve.2: fix wrong section reference
  gethostname.2: fix section reference
  getpriority.2: move info from NOTES to HISTORY
  gettimeofday.2: fix wrong section reference
  ioperm.2: fix wrong section reference
  kill.2: fix wrong section reference
  mkdir.2: fix wrong section reference
  mmap.2: fix wrong section reference
  nice.2: fix wrong section reference
  open.2: fix wrong section reference
  readdir.2: fix wrong section reference
  semctl.2: fix wrong section reference
  uname.2: fix wrong section reference
  wait.2: fix wrong section reference

 man/man2/cacheflush.2   |  2 +-
 man/man2/clone.2        |  2 +-
 man/man2/execve.2       |  2 +-
 man/man2/gethostname.2  |  2 +-
 man/man2/getpriority.2  | 32 ++++++++++++++++----------------
 man/man2/gettimeofday.2 |  2 +-
 man/man2/ioperm.2       |  2 +-
 man/man2/kill.2         |  2 +-
 man/man2/mkdir.2        |  2 +-
 man/man2/mmap.2         |  2 +-
 man/man2/nice.2         |  2 +-
 man/man2/open.2         |  4 ++--
 man/man2/readdir.2      |  2 +-
 man/man2/semctl.2       |  2 +-
 man/man2/uname.2        |  2 +-
 man/man2/wait.2         |  2 +-
 16 files changed, 32 insertions(+), 32 deletions(-)

-- 
2.45.2


^ permalink raw reply	[flat|nested] 21+ messages in thread

* [PATCH 01/16] cacheflush.2: fix section reference
  2024-06-17 23:10 [PATCH 00/16] man2: fix wrong/non-existent section references Kir Kolyshkin
@ 2024-06-17 23:10 ` Kir Kolyshkin
  2024-06-17 23:10 ` [PATCH 02/16] clone.2: fix wrong " Kir Kolyshkin
                   ` (15 subsequent siblings)
  16 siblings, 0 replies; 21+ messages in thread
From: Kir Kolyshkin @ 2024-06-17 23:10 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 ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections")
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
 man/man2/cacheflush.2 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/man/man2/cacheflush.2 b/man/man2/cacheflush.2
index bc38355e6..0e3b4ac62 100644
--- a/man/man2/cacheflush.2
+++ b/man/man2/cacheflush.2
@@ -18,7 +18,7 @@ .SH SYNOPSIS
 .P
 .IR Note :
 On some architectures,
-there is no glibc wrapper for this system call; see NOTES.
+there is no glibc wrapper for this system call; see VERSIONS.
 .SH DESCRIPTION
 .BR cacheflush ()
 flushes the contents of the indicated cache(s) for the
-- 
2.45.2


^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [PATCH 02/16] clone.2: fix wrong section reference
  2024-06-17 23:10 [PATCH 00/16] man2: fix wrong/non-existent section references Kir Kolyshkin
  2024-06-17 23:10 ` [PATCH 01/16] cacheflush.2: fix section reference Kir Kolyshkin
@ 2024-06-17 23:10 ` Kir Kolyshkin
  2024-06-17 23:10 ` [PATCH 03/16] execve.2: " Kir Kolyshkin
                   ` (14 subsequent siblings)
  16 siblings, 0 replies; 21+ messages in thread
From: Kir Kolyshkin @ 2024-06-17 23:10 UTC (permalink / raw
  To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man

The man page says:

> For the prototype of the raw clone() system call, see NOTES

Since the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS,
HISTORY: Reorganize sections"), this prototype is in VERSIONS.

Fixes: 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections")
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
 man/man2/clone.2 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/man/man2/clone.2 b/man/man2/clone.2
index 655e50b82..90ab5cadf 100644
--- a/man/man2/clone.2
+++ b/man/man2/clone.2
@@ -58,7 +58,7 @@ .SH SYNOPSIS
 .BI "                                       void *_Nullable " tls ,
 .BI "                                       pid_t *_Nullable " child_tid " \fR*/\fP );"
 .P
-/* For the prototype of the raw clone() system call, see NOTES */
+/* For the prototype of the raw clone() system call, see VERSIONS. */
 .P
 .BR "#include <linux/sched.h>" "    /* Definition of " "struct clone_args" " */"
 .BR "#include <sched.h>" "          /* Definition of " CLONE_* " constants */"
-- 
2.45.2


^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [PATCH 03/16] execve.2: fix wrong section reference
  2024-06-17 23:10 [PATCH 00/16] man2: fix wrong/non-existent section references Kir Kolyshkin
  2024-06-17 23:10 ` [PATCH 01/16] cacheflush.2: fix section reference Kir Kolyshkin
  2024-06-17 23:10 ` [PATCH 02/16] clone.2: fix wrong " Kir Kolyshkin
@ 2024-06-17 23:10 ` Kir Kolyshkin
  2024-06-17 23:10 ` [PATCH 04/16] gethostname.2: fix " Kir Kolyshkin
                   ` (13 subsequent siblings)
  16 siblings, 0 replies; 21+ messages in thread
From: Kir Kolyshkin @ 2024-06-17 23:10 UTC (permalink / raw
  To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man

The man page says:

> For portable use, optional-arg should either be absent, or be
> specified as a single word (i.e., it should not contain white
> space); see NOTES below.

Since the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS,
HISTORY: Reorganize sections"), the discussion about optional-arg is in
VERSIONS.

Fixes: 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections")
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
 man/man2/execve.2 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/man/man2/execve.2 b/man/man2/execve.2
index 997bb4724..1802258ae 100644
--- a/man/man2/execve.2
+++ b/man/man2/execve.2
@@ -362,7 +362,7 @@ .SS Interpreter scripts
 For portable use,
 .I optional-arg
 should either be absent, or be specified as a single word (i.e., it
-should not contain white space); see NOTES below.
+should not contain white space); see VERSIONS below.
 .P
 Since Linux 2.6.28,
 .\" commit bf2a9a39639b8b51377905397a5005f444e9a892
-- 
2.45.2


^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [PATCH 04/16] gethostname.2: fix section reference
  2024-06-17 23:10 [PATCH 00/16] man2: fix wrong/non-existent section references Kir Kolyshkin
                   ` (2 preceding siblings ...)
  2024-06-17 23:10 ` [PATCH 03/16] execve.2: " Kir Kolyshkin
@ 2024-06-17 23:10 ` Kir Kolyshkin
  2024-06-17 23:10 ` [PATCH 05/16] getpriority.2: move info from NOTES to HISTORY Kir Kolyshkin
                   ` (12 subsequent siblings)
  16 siblings, 0 replies; 21+ messages in thread
From: Kir Kolyshkin @ 2024-06-17 23:10 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 ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections")
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
 man/man2/gethostname.2 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/man/man2/gethostname.2 b/man/man2/gethostname.2
index 1a9fc0d2f..ad9e96b3f 100644
--- a/man/man2/gethostname.2
+++ b/man/man2/gethostname.2
@@ -69,7 +69,7 @@ .SH DESCRIPTION
 .I len
 bytes.
 If the null-terminated hostname is too large to fit,
-then the name is truncated, and no error is returned (but see NOTES below).
+then the name is truncated, and no error is returned (but see VERSIONS below).
 POSIX.1 says that if such truncation occurs,
 then it is unspecified whether the returned buffer
 includes a terminating null byte.
-- 
2.45.2


^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [PATCH 05/16] getpriority.2: move info from NOTES to HISTORY
  2024-06-17 23:10 [PATCH 00/16] man2: fix wrong/non-existent section references Kir Kolyshkin
                   ` (3 preceding siblings ...)
  2024-06-17 23:10 ` [PATCH 04/16] gethostname.2: fix " Kir Kolyshkin
@ 2024-06-17 23:10 ` Kir Kolyshkin
  2024-06-17 23:10 ` [PATCH 06/16] gettimeofday.2: fix wrong section reference Kir Kolyshkin
                   ` (11 subsequent siblings)
  16 siblings, 0 replies; 21+ messages in thread
From: Kir Kolyshkin @ 2024-06-17 23:10 UTC (permalink / raw
  To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man

In the spirit of commit 4131356cd ("man*/, man-pages.7: VERSIONS,
STANDARDS, HISTORY: Reorganize sections"), move the historical
information about EPERM error from NOTES to HISTORY, and fix the
section reference accordingly.

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
 man/man2/getpriority.2 | 32 ++++++++++++++++----------------
 1 file changed, 16 insertions(+), 16 deletions(-)

diff --git a/man/man2/getpriority.2 b/man/man2/getpriority.2
index 111b591b5..4784407ee 100644
--- a/man/man2/getpriority.2
+++ b/man/man2/getpriority.2
@@ -138,7 +138,7 @@ .SH ERRORS
 and was not privileged (on Linux: did not have the
 .B CAP_SYS_NICE
 capability).
-But see NOTES below.
+But see HISTORY below.
 .TP
 .B ESRCH
 No process was located using the
@@ -151,21 +151,6 @@ .SH STANDARDS
 .SH HISTORY
 POSIX.1-2001,
 SVr4, 4.4BSD (these interfaces first appeared in 4.2BSD).
-.SH NOTES
-For further details on the nice value, see
-.BR sched (7).
-.P
-.IR Note :
-the addition of the "autogroup" feature in Linux 2.6.38 means that
-the nice value no longer has its traditional effect in many circumstances.
-For details, see
-.BR sched (7).
-.P
-A child created by
-.BR fork (2)
-inherits its parent's nice value.
-The nice value is preserved across
-.BR execve (2).
 .P
 The details on the condition for
 .B EPERM
@@ -182,6 +167,21 @@ .SH NOTES
 4.3BSD, FreeBSD 4.3, OpenBSD-2.5, ...) behave in the same
 manner as Linux 2.6.12 and later.
 .\"
+.SH NOTES
+For further details on the nice value, see
+.BR sched (7).
+.P
+.IR Note :
+the addition of the "autogroup" feature in Linux 2.6.38 means that
+the nice value no longer has its traditional effect in many circumstances.
+For details, see
+.BR sched (7).
+.P
+A child created by
+.BR fork (2)
+inherits its parent's nice value.
+The nice value is preserved across
+.BR execve (2).
 .SS C library/kernel differences
 The getpriority system call returns nice values translated to the range 40..1,
 since a negative return value would be interpreted as an error.
-- 
2.45.2


^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [PATCH 06/16] gettimeofday.2: fix wrong section reference
  2024-06-17 23:10 [PATCH 00/16] man2: fix wrong/non-existent section references Kir Kolyshkin
                   ` (4 preceding siblings ...)
  2024-06-17 23:10 ` [PATCH 05/16] getpriority.2: move info from NOTES to HISTORY Kir Kolyshkin
@ 2024-06-17 23:10 ` Kir Kolyshkin
  2024-06-17 23:10 ` [PATCH 07/16] ioperm.2: " Kir Kolyshkin
                   ` (10 subsequent siblings)
  16 siblings, 0 replies; 21+ messages in thread
From: Kir Kolyshkin @ 2024-06-17 23:10 UTC (permalink / raw
  To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man

The man page says:

> The use of the timezone structure is obsolete; the tz argument should
> normally be specified as NULL. (See NOTES below.)

Since the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS,
HISTORY: Reorganize sections"), this information is in VERSIONS.

Fixes: 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections")
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
 man/man2/gettimeofday.2 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/man/man2/gettimeofday.2 b/man/man2/gettimeofday.2
index e0231e230..b7fba16d8 100644
--- a/man/man2/gettimeofday.2
+++ b/man/man2/gettimeofday.2
@@ -105,7 +105,7 @@ .SH DESCRIPTION
 structure is obsolete; the
 .I tz
 argument should normally be specified as NULL.
-(See NOTES below.)
+See VERSIONS.
 .P
 Under Linux, there are some peculiar "warp clock" semantics associated
 with the
-- 
2.45.2


^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [PATCH 07/16] ioperm.2: fix wrong section reference
  2024-06-17 23:10 [PATCH 00/16] man2: fix wrong/non-existent section references Kir Kolyshkin
                   ` (5 preceding siblings ...)
  2024-06-17 23:10 ` [PATCH 06/16] gettimeofday.2: fix wrong section reference Kir Kolyshkin
@ 2024-06-17 23:10 ` Kir Kolyshkin
  2024-06-18 13:32   ` Alejandro Colomar
  2024-06-17 23:10 ` [PATCH 08/16] kill.2: " Kir Kolyshkin
                   ` (9 subsequent siblings)
  16 siblings, 1 reply; 21+ messages in thread
From: Kir Kolyshkin @ 2024-06-17 23:10 UTC (permalink / raw
  To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man

The man page says:

> Permissions are inherited by the child created by fork (2)
> (but see HISTORY).

Since the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS,
HISTORY: Reorganize sections"), the discussion about permission
inheritance is in VERSIONS.

Fixes: 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections")
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
 man/man2/ioperm.2 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/man/man2/ioperm.2 b/man/man2/ioperm.2
index a2cde4721..5b6550e46 100644
--- a/man/man2/ioperm.2
+++ b/man/man2/ioperm.2
@@ -50,7 +50,7 @@ .SH DESCRIPTION
 .P
 Permissions are inherited by the child created by
 .BR fork (2)
-(but see NOTES).
+(but see HISTORY).
 Permissions are preserved across
 .BR execve (2);
 this is useful for giving port access permissions to unprivileged
-- 
2.45.2


^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [PATCH 08/16] kill.2: fix wrong section reference
  2024-06-17 23:10 [PATCH 00/16] man2: fix wrong/non-existent section references Kir Kolyshkin
                   ` (6 preceding siblings ...)
  2024-06-17 23:10 ` [PATCH 07/16] ioperm.2: " Kir Kolyshkin
@ 2024-06-17 23:10 ` Kir Kolyshkin
  2024-06-17 23:10 ` [PATCH 09/16] mkdir.2: " Kir Kolyshkin
                   ` (8 subsequent siblings)
  16 siblings, 0 replies; 21+ messages in thread
From: Kir Kolyshkin @ 2024-06-17 23:10 UTC (permalink / raw
  To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man

The man page says:

> (Historically, the rules were different; see NOTES.)

Since the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS,
HISTORY: Reorganize sections"), the historical rules moved to HISTORY.

Fixes: 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections")
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
 man/man2/kill.2 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/man/man2/kill.2 b/man/man2/kill.2
index 16500fba2..8a9317930 100644
--- a/man/man2/kill.2
+++ b/man/man2/kill.2
@@ -77,7 +77,7 @@ .SH DESCRIPTION
 .BR SIGCONT ,
 it suffices when the sending and receiving
 processes belong to the same session.
-(Historically, the rules were different; see NOTES.)
+(Historically, the rules were different; see HISTORY.)
 .SH RETURN VALUE
 On success (at least one signal was sent), zero is returned.
 On error, \-1 is returned, and
-- 
2.45.2


^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [PATCH 09/16] mkdir.2: fix wrong section reference
  2024-06-17 23:10 [PATCH 00/16] man2: fix wrong/non-existent section references Kir Kolyshkin
                   ` (7 preceding siblings ...)
  2024-06-17 23:10 ` [PATCH 08/16] kill.2: " Kir Kolyshkin
@ 2024-06-17 23:10 ` Kir Kolyshkin
  2024-06-17 23:10 ` [PATCH 10/16] mmap.2: " Kir Kolyshkin
                   ` (7 subsequent siblings)
  16 siblings, 0 replies; 21+ messages in thread
From: Kir Kolyshkin @ 2024-06-17 23:10 UTC (permalink / raw
  To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man

The man page says:

> Whether other mode bits are honored for the created directory depends
> on the operating system. For Linux, see VERSIONS below.

Since the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS,
HISTORY: Reorganize sections"), the discussion about permission
inheritance is in VERSIONS.

Fixes: 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections")
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
 man/man2/mkdir.2 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/man/man2/mkdir.2 b/man/man2/mkdir.2
index 1d9cddbe6..3e56475c3 100644
--- a/man/man2/mkdir.2
+++ b/man/man2/mkdir.2
@@ -53,7 +53,7 @@ .SH DESCRIPTION
 Whether other
 .I mode
 bits are honored for the created directory depends on the operating system.
-For Linux, see NOTES below.
+For Linux, see VERSIONS below.
 .P
 The newly created directory will be owned by the effective user ID of the
 process.
-- 
2.45.2


^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [PATCH 10/16] mmap.2: fix wrong section reference
  2024-06-17 23:10 [PATCH 00/16] man2: fix wrong/non-existent section references Kir Kolyshkin
                   ` (8 preceding siblings ...)
  2024-06-17 23:10 ` [PATCH 09/16] mkdir.2: " Kir Kolyshkin
@ 2024-06-17 23:10 ` Kir Kolyshkin
  2024-06-17 23:10 ` [PATCH 11/16] nice.2: " Kir Kolyshkin
                   ` (6 subsequent siblings)
  16 siblings, 0 replies; 21+ messages in thread
From: Kir Kolyshkin @ 2024-06-17 23:10 UTC (permalink / raw
  To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man

The man page says:

> See NOTES for information on feature test macro requirements.

Since the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS,
HISTORY: Reorganize sections"), this information is in VERSIONS.

Fixes: 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections")
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
 man/man2/mmap.2 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/man/man2/mmap.2 b/man/man2/mmap.2
index 12d60f500..a7a429137 100644
--- a/man/man2/mmap.2
+++ b/man/man2/mmap.2
@@ -34,7 +34,7 @@ .SH SYNOPSIS
 .BI "int munmap(void " addr [. length "], size_t " length );
 .fi
 .P
-See NOTES for information on feature test macro requirements.
+See VERSIONS for information on feature test macro requirements.
 .SH DESCRIPTION
 .BR mmap ()
 creates a new mapping in the virtual address space of
-- 
2.45.2


^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [PATCH 11/16] nice.2: fix wrong section reference
  2024-06-17 23:10 [PATCH 00/16] man2: fix wrong/non-existent section references Kir Kolyshkin
                   ` (9 preceding siblings ...)
  2024-06-17 23:10 ` [PATCH 10/16] mmap.2: " Kir Kolyshkin
@ 2024-06-17 23:10 ` Kir Kolyshkin
  2024-06-17 23:10 ` [PATCH 12/16] open.2: " Kir Kolyshkin
                   ` (5 subsequent siblings)
  16 siblings, 0 replies; 21+ messages in thread
From: Kir Kolyshkin @ 2024-06-17 23:10 UTC (permalink / raw
  To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man

The man page says:

> On success, the new nice value is returned (but see NOTES below).

Since the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS,
HISTORY: Reorganize sections"), this information is in VERSIONS.

Fixes: 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections")
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
 man/man2/nice.2 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/man/man2/nice.2 b/man/man2/nice.2
index 20d8d8ec1..743286eae 100644
--- a/man/man2/nice.2
+++ b/man/man2/nice.2
@@ -51,7 +51,7 @@ .SH DESCRIPTION
 .BR getrlimit (2)
 for details.
 .SH RETURN VALUE
-On success, the new nice value is returned (but see NOTES below).
+On success, the new nice value is returned (but see VERSIONS below).
 On error, \-1 is returned, and
 .I errno
 is set to indicate the error.
-- 
2.45.2


^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [PATCH 12/16] open.2: fix wrong section reference
  2024-06-17 23:10 [PATCH 00/16] man2: fix wrong/non-existent section references Kir Kolyshkin
                   ` (10 preceding siblings ...)
  2024-06-17 23:10 ` [PATCH 11/16] nice.2: " Kir Kolyshkin
@ 2024-06-17 23:10 ` Kir Kolyshkin
  2024-06-17 23:10 ` [PATCH 13/16] readdir.2: " Kir Kolyshkin
                   ` (4 subsequent siblings)
  16 siblings, 0 replies; 21+ messages in thread
From: Kir Kolyshkin @ 2024-06-17 23:10 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 O_SYNC and O_DSYNC
is now under VERSIONS / Synchronized I/O.

While at it, fix the typesetting.

Fixes: 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections")
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
 man/man2/open.2 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/man/man2/open.2 b/man/man2/open.2
index 1e98a1df4..88d065179 100644
--- a/man/man2/open.2
+++ b/man/man2/open.2
@@ -418,7 +418,7 @@ .SH DESCRIPTION
 .BR write (2)
 was followed by a call to
 .BR fdatasync (2)).
-.IR "See NOTES below" .
+See VERSIONS.
 .TP
 .B O_EXCL
 Ensure that this call creates the file:
@@ -776,7 +776,7 @@ .SH DESCRIPTION
 .BR write (2)
 was followed by a call to
 .BR fsync (2)).
-.IR "See NOTES below" .
+See VERSIONS.
 .TP
 .BR O_TMPFILE " (since Linux 3.11)"
 .\" commit 60545d0d4610b02e55f65d141c95b18ccf855b6e
-- 
2.45.2


^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [PATCH 13/16] readdir.2: fix wrong section reference
  2024-06-17 23:10 [PATCH 00/16] man2: fix wrong/non-existent section references Kir Kolyshkin
                   ` (11 preceding siblings ...)
  2024-06-17 23:10 ` [PATCH 12/16] open.2: " Kir Kolyshkin
@ 2024-06-17 23:10 ` Kir Kolyshkin
  2024-06-17 23:10 ` [PATCH 14/16] semctl.2: " Kir Kolyshkin
                   ` (3 subsequent siblings)
  16 siblings, 0 replies; 21+ messages in thread
From: Kir Kolyshkin @ 2024-06-17 23:10 UTC (permalink / raw
  To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man

The man page says:

> There is no definition of struct old_linux_dirent; see NOTES.

Since the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS,
HISTORY: Reorganize sections"), this information is in VERSIONS.

Fixes: 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections")
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
 man/man2/readdir.2 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/man/man2/readdir.2 b/man/man2/readdir.2
index 1fb02f7d5..e4b58a652 100644
--- a/man/man2/readdir.2
+++ b/man/man2/readdir.2
@@ -25,7 +25,7 @@ .SH SYNOPSIS
 .IR Note :
 There is no definition of
 .BR "struct old_linux_dirent" ;
-see NOTES.
+see VERSIONS.
 .SH DESCRIPTION
 This is not the function you are interested in.
 Look at
-- 
2.45.2


^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [PATCH 14/16] semctl.2: fix wrong section reference
  2024-06-17 23:10 [PATCH 00/16] man2: fix wrong/non-existent section references Kir Kolyshkin
                   ` (12 preceding siblings ...)
  2024-06-17 23:10 ` [PATCH 13/16] readdir.2: " Kir Kolyshkin
@ 2024-06-17 23:10 ` Kir Kolyshkin
  2024-06-17 23:10 ` [PATCH 15/16] uname.2: " Kir Kolyshkin
                   ` (2 subsequent siblings)
  16 siblings, 0 replies; 21+ messages in thread
From: Kir Kolyshkin @ 2024-06-17 23:10 UTC (permalink / raw
  To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man

The man page says:

> GETPID
> 	Return the sempid value for the semnum-th semaphore of
>	the set. This is the PID of the process that last
> 	performed an operation on that semaphore (but see NOTES).

Since the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS,
HISTORY: Reorganize sections"), this information is in VERSIONS.

Fixes: 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections")
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
 man/man2/semctl.2 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/man/man2/semctl.2 b/man/man2/semctl.2
index 243919c73..4dad99ea4 100644
--- a/man/man2/semctl.2
+++ b/man/man2/semctl.2
@@ -317,7 +317,7 @@ .SH DESCRIPTION
 .IR semnum \-th
 semaphore of the set.
 This is the PID of the process that last performed an operation on
-that semaphore (but see NOTES).
+that semaphore (but see VERSIONS).
 The calling process must have read permission on the semaphore set.
 .TP
 .B GETVAL
-- 
2.45.2


^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [PATCH 15/16] uname.2: fix wrong section reference
  2024-06-17 23:10 [PATCH 00/16] man2: fix wrong/non-existent section references Kir Kolyshkin
                   ` (13 preceding siblings ...)
  2024-06-17 23:10 ` [PATCH 14/16] semctl.2: " Kir Kolyshkin
@ 2024-06-17 23:10 ` Kir Kolyshkin
  2024-06-17 23:10 ` [PATCH 16/16] wait.2: " Kir Kolyshkin
  2024-06-18 13:42 ` [PATCH 00/16] man2: fix wrong/non-existent section references Alejandro Colomar
  16 siblings, 0 replies; 21+ messages in thread
From: Kir Kolyshkin @ 2024-06-17 23:10 UTC (permalink / raw
  To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man

The man page says:

> The length of the arrays in a struct utsname is unspecified (see NOTES);

Since the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS,
HISTORY: Reorganize sections"), this information is in VERSIONS and
HISTORY.

Fixes: 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections")
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
 man/man2/uname.2 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/man/man2/uname.2 b/man/man2/uname.2
index 572bfd3a6..09453dc9c 100644
--- a/man/man2/uname.2
+++ b/man/man2/uname.2
@@ -44,7 +44,7 @@ .SH DESCRIPTION
 .P
 The length of the arrays in a
 .I struct utsname
-is unspecified (see NOTES);
+is unspecified (see VERSIONS and HISTORY);
 the fields are terminated by a null byte (\[aq]\[rs]0\[aq]).
 .SH RETURN VALUE
 On success, zero is returned.
-- 
2.45.2


^ permalink raw reply related	[flat|nested] 21+ messages in thread

* [PATCH 16/16] wait.2: fix wrong section reference
  2024-06-17 23:10 [PATCH 00/16] man2: fix wrong/non-existent section references Kir Kolyshkin
                   ` (14 preceding siblings ...)
  2024-06-17 23:10 ` [PATCH 15/16] uname.2: " Kir Kolyshkin
@ 2024-06-17 23:10 ` Kir Kolyshkin
  2024-06-18 13:42 ` [PATCH 00/16] man2: fix wrong/non-existent section references Alejandro Colomar
  16 siblings, 0 replies; 21+ messages in thread
From: Kir Kolyshkin @ 2024-06-17 23:10 UTC (permalink / raw
  To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man

The man page says:

> This is the glibc and POSIX interface; see
> NOTES for information on the raw system call.

Since the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS,
HISTORY: Reorganize sections"), this information is in VERSIONS.

Fixes: 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections")
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
 man/man2/wait.2 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/man/man2/wait.2 b/man/man2/wait.2
index dbbb8abf5..46baa6da6 100644
--- a/man/man2/wait.2
+++ b/man/man2/wait.2
@@ -42,7 +42,7 @@ .SH SYNOPSIS
 .BI "int waitid(idtype_t " idtype ", id_t " id \
 ", siginfo_t *" infop ", int " options );
                 /* This is the glibc and POSIX interface; see
-                   NOTES for information on the raw system call. */
+                   VERSIONS for information on the raw system call. */
 .fi
 .P
 .RS -4
-- 
2.45.2


^ permalink raw reply related	[flat|nested] 21+ messages in thread

* Re: [PATCH 07/16] ioperm.2: fix wrong section reference
  2024-06-17 23:10 ` [PATCH 07/16] ioperm.2: " Kir Kolyshkin
@ 2024-06-18 13:32   ` Alejandro Colomar
  2024-06-18 17:35     ` [PATCH v2 " Kir Kolyshkin
  0 siblings, 1 reply; 21+ messages in thread
From: Alejandro Colomar @ 2024-06-18 13:32 UTC (permalink / raw
  To: Kir Kolyshkin; +Cc: linux-man

[-- Attachment #1: Type: text/plain, Size: 1190 bytes --]

On Mon, Jun 17, 2024 at 04:10:19PM GMT, Kir Kolyshkin wrote:
> The man page says:
> 
> > Permissions are inherited by the child created by fork (2)
> > (but see HISTORY).
> 
> Since the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS,
> HISTORY: Reorganize sections"), the discussion about permission
> inheritance is in VERSIONS.

The commit message is inconsistent.  Here it says VERSIONS.
> 
> Fixes: 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections")
> Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
> ---
>  man/man2/ioperm.2 | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/man/man2/ioperm.2 b/man/man2/ioperm.2
> index a2cde4721..5b6550e46 100644
> --- a/man/man2/ioperm.2
> +++ b/man/man2/ioperm.2
> @@ -50,7 +50,7 @@ .SH DESCRIPTION
>  .P
>  Permissions are inherited by the child created by
>  .BR fork (2)
> -(but see NOTES).
> +(but see HISTORY).

But it's changed to HISTORY.

>  Permissions are preserved across
>  .BR execve (2);
>  this is useful for giving port access permissions to unprivileged
> -- 
> 2.45.2
> 
> 

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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

^ permalink raw reply	[flat|nested] 21+ messages in thread

* Re: [PATCH 00/16] man2: fix wrong/non-existent section references
  2024-06-17 23:10 [PATCH 00/16] man2: fix wrong/non-existent section references Kir Kolyshkin
                   ` (15 preceding siblings ...)
  2024-06-17 23:10 ` [PATCH 16/16] wait.2: " Kir Kolyshkin
@ 2024-06-18 13:42 ` Alejandro Colomar
  16 siblings, 0 replies; 21+ messages in thread
From: Alejandro Colomar @ 2024-06-18 13:42 UTC (permalink / raw
  To: Kir Kolyshkin; +Cc: linux-man

[-- Attachment #1: Type: text/plain, Size: 1921 bytes --]

Hi Kir,

On Mon, Jun 17, 2024 at 04:10:12PM GMT, Kir Kolyshkin wrote:
> Commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY:
> Reorganize sections") results in many wrong section references.
> 
> This patch series tries to fix some of these issues in man2 section
> which I was able to find.

Thanks!  I've applied all patches, except 07 (the commit message didn't
match the diff).

Have a lovely day!
Alex

> 
> *** BLURB HERE ***
> 
> Kir Kolyshkin (16):
>   cacheflush.2: fix section reference
>   clone.2: fix wrong section reference
>   execve.2: fix wrong section reference
>   gethostname.2: fix section reference
>   getpriority.2: move info from NOTES to HISTORY
>   gettimeofday.2: fix wrong section reference
>   ioperm.2: fix wrong section reference
>   kill.2: fix wrong section reference
>   mkdir.2: fix wrong section reference
>   mmap.2: fix wrong section reference
>   nice.2: fix wrong section reference
>   open.2: fix wrong section reference
>   readdir.2: fix wrong section reference
>   semctl.2: fix wrong section reference
>   uname.2: fix wrong section reference
>   wait.2: fix wrong section reference
> 
>  man/man2/cacheflush.2   |  2 +-
>  man/man2/clone.2        |  2 +-
>  man/man2/execve.2       |  2 +-
>  man/man2/gethostname.2  |  2 +-
>  man/man2/getpriority.2  | 32 ++++++++++++++++----------------
>  man/man2/gettimeofday.2 |  2 +-
>  man/man2/ioperm.2       |  2 +-
>  man/man2/kill.2         |  2 +-
>  man/man2/mkdir.2        |  2 +-
>  man/man2/mmap.2         |  2 +-
>  man/man2/nice.2         |  2 +-
>  man/man2/open.2         |  4 ++--
>  man/man2/readdir.2      |  2 +-
>  man/man2/semctl.2       |  2 +-
>  man/man2/uname.2        |  2 +-
>  man/man2/wait.2         |  2 +-
>  16 files changed, 32 insertions(+), 32 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] 21+ messages in thread

* [PATCH v2 07/16] ioperm.2: fix wrong section reference
  2024-06-18 13:32   ` Alejandro Colomar
@ 2024-06-18 17:35     ` Kir Kolyshkin
  2024-06-18 18:49       ` Alejandro Colomar
  0 siblings, 1 reply; 21+ messages in thread
From: Kir Kolyshkin @ 2024-06-18 17:35 UTC (permalink / raw
  To: Alejandro Colomar; +Cc: Kir Kolyshkin, linux-man

The man page says:

> Permissions are inherited by the child created by fork (2)
> (but see NOTES).

Since the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS,
HISTORY: Reorganize sections"), the relevant information is in HISTORY.

Fixes: 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections")
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
 man/man2/ioperm.2 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/man/man2/ioperm.2 b/man/man2/ioperm.2
index a2cde4721..5b6550e46 100644
--- a/man/man2/ioperm.2
+++ b/man/man2/ioperm.2
@@ -50,7 +50,7 @@ .SH DESCRIPTION
 .P
 Permissions are inherited by the child created by
 .BR fork (2)
-(but see NOTES).
+(but see HISTORY).
 Permissions are preserved across
 .BR execve (2);
 this is useful for giving port access permissions to unprivileged
-- 
2.45.2


^ permalink raw reply related	[flat|nested] 21+ messages in thread

* Re: [PATCH v2 07/16] ioperm.2: fix wrong section reference
  2024-06-18 17:35     ` [PATCH v2 " Kir Kolyshkin
@ 2024-06-18 18:49       ` Alejandro Colomar
  0 siblings, 0 replies; 21+ messages in thread
From: Alejandro Colomar @ 2024-06-18 18:49 UTC (permalink / raw
  To: Kir Kolyshkin; +Cc: linux-man

[-- Attachment #1: Type: text/plain, Size: 1131 bytes --]

Hi Kir,

On Tue, Jun 18, 2024 at 10:35:21AM GMT, Kir Kolyshkin wrote:
> The man page says:
> 
> > Permissions are inherited by the child created by fork (2)
> > (but see NOTES).
> 
> Since the commit 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS,
> HISTORY: Reorganize sections"), the relevant information is in HISTORY.
> 
> Fixes: 4131356cd ("man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections")
> Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>

Patch applied; thanks.

Have a lovely day!
Alex

> ---
>  man/man2/ioperm.2 | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/man/man2/ioperm.2 b/man/man2/ioperm.2
> index a2cde4721..5b6550e46 100644
> --- a/man/man2/ioperm.2
> +++ b/man/man2/ioperm.2
> @@ -50,7 +50,7 @@ .SH DESCRIPTION
>  .P
>  Permissions are inherited by the child created by
>  .BR fork (2)
> -(but see NOTES).
> +(but see HISTORY).
>  Permissions are preserved across
>  .BR execve (2);
>  this is useful for giving port access permissions to unprivileged
> -- 
> 2.45.2
> 

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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

^ permalink raw reply	[flat|nested] 21+ messages in thread

end of thread, other threads:[~2024-06-18 18:49 UTC | newest]

Thread overview: 21+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-06-17 23:10 [PATCH 00/16] man2: fix wrong/non-existent section references Kir Kolyshkin
2024-06-17 23:10 ` [PATCH 01/16] cacheflush.2: fix section reference Kir Kolyshkin
2024-06-17 23:10 ` [PATCH 02/16] clone.2: fix wrong " Kir Kolyshkin
2024-06-17 23:10 ` [PATCH 03/16] execve.2: " Kir Kolyshkin
2024-06-17 23:10 ` [PATCH 04/16] gethostname.2: fix " Kir Kolyshkin
2024-06-17 23:10 ` [PATCH 05/16] getpriority.2: move info from NOTES to HISTORY Kir Kolyshkin
2024-06-17 23:10 ` [PATCH 06/16] gettimeofday.2: fix wrong section reference Kir Kolyshkin
2024-06-17 23:10 ` [PATCH 07/16] ioperm.2: " Kir Kolyshkin
2024-06-18 13:32   ` Alejandro Colomar
2024-06-18 17:35     ` [PATCH v2 " Kir Kolyshkin
2024-06-18 18:49       ` Alejandro Colomar
2024-06-17 23:10 ` [PATCH 08/16] kill.2: " Kir Kolyshkin
2024-06-17 23:10 ` [PATCH 09/16] mkdir.2: " Kir Kolyshkin
2024-06-17 23:10 ` [PATCH 10/16] mmap.2: " Kir Kolyshkin
2024-06-17 23:10 ` [PATCH 11/16] nice.2: " Kir Kolyshkin
2024-06-17 23:10 ` [PATCH 12/16] open.2: " Kir Kolyshkin
2024-06-17 23:10 ` [PATCH 13/16] readdir.2: " Kir Kolyshkin
2024-06-17 23:10 ` [PATCH 14/16] semctl.2: " Kir Kolyshkin
2024-06-17 23:10 ` [PATCH 15/16] uname.2: " Kir Kolyshkin
2024-06-17 23:10 ` [PATCH 16/16] wait.2: " Kir Kolyshkin
2024-06-18 13:42 ` [PATCH 00/16] man2: 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).