Re: [PATCH 1/2] cc_t.3type, speed_t.3type, tcflag_t.3type: document all together

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

 



Hi!

On Tue, Aug 30, 2022 at 12:16:58AM +0200, Alejandro Colomar wrote:
> Types are formatted with .I, but that seems to be existing practice and I
> don't find it documented anywhere.  (Branden, do you know of any source that
> discusses this?  Is it also like that in other manual pages?  Would you do
> that even if it is the main subject of the page?)

I'd used B because the typedefs in SYNOPSIS were B.

(FWIW mdoc agrees ‒ groff and mandoc Vt are italic in all output modes)

> > +is used for terminal special characters,
> > +.B speed_t
> > +\(em baud rates, and
> I would use a 'for' here:
> A is used for X, B for Y, and C for Z.
> rather than
> A is used for X, B -- Y, and C--Z.

Sure, see updated scissor-patch below.

Best,

-- >8 --
speed_t and tcflag_t were both unmentioned in general

Issue 7 has this to say:
  The <termios.h> header shall define the following data types through typedef:
    cc_t     Used for terminal special characters.
    speed_t  Used for terminal baud rates.
    tcflag_t Used for terminal modes.
  The above types shall be all unsigned integer types.
---
 man3type/cc_t.3type     | 14 +++++++++++---
 man3type/speed_t.3type  |  1 +
 man3type/tcflag_t.3type |  1 +
 3 files changed, 13 insertions(+), 3 deletions(-)
 create mode 100644 man3type/speed_t.3type
 create mode 100644 man3type/tcflag_t.3type

diff --git a/man3type/cc_t.3type b/man3type/cc_t.3type
index 029cf945c..6414dbf20 100644
--- a/man3type/cc_t.3type
+++ b/man3type/cc_t.3type
@@ -6,7 +6,7 @@
 .\"
 .TH CC_T 3type 2021-11-02 "Linux man-pages (unreleased)"
 .SH NAME
-cc_t \- terminal special characters
+cc_t, speed_t, tcflag_t \- terminal special characters, baud rates, modes
 .SH LIBRARY
 Standard C library
 .RI ( libc )
@@ -15,10 +15,18 @@ Standard C library
 .B #include <termios.h>
 .PP
 .BR typedef " /* ... */ " cc_t;
+.BR typedef " /* ... */ " speed_t;
+.BR typedef " /* ... */ " tcflag_t;
 .fi
 .SH DESCRIPTION
-Used for terminal special characters.
-It is an unsigned integer type.
+.I cc_t
+is used for terminal special characters,
+.I speed_t
+for baud rates, and
+.I tcflag_t
+for modes.
+.PP
+All are unsigned integer types.
 .SH STANDARDS
 POSIX.1-2001 and later.
 .SH SEE ALSO
diff --git a/man3type/speed_t.3type b/man3type/speed_t.3type
new file mode 100644
index 000000000..26cfd0171
--- /dev/null
+++ b/man3type/speed_t.3type
@@ -0,0 +1 @@
+.so man3type/cc_t.3type
diff --git a/man3type/tcflag_t.3type b/man3type/tcflag_t.3type
new file mode 100644
index 000000000..26cfd0171
--- /dev/null
+++ b/man3type/tcflag_t.3type
@@ -0,0 +1 @@
+.so man3type/cc_t.3type
-- 
2.30.2

Attachment: signature.asc
Description: PGP 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