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

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

[наб]

[-- Attachment #1: Type: text/plain, Size: 1924 bytes --]

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..0afdd2cd0 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.
+.B cc_t
+is used for terminal special characters,
+.B speed_t
+\(em baud rates, and
+.B tcflag_t
+\(em 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 #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

[PATCH 2/2] termios.3: mention the integer types in SEE ALSO

[наб]

[-- Attachment #1: Type: text/plain, Size: 382 bytes --]

---
 man3/termios.3 | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/man3/termios.3 b/man3/termios.3
index 5d6370d94..c28826104 100644
--- a/man3/termios.3
+++ b/man3/termios.3
@@ -1185,4 +1185,7 @@ mask).
 .BR tty (1),
 .BR ioctl_console (2),
 .BR ioctl_tty (2),
+.BR cc_t (3type),
+.BR speed_t (3type),
+.BR tcflag_t (3type),
 .BR setserial (8)
-- 
2.30.2

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

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

[Alejandro Colomar]

[-- Attachment #1.1: Type: text/plain, Size: 2611 bytes --]

Hi наб, Branden,

On 8/29/22 23:46, наб wrote:
> 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..0afdd2cd0 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.
> +.B cc_t

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?)



> +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.

Best,

Alex


> +.B tcflag_t
> +\(em 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

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

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

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

[наб]

[-- Attachment #1: Type: text/plain, Size: 2695 bytes --]

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 #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

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

[Alejandro Colomar]

[-- Attachment #1.1: Type: text/plain, Size: 3088 bytes --]

Hi!

On 8/30/22 00:33, наб wrote:
> 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.

I just realized you didn't sign the patches.  Will sign them on your 
behalf if you want.

Cheers,

Alex

> ---
>   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

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

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

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

[наб]

[-- Attachment #1: Type: text/plain, Size: 205 bytes --]

On Tue, Aug 30, 2022 at 12:36:37AM +0200, Alejandro Colomar wrote:
> I just realized you didn't sign the patches.  Will sign them on your behalf
> if you want.

Yes, please :) I forgor 💀

наб

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

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

[Alejandro Colomar]

[-- Attachment #1.1: Type: text/plain, Size: 489 bytes --]

On 8/30/22 00:48, наб wrote:
> On Tue, Aug 30, 2022 at 12:36:37AM +0200, Alejandro Colomar wrote:
>> I just realized you didn't sign the patches.  Will sign them on your behalf
>> if you want.
> 
> Yes, please :) I forgor 💀
> 
> наб

Patch set applied and signed.
<http://www.alejandro-colomar.es/src/alx/linux/man-pages/man-pages.git/commit/?id=96f55464bc2004cd986e7ee0976f87ff0c882e0d>

Cheers,

Alex

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

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]