Sort sections. Fix typo. Remove superfluous Pp.

This commit is contained in:
wiz 2019-04-06 07:56:49 +00:00
parent 5772cf82d8
commit 86980933f2
1 changed files with 12 additions and 14 deletions

View File

@ -1,4 +1,4 @@
.\" $NetBSD: ucas.9,v 1.3 2019/04/06 03:06:24 thorpej Exp $
.\" $NetBSD: ucas.9,v 1.4 2019/04/06 07:56:49 wiz Exp $
.\"
.\" Copyright (c) 2019 Jason R. Thorpe.
.\" Copyright (c) 2011 YAMAMOTO Takashi,
@ -52,7 +52,6 @@ user-space address.
Except that they can be safely used for the kernel to access user-space
address, they are semantically equivalents of
.Xr atomic_cas 3 .
.Pp
.Bl -tag -width uptr
.It Fa uptr
The pointer to the variable.
@ -65,16 +64,6 @@ The value to store to the variable.
The pointer to the memory to store the old value of the variable.
.El
.\" ------------------------------------------------------------
.Sh RETURN VALUES
On success, these functions return 0.
In that case, the caller can consult the value returned via
.Fa retp
to check the result of the CAS operation.
Otherwise, these functions return an appropriate
.Xr errno 9
error code, typically
.Dv EFAULT .
.\" ------------------------------------------------------------
.Sh IMPLEMENTATION NOTES
The
.Nm ucas
@ -87,7 +76,6 @@ primitives have the following signatures and are considered private to
the implementation and are not to be called by consumers of the
.Nm ucas
API:
.Pp
.Bl -tag -width _ucas_32
.It Ft int Fn _ucas_32 \
"volatile uint32_t *uptr" "uint32_t old" "uint32_t new" "uint32_t *retp" ;
@ -139,7 +127,7 @@ operations
and the multiprocessor implementation synchronizes with other CPUs using
interprocessor interrupts.
.Pp
If a particular platform wishes ro use the generic implementation on
If a particular platform wishes to use the generic implementation on
uniprocessors but an optimized implementation on multiprocessors, the
the platform should define
.Dv __HAVE_UCAS_MP
@ -155,6 +143,16 @@ if an
platform
.Pc .
.\" ------------------------------------------------------------
.Sh RETURN VALUES
On success, these functions return 0.
In that case, the caller can consult the value returned via
.Fa retp
to check the result of the CAS operation.
Otherwise, these functions return an appropriate
.Xr errno 9
error code, typically
.Dv EFAULT .
.\" ------------------------------------------------------------
.Sh SEE ALSO
.Xr atomic_cas 3 ,
.Xr intro 9