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/clock.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/clock.3')
| -rw-r--r-- | man3/clock.3 | 29 |
1 files changed, 16 insertions, 13 deletions
diff --git a/man3/clock.3 b/man3/clock.3 index 49d92238c3..6dfce042ac 100644 --- a/man3/clock.3 +++ b/man3/clock.3 @@ -48,23 +48,11 @@ T} Thread safety MT-Safe .hy .ad .sp 1 -.SH STANDARDS -POSIX.1-2001, POSIX.1-2008, C89, C99. +.SH VERSIONS XSI requires that .B CLOCKS_PER_SEC equals 1000000 independent of the actual resolution. -.SH NOTES -The C standard allows for arbitrary values at the start of the program; -subtract the value returned from a call to -.BR clock () -at the start of the program to get maximum portability. -.PP -Note that the time can wrap around. -On a 32-bit system where -.B CLOCKS_PER_SEC -equals 1000000 this function will return the same -value approximately every 72 minutes. .PP On several other implementations, the value returned by @@ -84,6 +72,10 @@ The .BR times (2) function, which explicitly returns (separate) information about the caller and its children, may be preferable. +.SH STANDARDS +C11, POSIX.1-2008. +.SH HISTORY +POSIX.1-2001, C89. .PP In glibc 2.17 and earlier, .BR clock () @@ -95,6 +87,17 @@ since glibc 2.18, it is implemented on top of (using the .B CLOCK_PROCESS_CPUTIME_ID clock). +.SH NOTES +The C standard allows for arbitrary values at the start of the program; +subtract the value returned from a call to +.BR clock () +at the start of the program to get maximum portability. +.PP +Note that the time can wrap around. +On a 32-bit system where +.B CLOCKS_PER_SEC +equals 1000000 this function will return the same +value approximately every 72 minutes. .SH SEE ALSO .BR clock_gettime (2), .BR getrusage (2), |