Skip to contentSkip to conversation

man3/*: ffix, change '-' to '\-' for options

PATCH In review Bjarni Ingi Gislason 2 participants 7 messages Jul 1, 2020 – Jul 30, 2020 Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 man3/*: ffix, change '-' to '\-' for options

Change '-' to '\-' for the prefix of names to indicate an option.

---
 man3/dlopen.3             | 2 +-
 man3/fts.3                | 2 +-
 man3/getsubopt.3          | 2 +-
 man3/insque.3             | 2 +-
 man3/mq_getattr.3         | 2 +-
 man3/posix_spawn.3        | 8 ++++----
 man3/pthread_setname_np.3 | 2 +-
 man3/sincos.3             | 2 +-
 man3/strfromd.3           | 6 +++---
 man3/strftime.3           | 2 +-
 man3/system.3             | 2 +-
 11 files changed, 16 insertions(+), 16 deletions(-)
man3/dlopen.3 +1 -1
index 8629af83e..eec6f9980 100644
@@ -596,7 +596,7 @@ main(void)
        The 2013 Technical Corrigendum 1 to POSIX.1-2008 improved matters
        by requiring that conforming implementations support casting
        'void *' to a function pointer.  Nevertheless, some compilers
-       (e.g., gcc with the '-pedantic' option) may complain about the
+       (e.g., gcc with the '\-pedantic' option) may complain about the
        cast used in this program. */
 .\" http://pubs.opengroup.org/onlinepubs/009695399/functions/dlsym.html#tag_03_112_08
 .\" http://pubs.opengroup.org/onlinepubs/9699919799/functions/dlsym.html#tag_16_96_07
man3/fts.3 +1 -1
index bbd5cad5e..0d455149d 100644
@@ -822,7 +822,7 @@ In versions of glibc before 2.23,
 .\" https://sourceware.org/bugzilla/show_bug.cgi?id=11460
 all of the APIs described in this man page are not safe when compiling
 a program using the LFS APIs (e.g., when compiling with
-.IR -D_FILE_OFFSET_BITS=64 ).
+.IR \-D_FILE_OFFSET_BITS=64 ).
 .\"
 .\" The following statement is years old, and seems no closer to
 .\" being true -- mtk
man3/getsubopt.3 +1 -1
index 6cf2d7a82..cef57fde7 100644
@@ -53,7 +53,7 @@ parses the list of comma-separated suboptions provided in
 (Such a suboption list is typically produced when
 .BR getopt (3)
 is used to parse a command line;
-see for example the \fI-o\fP option of
+see for example the \fI\-o\fP option of
 .BR mount (8).)
 Each suboption may include an associated value,
 which is separated from the suboption name by an equal sign.
man3/insque.3 +1 -1
index 2a957f24c..a9fc28550 100644
@@ -155,7 +155,7 @@ Here is an example run of the program:
 .PP
 .in +4n
 .EX
-.RB "$ " "./a.out -c a b c"
+.RB "$ " "./a.out \-c a b c"
 Traversing completed list:
     a
     b
man3/mq_getattr.3 +1 -1
index 74ef0492f..771316472 100644
@@ -185,7 +185,7 @@ can be used to control the defaults:
 .PP
 .in +4n
 .EX
-$ \fBuname -sr\fP
+$ \fBuname \-sr\fP
 Linux 3.8.0
 $ \fBcat /proc/sys/fs/mqueue/msg_default\fP
 10
man3/posix_spawn.3 +4 -4
index 54fe775cc..f425a39e3 100644
@@ -631,7 +631,7 @@ fails when trying to perform output and exits with a status of 1.
 .PP
 .in +4
 .EX
-$ \fB./a.out -c date\fP
+$ \fB./a.out \-c date\fP
 PID of child: 7636
 date: write error: Bad file descriptor
 Child status: exited, status=1
@@ -655,14 +655,14 @@ can't be blocked).
 .PP
 .in +4
 .EX
-$ \fB./a.out -s sleep 60 &\fP
+$ \fB./a.out \-s sleep 60 &\fP
 [1] 7637
 $ PID of child: 7638
 
 $ \fBkill 7638\fP
-$ \fBkill -KILL 7638\fP
+$ \fBkill \-KILL 7638\fP
 $ Child status: killed by signal 9
-[1]+  Done                    ./a.out -s sleep 60
+[1]+  Done                    ./a.out \-s sleep 60
 .EE
 .in
 .PP
man3/pthread_setname_np.3 +1 -1
index acea0b468..883464755 100644
@@ -141,7 +141,7 @@ Created a thread. Default name is: a.out
 The thread name after setting it is THREADFOO.
 \fB^Z\fP                           # Suspend the program
 [1]+  Stopped           ./a.out
-.RB "$ " "ps H -C a.out -o 'pid tid cmd comm'"
+.RB "$ " "ps H \-C a.out \-o 'pid tid cmd comm'"
   PID   TID CMD                         COMMAND
  5990  5990 ./a.out                     a.out
  5990  5991 ./a.out                     THREADFOO
man3/sincos.3 +1 -1
index 7d5c29724..8ec3e9ca1 100644
@@ -94,7 +94,7 @@ built-in optimizations, using flags such as:
 .PP
 .in +4n
 .EX
-cc -O \-lm \-fno\-builtin prog.c
+cc \-O \-lm \-fno\-builtin prog.c
 .EE
 .in
 .SH BUGS
man3/strfromd.3 +3 -3
index 84cc08068..8092e645d 100644
@@ -127,13 +127,13 @@ infinity values:
 .RS
 If
 .I fp
-is a NaN, +NaN, or -NaN, and
+is a NaN, +NaN, or \-NaN, and
 .B f
 (or
 .BR a ,
 .BR e ,
 .BR g )
-is the conversion specifier, the conversion is to "nan", "nan", or "-nan",
+is the conversion specifier, the conversion is to "nan", "nan", or "\-nan",
 respectively.
 If
 .B F
@@ -141,7 +141,7 @@ If
 .BR A ,
 .BR E ,
 .BR G )
-is the conversion specifier, the conversion is to "NAN" or "-NAN".
+is the conversion specifier, the conversion is to "NAN" or "\-NAN".
 .PP
 Likewise if
 .I fp
man3/strftime.3 +1 -1
index d33c0f5ec..15616116d 100644
@@ -424,7 +424,7 @@ conversion specification corresponds to the full alternative year representation
 The
 .I +hhmm
 or
-.I -hhmm
+.I \-hhmm
 numeric timezone (that is, the hour and minute offset from UTC). (SU)
 .TP
 .B %Z
man3/system.3 +1 -1
index 997b1a3de..21f2e0304 100644
@@ -50,7 +50,7 @@ as follows:
 .PP
 .in +4n
 .EX
-execl("/bin/sh", "sh", "-c", command, (char *) NULL);
+execl("/bin/sh", "sh", "\-c", command, (char *) NULL);
 .EE
 .in
 .PP
Signature · 1 line
2.27.0
#1 lore raw

Hello Bjarni,

Quoted 3 lines · Bjarni Ingi Gislason

Change '-' to '\-' for the prefix of names to indicate an option.

Patch applied, but:

Quoted 10 lines
---
 man3/dlopen.3             | 2 +-
 man3/fts.3                | 2 +-
 man3/getsubopt.3          | 2 +-
 man3/insque.3             | 2 +-
 man3/mq_getattr.3         | 2 +-
 man3/posix_spawn.3        | 8 ++++----
 man3/pthread_setname_np.3 | 2 +-
 man3/sincos.3             | 2 +-
 man3/strfromd.3           | 6 +++---

The above piece was broken, so I applied manually. Was your patch against master?

Thanks,

Michael

Quoted 182 lines
 man3/strftime.3           | 2 +-
 man3/system.3             | 2 +-
 11 files changed, 16 insertions(+), 16 deletions(-)
man3/dlopen.3 +1 -1
index 8629af83e..eec6f9980 100644
@@ -596,7 +596,7 @@ main(void)
        The 2013 Technical Corrigendum 1 to POSIX.1-2008 improved matters
        by requiring that conforming implementations support casting
        'void *' to a function pointer.  Nevertheless, some compilers
-       (e.g., gcc with the '-pedantic' option) may complain about the
+       (e.g., gcc with the '\-pedantic' option) may complain about the
        cast used in this program. */
 .\" http://pubs.opengroup.org/onlinepubs/009695399/functions/dlsym.html#tag_03_112_08
 .\" http://pubs.opengroup.org/onlinepubs/9699919799/functions/dlsym.html#tag_16_96_07
man3/fts.3 +1 -1
index bbd5cad5e..0d455149d 100644
@@ -822,7 +822,7 @@ In versions of glibc before 2.23,
 .\" https://sourceware.org/bugzilla/show_bug.cgi?id=11460
 all of the APIs described in this man page are not safe when compiling
 a program using the LFS APIs (e.g., when compiling with
-.IR -D_FILE_OFFSET_BITS=64 ).
+.IR \-D_FILE_OFFSET_BITS=64 ).
 .\"
 .\" The following statement is years old, and seems no closer to
 .\" being true -- mtk
man3/getsubopt.3 +1 -1
index 6cf2d7a82..cef57fde7 100644
@@ -53,7 +53,7 @@ parses the list of comma-separated suboptions provided in
 (Such a suboption list is typically produced when
 .BR getopt (3)
 is used to parse a command line;
-see for example the \fI-o\fP option of
+see for example the \fI\-o\fP option of
 .BR mount (8).)
 Each suboption may include an associated value,
 which is separated from the suboption name by an equal sign.
man3/insque.3 +1 -1
index 2a957f24c..a9fc28550 100644
@@ -155,7 +155,7 @@ Here is an example run of the program:
 .PP
 .in +4n
 .EX
-.RB "$ " "./a.out -c a b c"
+.RB "$ " "./a.out \-c a b c"
 Traversing completed list:
     a
     b
man3/mq_getattr.3 +1 -1
index 74ef0492f..771316472 100644
@@ -185,7 +185,7 @@ can be used to control the defaults:
 .PP
 .in +4n
 .EX
-$ \fBuname -sr\fP
+$ \fBuname \-sr\fP
 Linux 3.8.0
 $ \fBcat /proc/sys/fs/mqueue/msg_default\fP
 10
man3/posix_spawn.3 +4 -4
index 54fe775cc..f425a39e3 100644
@@ -631,7 +631,7 @@ fails when trying to perform output and exits with a status of 1.
 .PP
 .in +4
 .EX
-$ \fB./a.out -c date\fP
+$ \fB./a.out \-c date\fP
 PID of child: 7636
 date: write error: Bad file descriptor
 Child status: exited, status=1
@@ -655,14 +655,14 @@ can't be blocked).
 .PP
 .in +4
 .EX
-$ \fB./a.out -s sleep 60 &\fP
+$ \fB./a.out \-s sleep 60 &\fP
 [1] 7637
 $ PID of child: 7638
 
 $ \fBkill 7638\fP
-$ \fBkill -KILL 7638\fP
+$ \fBkill \-KILL 7638\fP
 $ Child status: killed by signal 9
-[1]+  Done                    ./a.out -s sleep 60
+[1]+  Done                    ./a.out \-s sleep 60
 .EE
 .in
 .PP
man3/pthread_setname_np.3 +1 -1
index acea0b468..883464755 100644
@@ -141,7 +141,7 @@ Created a thread. Default name is: a.out
 The thread name after setting it is THREADFOO.
 \fB^Z\fP                           # Suspend the program
 [1]+  Stopped           ./a.out
-.RB "$ " "ps H -C a.out -o 'pid tid cmd comm'"
+.RB "$ " "ps H \-C a.out \-o 'pid tid cmd comm'"
   PID   TID CMD                         COMMAND
  5990  5990 ./a.out                     a.out
  5990  5991 ./a.out                     THREADFOO
man3/sincos.3 +1 -1
index 7d5c29724..8ec3e9ca1 100644
@@ -94,7 +94,7 @@ built-in optimizations, using flags such as:
 .PP
 .in +4n
 .EX
-cc -O \-lm \-fno\-builtin prog.c
+cc \-O \-lm \-fno\-builtin prog.c
 .EE
 .in
 .SH BUGS
man3/strfromd.3 +3 -3
index 84cc08068..8092e645d 100644
@@ -127,13 +127,13 @@ infinity values:
 .RS
 If
 .I fp
-is a NaN, +NaN, or -NaN, and
+is a NaN, +NaN, or \-NaN, and
 .B f
 (or
 .BR a ,
 .BR e ,
 .BR g )
-is the conversion specifier, the conversion is to "nan", "nan", or "-nan",
+is the conversion specifier, the conversion is to "nan", "nan", or "\-nan",
 respectively.
 If
 .B F
@@ -141,7 +141,7 @@ If
 .BR A ,
 .BR E ,
 .BR G )
-is the conversion specifier, the conversion is to "NAN" or "-NAN".
+is the conversion specifier, the conversion is to "NAN" or "\-NAN".
 .PP
 Likewise if
 .I fp
man3/strftime.3 +1 -1
index d33c0f5ec..15616116d 100644
@@ -424,7 +424,7 @@ conversion specification corresponds to the full alternative year representation
 The
 .I +hhmm
 or
-.I -hhmm
+.I \-hhmm
 numeric timezone (that is, the hour and minute offset from UTC). (SU)
 .TP
 .B %Z
man3/system.3 +1 -1
index 997b1a3de..21f2e0304 100644
@@ -50,7 +50,7 @@ as follows:
 .PP
 .in +4n
 .EX
-execl("/bin/sh", "sh", "-c", command, (char *) NULL);
+execl("/bin/sh", "sh", "\-c", command, (char *) NULL);
 .EE
 .in
 .PP
Signature · 3 lines
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
#2 lore raw
Quoted 20 lines · Michael Kerrisk (man-pages)

Hello Bjarni,

Quoted 3 lines · Bjarni Ingi Gislason

Change '-' to '\-' for the prefix of names to indicate an option.

Patch applied, but:

Quoted 10 lines
---
 man3/dlopen.3             | 2 +-
 man3/fts.3                | 2 +-
 man3/getsubopt.3          | 2 +-
 man3/insque.3             | 2 +-
 man3/mq_getattr.3         | 2 +-
 man3/posix_spawn.3        | 8 ++++----
 man3/pthread_setname_np.3 | 2 +-
 man3/sincos.3             | 2 +-
 man3/strfromd.3           | 6 +++---
Quoted 3 lines

The above piece was broken, so I applied manually. Was your patch against master?

I always use my own copy of the repository where I apply my new
patches to.

The difference is the non-applied patches to master, that change a
two-fonts macro to a single-font macro for a single argument.

In this case in the man3/strfromd.3, ".B f" (master has ".BR f").

So my "git pull" sometimes causes a merge conflict, which is easy for
me to correct.

Signature · 1 line
Bjarni I. Gislason
#3 lore raw
Quoted 21 lines · Bjarni Ingi Gislason
Quoted 20 lines · Michael Kerrisk (man-pages)

Hello Bjarni,

Quoted 3 lines · Bjarni Ingi Gislason

Change '-' to '\-' for the prefix of names to indicate an option.

Patch applied, but:

Quoted 10 lines
---
 man3/dlopen.3             | 2 +-
 man3/fts.3                | 2 +-
 man3/getsubopt.3          | 2 +-
 man3/insque.3             | 2 +-
 man3/mq_getattr.3         | 2 +-
 man3/posix_spawn.3        | 8 ++++----
 man3/pthread_setname_np.3 | 2 +-
 man3/sincos.3             | 2 +-
 man3/strfromd.3           | 6 +++---
Quoted 5 lines
Quoted 3 lines

The above piece was broken, so I applied manually. Was your patch against master?

I always use my own copy of the repository where I apply my new
patches to.

Please don't. When I've rejected particular changes (as below), for reasons that I already explained (several times), then basing your patches on private repo that still has those changes will just cause breakage and wasted time for me. Please base patches off a pristine master.

Thanks,

Michael

Quoted 8 lines

The difference is the non-applied patches to master, that change a
two-fonts macro to a single-font macro for a single argument.

In this case in the man3/strfromd.3, ".B f" (master has ".BR f").

So my "git pull" sometimes causes a merge conflict, which is easy for
me to correct.

Signature · 3 lines
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
#4 lore raw
Quoted 25 lines · Michael Kerrisk (man-pages)
Quoted 24 lines · Bjarni Ingi Gislason
Quoted 23 lines · Michael Kerrisk (man-pages)

Hello Bjarni,

Quoted 3 lines · Bjarni Ingi Gislason

Change '-' to '\-' for the prefix of names to indicate an option.

Patch applied, but:

Quoted 10 lines
---
 man3/dlopen.3             | 2 +-
 man3/fts.3                | 2 +-
 man3/getsubopt.3          | 2 +-
 man3/insque.3             | 2 +-
 man3/mq_getattr.3         | 2 +-
 man3/posix_spawn.3        | 8 ++++----
 man3/pthread_setname_np.3 | 2 +-
 man3/sincos.3             | 2 +-
 man3/strfromd.3           | 6 +++---

The above piece was broken, so I applied manually. Was your patch against master?

Quoted 9 lines
Quoted 2 lines

I always use my own copy of the repository where I apply my new
patches to.

Please don't. When I've rejected particular changes (as below), for reasons that I already explained (several times), then basing your patches on private repo that still has those changes will just cause breakage and wasted time for me. Please base patches off a pristine master.

I do not support bad, wrong decisions.

I do not support misuse.

Your "trouble" is a direct consequence of your decisions.

I have already answered your "explanations".

####

"Since breaking out of bad habits, rather than acquiring new
ones, is the toughest part of learning we must expect from that system permanent mental damage for most students exposed to it."

Page xxxvii in:

On the Cruelty of Really Teaching Computing Science

Edsger W. Dykstra (Dijkstra)

SIGCSE Bulletin 1989, 21(1), pages xxv-xxxix.
Also "www.cs.utexas.edu/users/EWD/"

###

"The problems of the real world are primarily those you are
left with when you refuse to apply their effective solutions."

Page xxxviii in:

On the Cruelty of Really Teaching Computing Science

Edsger W. Dykstra (Dijkstra)

SIGCSE Bulletin 1989, 21(1), pages xxv-xxxix.
Also "www.cs.utexas.edu/users/EWD/"

###

It is necessary to consider all consequences of the proposed action in all states of nature.

There are lots of consequences of any given action. Many of the problems of society today are at least partly due to the failure to realize that the "obvious" action taken had so many bad side effects.

Herman Rubin in the Usenet forum "misc.education.science".

Signature · 1 line
Bjarni I. Gislason
#5 lore raw
Quoted 9 lines
Quoted 9 lines
Quoted 2 lines

I always use my own copy of the repository where I apply my new
patches to.

Please don't. When I've rejected particular changes (as below), for reasons that I already explained (several times), then basing your patches on private repo that still has those changes will just cause breakage and wasted time for me. Please base patches off a pristine master.

Quoted 7 lines

I do not support bad, wrong decisions.

I do not support misuse.

Your "trouble" is a direct consequence of your decisions.

I have already answered your "explanations".

So, at first I was giving you the benefit of the doubt, presuming that you were not deliberately sending me patches that might break because they included dependencies on changes that I had explicitly rejected (several times) in the past. You've now made it clear that it was deliberate.

A few of your patches have helpful clean-ups, but the bother of dealing with such nonsense[1] just isn't worth it. Please don't waste time by sending me any further patches; they will be ignored.

Thanks,

Michael

[1] https://marc.info/?l=linux-man&m=154743115806201&w=2

#6 lore raw
Quoted 27 lines · Michael Kerrisk (man-pages)
Quoted 9 lines
Quoted 9 lines
Quoted 2 lines

I always use my own copy of the repository where I apply my new
patches to.

Please don't. When I've rejected particular changes (as below), for reasons that I already explained (several times), then basing your patches on private repo that still has those changes will just cause breakage and wasted time for me. Please base patches off a pristine master.

Quoted 7 lines

I do not support bad, wrong decisions.

I do not support misuse.

Your "trouble" is a direct consequence of your decisions.

I have already answered your "explanations".

So, at first I was giving you the benefit of the doubt, presuming that you were not deliberately sending me patches that might break because they included dependencies on changes that I had explicitly rejected (several times) in the past. You've now made it clear that it was deliberate.

A few of your patches have helpful clean-ups, but the bother of dealing with such nonsense[1] just isn't worth it. Please don't waste time by sending me any further patches; they will be ignored.

Quoted 5 lines

Thanks,

Michael

[1] https://marc.info/?l=linux-man&m=154743115806201&w=2

I do not propagate (pass on) wrongdoings, obstruction of truth,
lies, mistakes, when I am aware of them.

What does your "job" description say about resolving merge conflicts?

Where is your "job" description available?

###

"For what one has forbidden so far as a matter of principle
has always been --- truth alone.". These words are valid for the history of humankind as well as for Nietzsche's family.

Alice Miller "The Untouched key". Virago Press 1990, Page 122.
Original title: "Der gemiedene Schlüssel". 1988.