* [PATCH v3 12/13] intro.3: wfix
@ 2023-01-05 22:53 G. Branden Robinson
0 siblings, 0 replies; only message in thread
From: G. Branden Robinson @ 2023-01-05 22:53 UTC (permalink / raw)
To: Alejandro Colomar; +Cc: linux-man
[-- Attachment #1: Type: text/plain, Size: 2144 bytes --]
* Tighten cross reference. It wastes words to tell people to look
elsewhere "for further information". Why else would they look there?
* Use passive voice less.
* Relocate sentence for more coherent discussion.
* Say "application _programming_ interface".
Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
---
man3/intro.3 | 23 ++++++++++++-----------
1 file changed, 12 insertions(+), 11 deletions(-)
diff --git a/man3/intro.3 b/man3/intro.3
index df911e749..d2c8c132e 100644
--- a/man3/intro.3
+++ b/man3/intro.3
@@ -42,9 +42,8 @@ must be defined before including
.I any
header files.)
In such cases,
-the required macro is described in the man page.
-For further information on feature test macros,
-see
+the relevant function's man page describes the required macro.
+See
.BR \%feature_test_macros (7).
.\"
.\" There
@@ -77,9 +76,16 @@ see
.\" Various special libraries. The manual pages documenting their functions
.\" specify the library names.
.SS Subsections
-Section 3 of this manual is organized into subsections
+The Linux
+.I man-pages
+organize section 3 into subsections
that reflect the complex structure of the standard C library
-and its many implementations:
+and its many implementations.
+.IR libc 's
+difficult history frequently makes it a poor example to follow
+in design,
+implementation,
+and presentation.
.IP \(bu 3
3const
.IP \(bu
@@ -87,11 +93,6 @@ and its many implementations:
.IP \(bu
3type
.PP
-This difficult history frequently makes it a poor example to follow
-in design,
-implementation,
-and presentation.
-.PP
Ideally,
a library for the C language
is designed such that each header file
@@ -101,7 +102,7 @@ and exposes only data types and constants that
are required for use of those functions.
Together,
these are termed an API or
-.IR "application program interface" .
+.IR "application programming interface" .
Types and constants to be shared among multiple APIs
should be placed in header files that declare no functions.
This organization permits a C library module
--
2.30.2
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
^ permalink raw reply related [flat|nested] only message in thread
only message in thread, other threads:[~2023-01-05 22:53 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-01-05 22:53 [PATCH v3 12/13] intro.3: wfix G. Branden Robinson
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).