svn commit: r211397 - in head: lib/libbluetooth lib/libc/gen lib/libc/net lib/libc/stdlib lib/libc/sys lib/libedit lib/libelf lib/libgeom lib/libgpib lib/libgssapi lib/libpmc lib/libradius lib/libr...

Tue Aug 17 17:25:09 UTC 2010

Hi Joel,

On Mon, 16 Aug 2010, Joel Dahl wrote:

> Log:
>  Fix typos, spelling, formatting and mdoc mistakes found by Nobuyuki while
>  translating these manual pages.  Minor corrections by me.

I noticed a few fixes missed nearby while checking the change in msun.

> Modified: head/lib/libbluetooth/bluetooth.3
> ==============================================================================
> --- head/lib/libbluetooth/bluetooth.3	Mon Aug 16 14:24:00 2010	(r211396)
> +++ head/lib/libbluetooth/bluetooth.3	Mon Aug 16 15:18:30 2010	(r211397)
> @@ -545,7 +545,7 @@ function performs Bluetooth inquiry.
> The
> .Fa devname
> parameter specifies which local Bluetooth device should perform an inquiry.
> -If not secified, i.e.
> +If not specified, i.e.
> .Dv NULL ,
> then first available device will be used.
> The
>

Still missing a comma after "i.e.,".  Some consider the comma optional, but
not me.  In /usr/share/man/man* there are ~currently 1861 lines matching
"i.e." and 1442 lines matching "i.e.," (counting links multiply).

> Modified: head/lib/libc/gen/dlopen.3
> ==============================================================================
> --- head/lib/libc/gen/dlopen.3	Mon Aug 16 14:24:00 2010	(r211396)
> +++ head/lib/libc/gen/dlopen.3	Mon Aug 16 15:18:30 2010	(r211397)
> @@ -149,7 +149,7 @@ The same behaviour may be requested by
> option of the static linker
> .Xr ld 1 .
> .It Dv RTLD_NOLOAD
> -Ony return valid handle for the object if it is already loaded in
> +Only return valid handle for the object if it is already loaded in
> the process address space, otherwise
> .Dv NULL
> is returned.
>

Still missing a "a".

> Modified: head/lib/libc/stdlib/getopt_long.3
> ==============================================================================
> --- head/lib/libc/stdlib/getopt_long.3	Mon Aug 16 14:24:00 2010	(r211396)
> +++ head/lib/libc/stdlib/getopt_long.3	Mon Aug 16 15:18:30 2010	(r211397)
> @@ -469,9 +469,9 @@ The
> .Fn getopt_long
> and
> .Fn getopt_long_only
> -functions first appeared in
> +functions first appeared in the
> .Tn GNU
> -libiberty.
> +libiberty library.
> The first
> .Bx
> implementation of
>

Hmm, what happened to -liberty?  I see that the pun is sort of reversed
in file and directory names -- they have to have a prefix of `lib', so
after removing this prefix and adding -l, the name is -liberty.

Shouldn't .Lb be used here?  Perhaps it only works for installed libraries.
If not, the same wording as .Lb produces should be used here.  This gives
something like "GNU iberty libary (libiberty, -liberty)".

> Modified: head/lib/libc/sys/kldstat.2
> ==============================================================================
> --- head/lib/libc/sys/kldstat.2	Mon Aug 16 14:24:00 2010	(r211396)
> +++ head/lib/libc/sys/kldstat.2	Mon Aug 16 15:18:30 2010	(r211397)
> @@ -129,6 +129,6 @@ The
> interface first appeared in
> .Fx 3.0 .
> .Sh BUGS
> -The pathname many not be accurate if the file system mounts have
> +The pathname may not be accurate if the file system mounts have
> changed since the module was loaded, or if this function is called
> within a chrooted environment.
>

"might" instead of "may" should be used in this context (else the
reader should wonder why the pathname not permitted to be accurate).

FreeBSD man pages mostly get this wrong.  me.  In /usr/share/man/man*
there are ~currently 1795 lines matching "may not" and "93 matching
"might not".

> .It TIME_ERROR
> Clock not synchronized.
> .El
>
> Modified: head/lib/libc/sys/open.2
> ==============================================================================
> --- head/lib/libc/sys/open.2	Mon Aug 16 14:24:00 2010	(r211396)
> +++ head/lib/libc/sys/open.2	Mon Aug 16 15:18:30 2010	(r211397)
> @@ -296,9 +296,9 @@ created has its immutable flag set, see
> .Xr chflags 2
> manual page for more information.

Still has a grammar error (comma splice).

> .It Bq Er EPERM
> -.Dv The named file has its immutable flag set and the file is to be modified.
> +The named file has its immutable flag set and the file is to be modified.
> .It Bq Er EPERM
> -.Dv The named file has its append-only flag set, the file is to be modified, and
> +The named file has its append-only flag set, the file is to be modified, and
> .Dv O_TRUNC
> is specified or
> .Dv O_APPEND
>
> Modified: head/lib/libelf/elf.3
> ==============================================================================
> --- head/lib/libelf/elf.3	Mon Aug 16 14:24:00 2010	(r211396)
> +++ head/lib/libelf/elf.3	Mon Aug 16 15:18:30 2010	(r211397)
> @@ -463,7 +463,7 @@ Close an ELF descriptor and release all
> .It Fn elf_memory
> Opens an
> .Xr ar 1
> -archive or ELF object present in a memory arena.
> +archive or ELF object present in a memory area.
> .It Fn elf_version
> Sets the operating version.
> .El
> @@ -563,7 +563,7 @@ descriptor and can set the
> member of the descriptor to point to a region of memory allocated
> using
> .Xr malloc 3 .
> -It is the applications responsibility to free this arena, though the
> +It is the applications responsibility to free this area, though the

Still missing an apostrophe.

> library will reclaim the space used by the
> .Vt Elf_Data
> descriptor itself.
>
> Modified: head/lib/libpmc/pmc.westmere.3
> ==============================================================================
> --- head/lib/libpmc/pmc.westmere.3	Mon Aug 16 14:24:00 2010	(r211396)
> +++ head/lib/libpmc/pmc.westmere.3	Mon Aug 16 15:18:30 2010	(r211397)
> @@ -975,7 +975,7 @@ Counting: Faulting executions of GETSEC/
> count as retired instructions.
> .It Li INST_RETIRED.X87
> .Pq Event C0H , Umask 02H
> -Counts the number of floating point computational operations retired:
> +Counts the number of floating point computational operations retired
> floating point computational operations executed by the assist handler and
> sub-operations of complex floating point instructions like transcendental
> instructions.
>

This now has nonsense grammar instead of bad grammar.  At first I thought
that it was a semicolon splice with the semicolon misspelled as a colon.
It was actually of the form "Counts the number of <object>: <description of
object>", where the <object> is long (5 words) and its description is much
longer (2 lines plus 1 word).  It is easy to see how translators would
have problems parsing this.  Attempted quick fix:

Counts the number of floating point computational operations retired
(i.e.,
floating point computational operations executed by the assist handler and
sub-operations of complex floating point instructions like transcendental
instructions
).

But the long description probably doesn't belong here.

> Modified: head/lib/libpmc/pmc.westmereuc.3
> ==============================================================================
> --- head/lib/libpmc/pmc.westmereuc.3	Mon Aug 16 14:24:00 2010	(r211396)
> +++ head/lib/libpmc/pmc.westmereuc.3	Mon Aug 16 15:18:30 2010	(r211397)
> @@ -464,7 +464,7 @@ Counts cycles all the entries in the DRA
> occupied with isochronous read requests.
> .It Li QMC_ISOC_FULL.READ.CH1
> .Pq Event 28H , Umask 02H
> -Counts cycles all the entries in the DRAM channel 1high priority queue are
> +Counts cycles all the entries in the DRAM channel 1 high priority queue are
> occupied with isochronous read requests.
> .It Li QMC_ISOC_FULL.READ.CH2
> .Pq Event 28H , Umask 04H
>

Still unparseable.  Maybe "Counts cycles of ... queue that are ..."

> Modified: head/lib/libradius/libradius.3
> ==============================================================================
> --- head/lib/libradius/libradius.3	Mon Aug 16 14:24:00 2010	(r211396)
> +++ head/lib/libradius/libradius.3	Mon Aug 16 15:18:30 2010	(r211397)
> @@ -464,7 +464,7 @@ subsequent library calls using the same
> 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 receieve
> +Server mode operates much alike to client mode, except packet send and receive

Still has bogus "to".

Still missing a "the" before "packet".

> 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.

Still has a hard sentence break and is missing a couple of "the"s and a
couple of "a"'s or "an"s.  I dare not look closer.

> Modified: head/lib/libusb/libusb20.3
> ==============================================================================
> --- head/lib/libusb/libusb20.3	Mon Aug 16 14:24:00 2010	(r211396)
> +++ head/lib/libusb/libusb20.3	Mon Aug 16 15:18:30 2010	(r211397)
> @@ -524,7 +524,7 @@ returns a zero terminated string describ
> .Pp
> .
> .Fn libusb20_dev_get_info
> -retrives the BSD specific usb_device_info structure into the memory location given by
> +retrieves the BSD specific usb_device_info structure into the memory location given by
> .Fa pinfo .
> The USB device given by
> .Fa pdev
>

Needs a hyphen before "specific".

In /usr/share/man/man* there are ~currently 1253 lines matching "\-specific"
and 5907 matching " specific".

> Modified: head/lib/libutil/quotafile.3
> ==============================================================================
> --- head/lib/libutil/quotafile.3	Mon Aug 16 14:24:00 2010	(r211396)
> +++ head/lib/libutil/quotafile.3	Mon Aug 16 15:18:30 2010	(r211397)
> @@ -121,7 +121,7 @@ The
> .Fn quota_on
> function enables quotas for the filesystem associated with its
> .Va qf
> -argument which may have been opened
> +argument which may have been opened with
> .Dv O_RDONLY
> or
> .Dv O_RDWR .
> @@ -138,7 +138,7 @@ The
> .Fn quota_off
> function disables quotas for the filesystem associated with its
> .Va qf
> -argument which may have been opened
> +argument which may have been opened with
> .Dv O_RDONLY
> or
> .Dv O_RDWR .
>

Here "may" instead of "might" is not too bad.

> Modified: head/lib/msun/man/fdim.3
> ==============================================================================
> --- head/lib/msun/man/fdim.3	Mon Aug 16 14:24:00 2010	(r211396)
> +++ head/lib/msun/man/fdim.3	Mon Aug 16 15:18:30 2010	(r211397)
> @@ -65,7 +65,7 @@ is an \*(Na, then an \*(Na is returned.
> Otherwise, the result is
> .Li +0.0 .
> .Pp
> -Overflow or underflow may occur iff the exact result is not
> +Overflow or underflow may occur if the exact result is not
> representable in the return type.
> No other exceptions are raised.
> .Sh SEE ALSO
>

"iff" was apparently used intentionally.  It means "if and only if",
which is more than "if".  But "iff" might be too informal for man page.
tcsh.1 is the only other man page that uses it.

> Modified: head/sbin/devd/devd.conf.5
> ...

Got bored here.

Bruce