Fix a few mandoc issues

- skipping paragraph macro: Pp after Sh
- sections out of conventional order: Sh EXAMPLES
- whitespace at end of input line
- normalizing date format
This commit is contained in:
Gordon Bergling 2020-10-09 19:12:44 +00:00
parent eb88fed446
commit 3d265fce43
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=366583
48 changed files with 160 additions and 151 deletions

View file

@ -119,7 +119,8 @@ Memory is allocated on a round-robin basis by cycling through each domain in
.Fa mask .
.It Dv DOMAINSET_POLICY_FIRSTTOUCH
Memory is allocated on the domain local to the CPU the requesting thread is
running on. Failure to allocate from this domain will fallback to round-robin.
running on.
Failure to allocate from this domain will fallback to round-robin.
.It Dv DOMAINSET_POLICY_PREFER
Memory is allocated preferentially from the single domain specified in the mask.
If memory is unavailable the domains listed in the parent cpuset will be

View file

@ -28,7 +28,7 @@
.\" @(#)getsockopt.2 8.4 (Berkeley) 5/2/95
.\" $FreeBSD$
.\"
.Dd June 03, 2020
.Dd June 3, 2020
.Dt GETSOCKOPT 2
.Os
.Sh NAME
@ -219,7 +219,8 @@ if they all set
before binding the port.
Incoming TCP and UDP connections are distributed among the sharing
processes based on a hash function of local port number, foreign IP
address and port number. A maximum of 256 processes can share one socket.
address and port number.
A maximum of 256 processes can share one socket.
.Pp
.Dv SO_KEEPALIVE
enables the

View file

@ -52,8 +52,9 @@
.Fa "gss_cred_id_t *delegated_cred_handle"
.Fc
.Sh DESCRIPTION
Allows a remotely initiated security context between the application
and a remote peer to be established. The routine may return a
Allows a remotely initiated security context between the application and a remote
peer to be established.
The routine may return a
.Fa output_token
which should be transferred to the peer application,
where the peer application will present it to
@ -78,7 +79,8 @@ parameters.
.Pp
Portable applications should be constructed to use the token length
and return status to determine whether a token needs to be sent or
waited for. Thus a typical portable caller should always invoke
waited for.
Thus a typical portable caller should always invoke
.Fn gss_accept_sec_context
within a loop:
.Bd -literal
@ -166,10 +168,9 @@ returned to a caller
(i.e. when accompanied by a
.Dv GSS_S_COMPLETE
status code), applications
should not rely on this behavior as the flag was not defined in
Version 1 of the GSS-API. Instead, applications should be prepared to
use per-message services after a successful context establishment,
according to the
should not rely on this behavior as the flag was not defined in Version 1 of the GSS-API.
Instead, applications should be prepared to use per-message services after a
successful context establishment, according to the
.Dv GSS_C_INTEG_FLAG
and
.Dv GSS_C_CONF_FLAG values.
@ -190,9 +191,10 @@ fails, the
implementation should not create a context object, and should leave
the value of the context_handle parameter set to
.Dv GSS_C_NO_CONTEXT to
indicate this. In the event of a failure on a subsequent call, the
implementation is permitted to delete the "half-built" security
context (in which case it should set the
indicate this.
In the event of a failure on a subsequent call, the implementation is
permitted to delete the "half-built" security context (in which case it
should set the
.Fa context_handle
parameter to
.Dv GSS_C_NO_CONTEXT ), but the preferred behavior is to leave the

View file

@ -119,8 +119,8 @@ yields:
path == "../../../sys/kern" /* It's correct but ... */
That is correct, but a little redundant. If you wish get the simple
answer 'kern', do the following.
That is correct, but a little redundant.
If you wish get the simple answer 'kern', do the following.
path = abs2rel(realpath("/sys/kern", r1), realpath("/sys", r2),
result, MAXPATHLEN);

View file

@ -485,7 +485,8 @@ To free the resources used by the RADIUS library, call
.Fn rad_close .
.Ss Server operation
Server mode operates much alike to client mode, except packet send and receive
steps are swapped. To operate as server you should obtain server context with
steps are swapped.
To operate as server you should obtain server context with
.Fn rad_server_open
function, passing opened and bound UDP socket file descriptor as argument.
You should define allowed clients and their secrets using
@ -493,9 +494,9 @@ You should define allowed clients and their secrets using
function. port, timeout and max_tries arguments are ignored in server mode.
You should call
.Fn rad_receive_request
function to receive request from client. If you do not want to block on socket
read, you are free to use any poll(), select() or non-blocking sockets for
the socket.
function to receive request from client.
If you do not want to block on socket read, you are free to use any
poll(), select() or non-blocking sockets for the socket.
Received request can be parsed with same parsing functions as for client.
To respond to the request you should call
.Fn rad_create_response

View file

@ -74,7 +74,8 @@ GSS-API delegated credentials (if any)
.It gss_context
The GSS-API context
.It lock
A structure used to enforce a particular QOP and service. Set
A structure used to enforce a particular QOP and service.
Set
.Fa lock->locked
to
.Dv TRUE

View file

@ -314,15 +314,16 @@ This function returns NULL in case of failure.
.
.Fn libusb20_tr_get_time_complete
will return the completion time of an USB transfer in
millisecond units. This function is most useful for isochronous USB
transfers when doing echo cancelling.
millisecond units.
This function is most useful for isochronous USB transfers when doing echo
cancelling.
.
.Pp
.
.Fn libusb20_tr_get_actual_frames
will return the actual number of USB frames after an USB
transfer completed. A value of zero means that no data was transferred.
.
transfer completed.
A value of zero means that no data was transferred.
.Pp
.
.Fn libusb20_tr_get_actual_length
@ -691,9 +692,11 @@ Before this call will succeed the USB device must be opened.
.Fa setup
is a pointer to a decoded and host endian SETUP packet.
.Fa data
is a pointer to a data transfer buffer associated with the control transaction. This argument can be NULL.
is a pointer to a data transfer buffer associated with the control transaction.
This argument can be NULL.
.Fa pactlen
is a pointer to a variable that will hold the actual transfer length after the control transaction is complete.
is a pointer to a variable that will hold the actual transfer length after the
control transaction is complete.
.Fa timeout
is the transaction timeout given in milliseconds.
A timeout of zero means no timeout.
@ -792,10 +795,11 @@ The USB device need not be opened when calling this function.
.Pp
.
.Fn libusb20_dev_alloc_config
will read out and decode the USB config descriptor for
the given USB device and config index. This function returns a pointer
to the decoded configuration which must eventually be passed to
free(). NULL is returned in case of failure.
will read out and decode the USB config descriptor for the given USB device
and config index.
This function returns a pointer to the decoded configuration which must eventually
be passed to free().
NULL is returned in case of failure.
.
.Pp
.
@ -902,8 +906,8 @@ will set the global USB device side mode template to
The new template is not activated until after the next USB
enumeration.
The template number decides how the USB device will present itself to
the USB Host, like Mass Storage Device, USB Ethernet Device. Also see
the
the USB Host, like Mass Storage Device, USB Ethernet Device.
Also see the
.Xr usb2_template 4
module.
This function returns zero on success else a LIBUSB20_ERROR value is
@ -966,10 +970,9 @@ returned.
.Fn libusb20_be_alloc_default
.Fn libusb20_be_alloc_freebsd
.Fn libusb20_be_alloc_linux
These functions are used to allocate a specific USB backend or the
operating system default USB backend. Allocating a backend is a way to
scan for currently present USB devices.
.
These functions are used to allocate a specific USB backend or the operating system
default USB backend.
Allocating a backend is a way to scan for currently present USB devices.
.Pp
.
.Fn libusb20_be_device_foreach

View file

@ -33,7 +33,6 @@
.Sh SYNOPSIS
.Cd "device fdt_pinctrl"
.Sh DESCRIPTION
.Pp
Pin multiplexing is a technology used to re-purpose a single
physical connection (depending on chip packaging it may be
pin, ball, or pad) by routing its signal to any one of several

View file

@ -34,7 +34,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd Mar 13, 2019
.Dd March 13, 2019
.Dt MRSAS 4
.Os
.Sh NAME

View file

@ -150,9 +150,9 @@ prompt before booting the kernel or stored in
.It Va dev.rtwn.%d.hwcrypto
This tunable controls how key slots are assigned:
.br
0 - disable h/w crypto support. Features that require access
to frame contents (e.g., TCP/UDP/IP Rx checksum validation)
will not work;
0 - disable h/w crypto support.
Features that require access to frame contents (e.g., TCP/UDP/IP Rx
checksum validation) will not work;
.br
1 - use h/w crypto support for pairwise keys only;
.br

View file

@ -136,8 +136,8 @@ makes them unsuitable as a "drop-in" replacement for an Ethernet LAN;
for a USB 3.0 SuperSpeed cable, latency is comparable to 100BaseTX Ethernet
(but often worse), with throughput comparable to 2.5GBASE-T.
.Pp
However, their energy efficiency makes them attractive for embedded
applications. A Plugable PL27A1 cable claims 24mA of USB3 bus power,
However, their energy efficiency makes them attractive for embedded applications.
A Plugable PL27A1 cable claims 24mA of USB3 bus power,
as compared to 150mA for a typical USB 3.0 to Gigabit Ethernet interface.
.Sh HISTORY
The

View file

@ -37,23 +37,10 @@
.Ft phandle_t
.Fn OF_finddevice "const char *path"
.Sh DESCRIPTION
.Pp
.Fn OF_finddevice
returns the phandle for the node specified by the
.Fa path .
Returns -1 if the path cannot be found in the tree.
.Sh CAVEATS
The return value should only be checked with equality
operators (equal to, not equal to) and not relational comparison
(less than, greater than ).
There is a discrepancy between IEEE 1275 standard and
.Fx Ns 's
internal representation of a phandle: IEEE 1275
requires the return value of this function to be -1 if the path
is not found.
But phandle_t is an unsigned type, so it cannot
be relationally compared with -1 or 0, this comparison
is always true or always false.
.Sh EXAMPLES
.Bd -literal
phandle_t root, i2c;
@ -72,3 +59,15 @@ is always true or always false.
.An -nosplit
This manual page was written by
.An Oleksandr Tymoshenko Aq Mt gonzo@FreeBSD.org .
.Sh CAVEATS
The return value should only be checked with equality
operators (equal to, not equal to) and not relational comparison
(less than, greater than ).
There is a discrepancy between IEEE 1275 standard and
.Fx Ns 's
internal representation of a phandle: IEEE 1275
requires the return value of this function to be -1 if the path
is not found.
But phandle_t is an unsigned type, so it cannot
be relationally compared with -1 or 0, this comparison
is always true or always false.

View file

@ -22,7 +22,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd October 02, 2020
.Dd October 2, 2020
.Dt BACKLIGHT 9
.Os
.Sh NAME

View file

@ -39,7 +39,6 @@
.Cd "options VNET_DEBUG"
.Pp
.In sys/vnet.h
.Pp
.\"------------------------------------------------------------
.Ss "Constants and Global Variables"
.\"

View file

@ -144,7 +144,8 @@ Prevent visually distracting initialization/exit routines for scripts running
.Xr dialog 1
several times.
.It Fl l
Line mode. Read lines from input instead of bytes.
Line mode.
Read lines from input instead of bytes.
.It Fl L Ar size
Label size.
If negative, shrink to longest label width.

View file

@ -122,7 +122,8 @@ is named
.Sq Pa /blah/blah/file ,
the backup file is named
.Sq Pa file.BAK
by default. The extension used for the backup file may be overridden using the
by default.
The extension used for the backup file may be overridden using the
.Ev SIMPLE_BACKUP_SUFFIX
environment variable.
.Pp

View file

@ -124,9 +124,9 @@ See
.Sx NOTES .
.It Fl U
Ignore the presence of character symbols that have no matching character
definition. This facilitates the use of a common locale definition file
to be used across multiple encodings, even when some symbols are not
present in a given encoding.
definition.
This facilitates the use of a common locale definition file to be used across multiple
encodings, even when some symbols are not present in a given encoding.
.It Fl v
Emit verbose debugging output on standard output.
.It Fl w Ar widthfile

View file

@ -223,8 +223,8 @@ The preferred file extension is ".qcow" and ".qcow2" for QCOW and QCOW2
(resp.), but ".qcow" is sometimes used for version 2 files as well.
.Ss RAW file format
This file format is a sector by sector representation of an actual disk.
There is no extra information that describes or relates to the format
itself. The size of the file is the size of the (virtual) disk.
There is no extra information that describes or relates to the format itself.
The size of the file is the size of the (virtual) disk.
This file format is suitable for being copyied onto a disk with utilities
like
.Nm dd .

View file

@ -148,7 +148,8 @@ Information (SMIv2).
The context to query with SNMPv3 PDUs.
.Bl -tag -width \&
.It Cm context=name
The context name. Default is "" (empty).
The context name.
Default is "" (empty).
.It Cm context-engine=engine-id
The SNMP Engine ID of the context to query with SNMPv3 PDUs, represented as
binary octet string.

View file

@ -30,7 +30,7 @@
.\" Authors: Ken Merry (Spectra Logic Corporation)
.\"
.\" $FreeBSD$
.\"
.\
.Dd November 11, 2015
.Dt CAMDD 8
.Os

View file

@ -30,7 +30,7 @@
.\" Authors: Ken Merry (Spectra Logic Corporation)
.\"
.\" $FreeBSD$
.\"
.\
.Dd May 18, 2016
.Dt ZONECTL 8
.Os