man/man2/semop.2: Fix VERSIONS and HISTORY mix-up
cover man/man2/semop.2: Fix VERSIONS and HISTORY mix-up
Hi all,
The man page for semop(2) and semtimedop(2) has a VERSIONS section, but not a HISTORY section. However, the VERSIONS section describes what should instead be in a HISTORY section, and doesn't distinguish between the two functions' different history/versions.
The reason for this seems to be a commit which removed text attributing the listed standards and versions to the corresponding function. I've patched the page to make clear which function has what history.
Do note that this my first attempt at using a git & email workflow. So while I've attempted to follow the contribution guidelines, there may still be some errors I've missed, and which I'd be happy to correct.
Seth McDonald (1):
man/man2/semop.2: Rebrand VERSIONS as HISTORY
man/man2/semop.2 | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-)
Range-diff against v0:
-: --------- > 1: 86b4c2ec9 man/man2/semop.2: Rebrand VERSIONS as HISTORY
Signature · 1 line
2.47.3
PATCH 1/1 man/man2/semop.2: Rebrand VERSIONS as HISTORY
Rename the VERSIONS section to HISTORY, split semop(2) and semtimedop(2) in this section, and move the previously listed standards/versions to the corresponding functions.
The VERSIONS section is really a HISTORY section that seems to have mixed up semop(2) and semtimedop(2). The relevant commit (4131356cdab8) removed some context specifying which standards/versions apply to semtimedop(2) only, causing this mix-up. The diff for this commit on man/man2/semop.2 is given below.
$ git diff -U1 4131356cdab8^! man2/semop.2
diff --git a/man2/semop.2 b/man2/semop.2
index 7a1416a26..fe2906be4 100644
--- a/man2/semop.2
+++ b/man2/semop.2
@@ -357,11 +357,8 @@ .SH ERRORS
.IR semval .
-.SH VERSIONS
-.BR semtimedop ()
-first appeared in Linux 2.5.52,
-and was subsequently backported into Linux 2.4.22.
-glibc support for
-.BR semtimedop ()
-first appeared in Linux 2.3.3.
.SH STANDARDS
-POSIX.1-2001, POSIX.1
-2008, SVr4.
+POSIX.1-2008.
+.SH VERSIONS
+Linux 2.5.52 (backported into Linux 2.4.22),
+glibc 2.3.3.
+POSIX.1-2001, SVr4.
.\" SVr4 documents additional error conditions EINVAL, EFBIG, ENOSPC.The removed information is restored on account of the semop(2) and semtimedop(2) functions being described separately under HISTORY, removing the mix-up.
--- man/man2/semop.2 | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-)
man/man2/semop.2 +8 -1
@@ -349,10 +349,16 @@ .SH ERRORS .IR semval . .SH STANDARDS POSIX.1-2024. -.SH VERSIONS +.SH HISTORY +.TP +.BR semop () +SVr4, +POSIX.1-2001. +.TP +.BR semtimedop () +SVr4, Linux 2.5.52 (backported into Linux 2.4.22)
,
glibc 2.3.3.
-POSIX.1-2001, SVr4.
.\" SVr4 documents additional error conditions EINVAL, EFBIG, ENOSPC. .SH NOTES
The
Signature · 1 line
2.47.3
Alejandro Colomar
maintainerRe: [PATCH v1 1/1] man/man2/semop.2: Rebrand VERSIONS as HISTORY
Quoted 53 lines · Seth McDonald
Rename the VERSIONS section to HISTORY, split semop(2) and semtimedop(2) in this section, and move the previously listed standards/versions to the corresponding functions.
The VERSIONS section is really a HISTORY section that seems to have mixed up semop(2) and semtimedop(2). The relevant commit (
4131356cdab8) removed some context specifying which standards/versions apply to semtimedop(2) only, causing this mix-up. The diff for this commit on man/man2/semop.2 is given below.$ git diff -U1 4131356cdab8^! man2/semop.2 diff --git a/man2/semop.2 b/man2/semop.2 index 7a1416a26..fe2906be4 100644 --- a/man2/semop.2 +++ b/man2/semop.2 @@ -357,11 +357,8 @@ .SH ERRORS .IR semval . -.SH VERSIONS -.BR semtimedop () -first appeared in Linux 2.5.52, -and was subsequently backported into Linux 2.4.22. -glibc support for -.BR semtimedop () -first appeared in Linux 2.3.3. .SH STANDARDS -POSIX.1-2001, POSIX.1 -2008, SVr4. +POSIX.1-2008. +.SH VERSIONS +Linux 2.5.52 (backported into Linux 2.4.22), +glibc 2.3.3. +POSIX.1-2001, SVr4. .\" SVr4 documents additional error conditions EINVAL, EFBIG, ENOSPC.The removed information is restored on account of the semop(2) and semtimedop(2) functions being described separately under HISTORY, removing the mix-up.
Fixes 4131356cdab8 (2023-03-17; "man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections")Signed-off-by Seth McDonald <[email protected]>--- man/man2/semop.2 | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-)man/man2/semop.2 +0
-1@@ -349,10 +349,16 @@ .SH ERRORS .IR semval . .SH STANDARDS POSIX.1-2024. -.SH VERSIONS
man/man2/semop.2 .SH ERRORS · line 361
Quoted 10 lines
man/man2/semop.2 +8
-0+.SH HISTORY +.TP +.BR semop () +SVr4, +POSIX.1-2001. +.TP +.BR semtimedop () +SVr4, Linux 2.5.52 (backported into Linux 2.4.22) ,
The patch is corrupt here. I wonder why this line is special. :)
Quoted 8 lines
man/man2/semop.2 +0
-1glibc 2.3.3. -POSIX.1-2001, SVr4. .\" SVr4 documents additional error conditions EINVAL, EFBIG, ENOSPC. .SH NOTESThe
Signature · 1 line
2.47.3
Signature · 1 line
<https://www.alejandro-colomar.es>
Alejandro Colomar
maintainerHi Seth,
Quoted 7 lines · Seth McDonald
Hi all,
The man page for semop(2) and semtimedop(2) has a VERSIONS section, but not a HISTORY section. However, the VERSIONS section describes what should instead be in a HISTORY section, and doesn't distinguish between the two functions' different history/versions.
Quoted 7 lines
The reason for this seems to be a commit which removed text attributing the listed standards and versions to the corresponding function. I've patched the page to make clear which function has what history.
Do note that this my first attempt at using a git & email workflow. So while I've attempted to follow the contribution guidelines, there may still be some errors I've missed, and which I'd be happy to correct.
Thanks for the fix! I liked it very much, except that I've split it in two commits. I've pushed them already, so you can check what I did.
Regarding git & email, the patch was corrupt. It has this:
Linux 2.5.52 (backported into Linux 2.4.22) ,
which was breaking a line from the patch. Thus, the patch didn't apply; but I fixed the patch manually, since it was easy. I guess protonmail did something bad to the mail. I wonder why it decided to break that line and only that one. :|
Have a lovely day!
Alex
Quoted 12 lines
Seth McDonald (1):
man/man2/semop.2: Rebrand VERSIONS as HISTORYman/man2/semop.2 | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-)Range-diff against v0:
-: --------- > 1:86b4c2ec9man/man2/semop.2: Rebrand VERSIONS as HISTORYSignature · 1 line
2.47.3
Signature · 1 line
<https://www.alejandro-colomar.es>
Hi Alex,
Quoted 9 lines · Alejandro Colomar
Hi Seth,
[...]
Regarding git & email, the patch was corrupt. It has this:
Quoted 8 lines
Linux 2.5.52 (backported into Linux 2.4.22)
,which was breaking a line from the patch. Thus, the patch didn't apply; but I fixed the patch manually, since it was easy. I guess protonmail did something bad to the mail. I wonder why it decided to break that line and only that one. :|
That is both curious and unfortunate. I had encountered reports of such patch-breakage by Proton Mail when configuring git-send-email, but had hoped that it was fixed by now. I'm not an email expert; I have no clue what could be happening or how to fix it.
However, looking at git-send-email's docs, I may be able to prevent this by formatting the patches and emails as usual, but actually sending them with Gmail (via the --envelope-sender option). It's not exactly desirable, but as a temporary fix it'll do.
I'll send a few minor patches soon to test if this will work.
----
Seth McDonald.
sethmcmail at pm dot me (mailing lists) 2336 E8D2 FEB1 5300 692C 62A9 5839 6AD8 9243 D369