diff options
| author | Alejandro Colomar <alx@kernel.org> | 2023-03-17 17:08:01 +0100 |
|---|---|---|
| committer | Alejandro Colomar <alx@kernel.org> | 2023-03-30 15:14:55 +0200 |
| commit | 4131356cdab8d37fc395ca5466a0401c8573380c (patch) | |
| tree | 8c4c6f1c3172358b735b481cbbfdd9cc04b00ed9 /man3/readdir.3 | |
| parent | fd00f831b52d61a91d59cb3b46182869145d9700 (diff) | |
| download | man-pages-4131356cdab8.tar.gz | |
man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections
- Add a new HISTORY section that covers the history of an API, both
regarding implementations and regarding old standards. This was
previously covered in VERSIONS, and in some cases in STANDARDS.
- Repurpose VERSIONS to cover differing implementations in _current_
systems.
- STANDARDS is reduced to only cover current versions of standards.
That basically means only C11 (C99 has been superseeded by C11; C17
is just a bugfix of C11, so not really a new version), and
POSIX.1-2008 (*-2001 was superseeded by *-2008; *-2017 was just a
bugfix for *-2008). The section also mentions for example 'Linux',
'GNU' or 'BSD' when a non-standard API is Linux- or GNU-only or if
it's (de-facto) standard in the BSDs.
- In some cases content that should go into one of these sections was
in NOTES. Move it from there to where it corresponds.
- In the SYNOPSIS, I added [[deprecated]] in some functions that I
found are deprecated by the relevant standards.
- A few other related changes...
Cc: Oskari Pirhonen <xxc3ncoredxx@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
Diffstat (limited to 'man3/readdir.3')
| -rw-r--r-- | man3/readdir.3 | 24 |
1 files changed, 13 insertions, 11 deletions
diff --git a/man3/readdir.3 b/man3/readdir.3 index 54f1d39c9f..cdb03ab332 100644 --- a/man3/readdir.3 +++ b/man3/readdir.3 @@ -209,17 +209,7 @@ It is expected that a future version of POSIX.1 will require that .BR readdir () be thread-safe when concurrently employed on different directory streams. -.SH STANDARDS -POSIX.1-2001, POSIX.1-2008, SVr4, 4.3BSD. -.SH NOTES -A directory stream is opened using -.BR opendir (3). -.PP -The order in which filenames are read by successive calls to -.BR readdir () -depends on the filesystem implementation; -it is unlikely that the names will be sorted in any fashion. -.PP +.SH VERSIONS Only the fields .I d_name and (as an XSI extension) @@ -290,6 +280,18 @@ In such cases, the field will contain a value that exceeds the size of the glibc .I dirent structure shown above. +.SH STANDARDS +POSIX.1-2008. +.SH HISTORY +POSIX.1-2001, SVr4, 4.3BSD. +.SH NOTES +A directory stream is opened using +.BR opendir (3). +.PP +The order in which filenames are read by successive calls to +.BR readdir () +depends on the filesystem implementation; +it is unlikely that the names will be sorted in any fashion. .SH SEE ALSO .BR getdents (2), .BR read (2), |