Page MenuHomeFreeBSD
Differential D30027 Diff 88590 share/man/man4/sndstat.4

Changeset View

Standalone View

View Options

share/man/man4/sndstat.4

Context not available.
.Sh DESCRIPTION .Sh DESCRIPTION
The ioctl interface provided by The ioctl interface provided by
.Pa /dev/sndstat .Pa /dev/sndstat
device allows callers to enumeration PCM audio devices available for use. device allows callers to enumerate PCM audio devices available for use.
bcrUnsubmitted
Not Done
Inline Actions

Seems like an extra whitespace was added after the sentence stop here.

bcr: Seems like an extra whitespace was added after the sentence stop here.
In other words, it provides means to get the list of all audio devices
available to the system.
bjkUnsubmitted
Done
Inline Actions

Start the new sentence on a new line.

bjk: Start the new sentence on a new line.
.Sh IOCTLS .Sh IOCTLS
For all ioctls requiring data exchange between the subsystem and callers, For ioctl calls that take an argument, the following structure is used:
khngUnsubmitted
Done
Inline Actions

Since some of the ioctl calls do not take arguments, I suggests "for ioctl calls that takes an argument, the following structure is used:"

khng: Since some of the ioctl calls do not take arguments, I suggests "for ioctl calls that takes an…
the following structures are used to describe a serialized nvlist:
.Bd -literal -offset indent .Bd -literal -offset indent
struct sndstioc_nv_arg { struct sndstioc_nv_arg {
size_t nbytes; size_t nbytes;
Context not available.
}; };
.Ed .Ed
.Pp .Pp
Here is an example of an nvlist, with explanations of the common fields: Here is an example of an nvlist object with explanations of the common fields:
bjkUnsubmitted
Done
Inline Actions

I think "objects" plural (though there's not quite enough context posted to be sure). There's a singular/plural mismatch -- we want either "an nvlist object" of "nvlist objects"

bjk: I think "objects" plural (though there's not quite enough context posted to be sure). There's…
.Bd -literal -offset indent .Bd -literal -offset indent
khngUnsubmitted
Done
Inline Actions
The
.Fa buf
field points to a buffer containing a packed nvlist. The
.Fa nbytes
field indicates the size of the packed nvlist if a packed nvlist is to be submitted to the subsystem, or the size of the buffer if a packed nvlist is to be retrieved from the subsystem.

And for explaining what nvlist is we should leave that to nv(9).

khng: ``` The .Fa buf field points to a buffer containing a packed nvlist. The .Fa nbytes field…
dsps (NVLIST ARRAY): 1 dsps (NVLIST ARRAY): 1
from_user (BOOL): FALSE from_user (BOOL): FALSE
Context not available.