Re: [PATCH] fallocate.2, getdents.2, rcmd.3, capabilities.7, feature_test_macros.7, ip.7, pipe.7, socket.7, tcp.7: wfix

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

 



Hi Stefan, Jesse,

On 6/27/22 13:03, Jesse Rosenstock wrote:
On Sat, Jun 25, 2022 at 11:18 AM Stefan Puiu <stefan.puiu@xxxxxxxxx> wrote:
On Fri, Jun 24, 2022 at 6:19 PM Jesse Rosenstock <jmr@xxxxxxxxxx> wrote:
diff --git a/man3/rcmd.3 b/man3/rcmd.3
index b2f06c01d..46460d3e6 100644
--- a/man3/rcmd.3
+++ b/man3/rcmd.3
@@ -315,7 +315,7 @@ and are not present on as wide a range of systems.
  .BR iruserok ()
  and
  .BR iruserok_af ()
-are declared in glibc headers only since version 2.12.
+are were missing from glibc headers before version 2.12.

were missing? Or maybe, to be consistent with the rest of the patch,
you could say "were added in glibc headers in version 2.12"?

This one is in the "BUGS" section, which is why it's worded differently.

I don't want to say it's a bug that it was added; the bug is that it
was missing.

I've fixed the typo though.

diff --git a/man7/pipe.7 b/man7/pipe.7
index bf93cafbf..b704bbee0 100644
--- a/man7/pipe.7
+++ b/man7/pipe.7
@@ -331,7 +331,7 @@ The target for delivery of signals must be set using the
  command.
  On Linux,
  .B O_ASYNC
-is supported for pipes and FIFOs only since kernel 2.6.
+supported for pipes and FIFOs was added in kernel 2.6.

"support for pipes"?

Fixed, sorry about that.

--------------------------

Rewrite potentially ambiguous "only since" to something more explicit,
such as "support was added in".

A continuation of:
https://lore.kernel.org/linux-man/a06413f0-c87d-f80e-cb3a-e27258fbcd59@xxxxxxxxx/T/#t

Signed-off-by: Jesse Rosenstock <jmr@xxxxxxxxxx>

Thanks for the wording fix, Jesse!  It looks very good to me :)
Does it look good to you now, Stefan?
I'll wait to apply it in case you want to add a review tag, Stefan.

Cheers,

Alex

---
  man2/fallocate.2           | 2 +-
  man2/getdents.2            | 4 ++--
  man3/rcmd.3                | 2 +-
  man7/capabilities.7        | 2 +-
  man7/feature_test_macros.7 | 2 +-
  man7/ip.7                  | 2 +-
  man7/pipe.7                | 2 +-
  man7/socket.7              | 4 ++--
  man7/tcp.7                 | 4 ++--
  9 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/man2/fallocate.2 b/man2/fallocate.2
index b4cb3516f..0a15a2f47 100644
--- a/man2/fallocate.2
+++ b/man2/fallocate.2
@@ -470,7 +470,7 @@ is available on Linux since kernel 2.6.23.
  Support is provided by glibc since version 2.10.
  The
  .BR FALLOC_FL_*
-flags are defined in glibc headers only since version 2.18.
+flags were added to glibc headers in version 2.18.
  .\" See http://sourceware.org/bugzilla/show_bug.cgi?id=14964
  .SH CONFORMING TO
  .BR fallocate ()
diff --git a/man2/getdents.2 b/man2/getdents.2
index 8201c3310..3cb3efc49 100644
--- a/man2/getdents.2
+++ b/man2/getdents.2
@@ -91,8 +91,8 @@ struct linux_dirent {
                           offsetof(struct linux_dirent, d_name)) */
      /*
      char           pad;       // Zero padding byte
-    char           d_type;    // File type (only since Linux
-                              // 2.6.4); offset is (d_reclen \- 1)
+    char           d_type;    // File type (added in Linux 2.6.4);
+                              // offset is (d_reclen \- 1)
      */
  }
  .EE
diff --git a/man3/rcmd.3 b/man3/rcmd.3
index b2f06c01d..60b54b5d2 100644
--- a/man3/rcmd.3
+++ b/man3/rcmd.3
@@ -315,7 +315,7 @@ and are not present on as wide a range of systems.
  .BR iruserok ()
  and
  .BR iruserok_af ()
-are declared in glibc headers only since version 2.12.
+were missing from glibc headers before version 2.12.
  .\" Bug filed 25 Nov 2007:
  .\" http://sources.redhat.com/bugzilla/show_bug.cgi?id=5399
  .SH SEE ALSO
diff --git a/man7/capabilities.7 b/man7/capabilities.7
index c65524496..e818fa9e2 100644
--- a/man7/capabilities.7
+++ b/man7/capabilities.7
@@ -1218,7 +1218,7 @@ denotes a file capability set
  Note the following details relating to the above capability
  transformation rules:
  .IP * 3
-The ambient capability set is present only since Linux 4.3.
+The ambient capability set was added in Linux 4.3.
  When determining the transformation of the ambient set during
  .BR execve (2),
  a privileged file is one that has capabilities or
diff --git a/man7/feature_test_macros.7 b/man7/feature_test_macros.7
index 77362ed23..8fbd26c82 100644
--- a/man7/feature_test_macros.7
+++ b/man7/feature_test_macros.7
@@ -237,7 +237,7 @@ definitions for POSIX.2-1992.
  .IP \(bu
  The value 199309L or greater additionally exposes
  definitions for POSIX.1b (real-time extensions).
-.\" 199506L functionality is available only since glibc 2.1
+.\" 199506L functionality was added in glibc 2.1
  .IP \(bu
  The value 199506L or greater additionally exposes
  definitions for POSIX.1c (threads).
diff --git a/man7/ip.7 b/man7/ip.7
index 7eee2811e..e60b773a7 100644
--- a/man7/ip.7
+++ b/man7/ip.7
@@ -301,7 +301,7 @@ group, or 0 to indicate any interface.
  .IP
  The
  .I ip_mreqn
-structure is available only since Linux 2.2.
+structure was added in Linux 2.2.
  For compatibility, the old
  .I ip_mreq
  structure (present since Linux 1.2) is still supported;
diff --git a/man7/pipe.7 b/man7/pipe.7
index bf93cafbf..59b35177c 100644
--- a/man7/pipe.7
+++ b/man7/pipe.7
@@ -331,7 +331,7 @@ The target for delivery of signals must be set using the
  command.
  On Linux,
  .B O_ASYNC
-is supported for pipes and FIFOs only since kernel 2.6.
+support for pipes and FIFOs was added in kernel 2.6.
  .SS Portability notes
  On some systems (but not Linux), pipes are bidirectional:
  data can be transmitted in both directions between the pipe ends.
diff --git a/man7/socket.7 b/man7/socket.7
index 67736214a..15b763543 100644
--- a/man7/socket.7
+++ b/man7/socket.7
@@ -781,9 +781,9 @@ is not changeable on Linux
  .RB ( setsockopt (2)
  fails with the error
  .BR ENOPROTOOPT ).
+Support for changing
  .B SO_RCVLOWAT
-is changeable
-only since Linux 2.4.
+was added in Linux 2.4.
  .IP
  Before Linux 2.6.28
  .\" Tested on kernel 2.6.14 -- mtk, 30 Nov 05
diff --git a/man7/tcp.7 b/man7/tcp.7
index 0a7c61a37..4aaaeb6be 100644
--- a/man7/tcp.7
+++ b/man7/tcp.7
@@ -1046,9 +1046,9 @@ As currently implemented, there is a 200
millisecond ceiling on the time
  for which output is corked by
  .BR TCP_CORK .
  If this ceiling is reached, then queued data is automatically transmitted.
-This option can be combined with
+Support for combining this option with
  .B TCP_NODELAY
-only since Linux 2.5.71.
+was added in Linux 2.5.71.
  This option should not be used in code intended to be portable.
  .TP
  .BR TCP_DEFER_ACCEPT " (since Linux 2.4)"

--
Alejandro Colomar
<http://www.alejandro-colomar.es/>

Attachment: OpenPGP_signature
Description: OpenPGP digital 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