Thread (9 messages) 9 messages, 3 authors, 2021-07-30

Re: [PATCH] termios.3: Use bold style for Bnn and EXTn macro constants

flat view

From: Pali Rohár <pali@kernel.org>
Date: 2021-07-29 17:23:25

On Thursday 29 July 2021 13:21:40 Alejandro Colomar (man-pages) wrote:
Hi Pali,

On 7/26/21 12:54 AM, Pali Rohár wrote:
quoted
Signed-off-by: Pali Rohár <pali@kernel.org>
---
  man3/termios.3 | 5 +++--
  1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/man3/termios.3 b/man3/termios.3
index 01c20994424d..e603879e18d4 100644
--- a/man3/termios.3
+++ b/man3/termios.3
@@ -1068,8 +1068,9 @@ and
  are nonstandard, but available on the BSDs.
  .SH NOTES
  UNIX\ V7 and several later systems have a list of baud rates
-where after the fourteen values B0, ..., B9600 one finds the
-two constants EXTA, EXTB ("External A" and "External B").
+where after the fourteen values \fBB0\fP, ..., \fBB9600\fP
Could you please use .B and/or .BR instead of inline \fB...\fP?
Ok, no problem. I used inline style because few lines below is already
used this \fIduration\fP inline style.

How do you prefer to format this part? \fBB0\fP, ..., \fBB9600\fP
See this extract from man-pages(7):

       Any  reference  to  the  subject of the current manual page
       should be written with the name in bold followed by a  pair
       of parentheses in Roman (normal) font.  For example, in the
       fcntl(2) man page, references to the subject  of  the  page
       would  be  written as: fcntl().  The preferred way to write
       this in the source file is:

           .BR fcntl ()

       (Using this format, rather than the  use  of  "\fB...\fP()"
       makes  it  easier to write tools that parse man page source
       files.)


Thanks,

Alex
quoted
+one finds the two constants \fBEXTA\fP, \fBEXTB\fP
+("External A" and "External B").
  Many systems extend the list with much higher baud rates.
  .PP
  The effect of a nonzero \fIduration\fP with

-- 
Alejandro Colomar
Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help