diff options
| author | Alejandro Colomar <alx@kernel.org> | 2022-10-26 01:01:32 +0200 |
|---|---|---|
| committer | Alejandro Colomar <alx@kernel.org> | 2022-10-29 23:51:29 +0200 |
| commit | 22356d97e388c79993c94d43109087d3c8740187 (patch) | |
| tree | 3746eae8880200683dc61f1c44d55e3d62649dfd /man3/readdir_r.3 | |
| parent | 4279e42dd98a11b31fa4e1fcebbb00b7a677bb70 (diff) | |
| download | man-pages-22356d97e388c79993c94d43109087d3c8740187.tar.gz | |
Many pages: Use a consistent style for lists
There are different kinds of lists:
Tagged paragraphs
These are fixed in a separate commit (the previous one).
They are used for a list of tags and their descriptions.
An example is this commit message itself.
Ordered lists
Elements are preceeded by a number in parentheses.
These represent a set of steps that have an order.
When there are substeps, they will be numbered like (4.2).
Positional lists
Elements are preceeded by a number in square brackets
(index). These represent fields in a set. The index will
start at:
0 fields of a C data structure, to be consistent
with arrays.
1 fields of a file, to be consistent with tools like
cut(1).
Alternatives list
Elements are preceeded by a letter in parentheses.
These represent a set of (normally) exclusive
alternatives.
Bullet lists
Elements are preceeded by bullet symbols. Anything that
doesn't fit elsewhere usually is covered by this type of
list.
Notes
Not really a list, but the syntax is identical to
"positional lists".
There should always be 2 spaces between the list symbol and the
elements. This doesn't apply to "tagged paragraphs", which use
the default indentation rules.
Reported-by: Mike Frysinger <vapier@gentoo.org>
Cc: <groff@gnu.org>
Acked-by: Douglas McIlroy <douglas.mcilroy@dartmouth.edu>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
Diffstat (limited to 'man3/readdir_r.3')
| -rw-r--r-- | man3/readdir_r.3 | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/man3/readdir_r.3 b/man3/readdir_r.3 index 7ce6aadf11..b32ab4c5ee 100644 --- a/man3/readdir_r.3 +++ b/man3/readdir_r.3 @@ -59,14 +59,14 @@ instead of Furthermore, since version 2.24, glibc deprecates .BR readdir_r (). The reasons are as follows: -.IP * 3 +.IP \(bu 3 On systems where .B NAME_MAX is undefined, calling .BR readdir_r () may be unsafe because the interface does not allow the caller to specify the length of the buffer used for the returned directory entry. -.IP * +.IP \(bu On some systems, .BR readdir_r () can't read directory entries with very long names. @@ -80,7 +80,7 @@ On some other systems, may return a success status, but the returned .I d_name field may not be null terminated or may be truncated. -.IP * +.IP \(bu In the current POSIX.1 specification (POSIX.1-2008), .BR readdir (3) is not required to be thread-safe. @@ -97,7 +97,7 @@ using with external synchronization is still preferable to the use of .BR readdir_r (), for the reasons given in the points above. -.IP * +.IP \(bu It is expected that a future version of POSIX.1 .\" FIXME . .\" http://www.austingroupbugs.net/view.php?id=696 |