[PATCH] stdc_count_ones.3, stdc_count_zeros.3: Add manual pages

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

 



Hello again!

I noticed that manuals are missing for all of the new stdbit.h functions.
I had some spare time, so I wrote up a quick set of manuals for these two
functions.  I hope I followed the style correctly; I tried to copy what I
saw in other manual pages.

Signed-off-by: Thomas Voss <mail@xxxxxxxxxxxxxx>
---
 man/man3/stdc_count_ones.3      | 65 +++++++++++++++++++++++++++++++++
 man/man3/stdc_count_ones_uc.3   |  1 +
 man/man3/stdc_count_ones_ui.3   |  1 +
 man/man3/stdc_count_ones_ul.3   |  1 +
 man/man3/stdc_count_ones_ull.3  |  1 +
 man/man3/stdc_count_ones_us.3   |  1 +
 man/man3/stdc_count_zeros.3     | 64 ++++++++++++++++++++++++++++++++
 man/man3/stdc_count_zeros_uc.3  |  1 +
 man/man3/stdc_count_zeros_ui.3  |  1 +
 man/man3/stdc_count_zeros_ul.3  |  1 +
 man/man3/stdc_count_zeros_ull.3 |  1 +
 man/man3/stdc_count_zeros_us.3  |  1 +
 12 files changed, 139 insertions(+)
 create mode 100644 man/man3/stdc_count_ones.3
 create mode 100644 man/man3/stdc_count_ones_uc.3
 create mode 100644 man/man3/stdc_count_ones_ui.3
 create mode 100644 man/man3/stdc_count_ones_ul.3
 create mode 100644 man/man3/stdc_count_ones_ull.3
 create mode 100644 man/man3/stdc_count_ones_us.3
 create mode 100644 man/man3/stdc_count_zeros.3
 create mode 100644 man/man3/stdc_count_zeros_uc.3
 create mode 100644 man/man3/stdc_count_zeros_ui.3
 create mode 100644 man/man3/stdc_count_zeros_ul.3
 create mode 100644 man/man3/stdc_count_zeros_ull.3
 create mode 100644 man/man3/stdc_count_zeros_us.3

diff --git a/man/man3/stdc_count_ones.3 b/man/man3/stdc_count_ones.3
new file mode 100644
index 0000000..5cfc3cf
--- /dev/null
+++ b/man/man3/stdc_count_ones.3
@@ -0,0 +1,65 @@
+'\" t
+.\" Copyright (c) 2024 by Thomas Voss <mail@xxxxxxxxxxxxxx>
+.\"
+.\" SPDX-License-Identifier: Linux-man-pages-copyleft
+.\"
+.\"
+.TH stdc_count_ones 3 (date) "Linux man-pages (unreleased)"
+.SH NAME
+stdc_count_ones, stdc_count_ones_uc, stdc_count_ones_us,
+stdc_count_ones_ui, stdc_count_ones_ul, stdc_count_ones_ull \- count set
+bits
+.SH LIBRARY
+Standard C library
+.RI ( libc )
+.SH SYNOPSIS
+.nf
+.B #include <stdbit.h>
+.P
+.BI "generic_return_type stdc_count_ones(generic_value_type " value );
+.BI "unsigned int stdc_count_ones_uc(unsigned char " value );
+.BI "unsigned int stdc_count_ones_us(unsigned short " value );
+.BI "unsigned int stdc_count_ones_ui(unsigned int " value );
+.BI "unsigned int stdc_count_ones_ul(unsigned long " value );
+.BI "unsigned int stdc_count_ones_ull(unsigned long long " value );
+.fi
+.SH DESCRIPTION
+These functions return the total number of 1 bits in
+.IR value .
+This operation is also often known as a pop count.
+.P
+.B generic_value_type
+may be any unsigned integer type excluding
+.B bool
+and bit-precise integer types
+(unless they have a width which matches a standard integer type),
+while
+.B generic_value_type
+is an unspecified unsigned type.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lbx lb lb
+l l l.
+Interface	Attribute	Value
+T{
+.na
+.nh
+.BR stdc_count_ones (),
+.BR stdc_count_ones_uc (),
+.BR stdc_count_ones_us (),
+.BR stdc_count_ones_ui (),
+.BR stdc_count_ones_ul (),
+.BR stdc_count_ones_ull ()
+T}	Thread safety	MT-Safe
+.TE
+.SH STANDARDS
+C23.
+.SH SEE ALSO
+.BR stdc_count_zeros () ,
+.BR stdc_leading_ones () ,
+.BR stdc_leading_zeros () ,
+.BR stdc_trailing_ones () ,
+.BR stdc_trailing_zeros ()
diff --git a/man/man3/stdc_count_ones_uc.3 b/man/man3/stdc_count_ones_uc.3
new file mode 100644
index 0000000..f075079
--- /dev/null
+++ b/man/man3/stdc_count_ones_uc.3
@@ -0,0 +1 @@
+.so stdc_count_ones
diff --git a/man/man3/stdc_count_ones_ui.3 b/man/man3/stdc_count_ones_ui.3
new file mode 100644
index 0000000..f075079
--- /dev/null
+++ b/man/man3/stdc_count_ones_ui.3
@@ -0,0 +1 @@
+.so stdc_count_ones
diff --git a/man/man3/stdc_count_ones_ul.3 b/man/man3/stdc_count_ones_ul.3
new file mode 100644
index 0000000..f075079
--- /dev/null
+++ b/man/man3/stdc_count_ones_ul.3
@@ -0,0 +1 @@
+.so stdc_count_ones
diff --git a/man/man3/stdc_count_ones_ull.3 b/man/man3/stdc_count_ones_ull.3
new file mode 100644
index 0000000..f075079
--- /dev/null
+++ b/man/man3/stdc_count_ones_ull.3
@@ -0,0 +1 @@
+.so stdc_count_ones
diff --git a/man/man3/stdc_count_ones_us.3 b/man/man3/stdc_count_ones_us.3
new file mode 100644
index 0000000..f075079
--- /dev/null
+++ b/man/man3/stdc_count_ones_us.3
@@ -0,0 +1 @@
+.so stdc_count_ones
diff --git a/man/man3/stdc_count_zeros.3 b/man/man3/stdc_count_zeros.3
new file mode 100644
index 0000000..b29118d
--- /dev/null
+++ b/man/man3/stdc_count_zeros.3
@@ -0,0 +1,64 @@
+'\" t
+.\" Copyright (c) 2024 by Thomas Voss <mail@xxxxxxxxxxxxxx>
+.\"
+.\" SPDX-License-Identifier: Linux-man-pages-copyleft
+.\"
+.\"
+.TH stdc_count_zeros 3 (date) "Linux man-pages (unreleased)"
+.SH NAME
+stdc_count_zeros, stdc_count_zeros_uc, stdc_count_zeros_us,
+stdc_count_zeros_ui, stdc_count_zeros_ul,
+stdc_count_zeros_ull \- count unset bits
+.SH LIBRARY
+Standard C library
+.RI ( libc )
+.SH SYNOPSIS
+.nf
+.B #include <stdbit.h>
+.P
+.BI "generic_return_type stdc_count_zeros(generic_value_type " value );
+.BI "unsigned int stdc_count_zeros_uc(unsigned char " value );
+.BI "unsigned int stdc_count_zeros_us(unsigned short " value );
+.BI "unsigned int stdc_count_zeros_ui(unsigned int " value );
+.BI "unsigned int stdc_count_zeros_ul(unsigned long " value );
+.BI "unsigned int stdc_count_zeros_ull(unsigned long long " value );
+.fi
+.SH DESCRIPTION
+These functions return the total number of 0 bits in
+.IR value .
+.P
+.B generic_value_type
+may be any unsigned integer type excluding
+.B bool
+and bit-precise integer types
+(unless they have a width which matches a standard integer type),
+while
+.B generic_value_type
+is an unspecified unsigned type.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lbx lb lb
+l l l.
+Interface	Attribute	Value
+T{
+.na
+.nh
+.BR stdc_count_zeros (),
+.BR stdc_count_zeros_uc (),
+.BR stdc_count_zeros_us (),
+.BR stdc_count_zeros_ui (),
+.BR stdc_count_zeros_ul (),
+.BR stdc_count_zeros_ull ()
+T}	Thread safety	MT-Safe
+.TE
+.SH STANDARDS
+C23.
+.SH SEE ALSO
+.BR stdc_count_ones () ,
+.BR stdc_leading_ones () ,
+.BR stdc_leading_zeros () ,
+.BR stdc_trailing_ones () ,
+.BR stdc_trailing_zeros ()
diff --git a/man/man3/stdc_count_zeros_uc.3 b/man/man3/stdc_count_zeros_uc.3
new file mode 100644
index 0000000..a644881
--- /dev/null
+++ b/man/man3/stdc_count_zeros_uc.3
@@ -0,0 +1 @@
+.so stdc_count_zeros
diff --git a/man/man3/stdc_count_zeros_ui.3 b/man/man3/stdc_count_zeros_ui.3
new file mode 100644
index 0000000..a644881
--- /dev/null
+++ b/man/man3/stdc_count_zeros_ui.3
@@ -0,0 +1 @@
+.so stdc_count_zeros
diff --git a/man/man3/stdc_count_zeros_ul.3 b/man/man3/stdc_count_zeros_ul.3
new file mode 100644
index 0000000..a644881
--- /dev/null
+++ b/man/man3/stdc_count_zeros_ul.3
@@ -0,0 +1 @@
+.so stdc_count_zeros
diff --git a/man/man3/stdc_count_zeros_ull.3 b/man/man3/stdc_count_zeros_ull.3
new file mode 100644
index 0000000..a644881
--- /dev/null
+++ b/man/man3/stdc_count_zeros_ull.3
@@ -0,0 +1 @@
+.so stdc_count_zeros
diff --git a/man/man3/stdc_count_zeros_us.3 b/man/man3/stdc_count_zeros_us.3
new file mode 100644
index 0000000..a644881
--- /dev/null
+++ b/man/man3/stdc_count_zeros_us.3
@@ -0,0 +1 @@
+.so stdc_count_zeros
-- 
2.46.1





[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