Re: [PATCH] docs: fstab(5) grammar / English fixes, and some other updates

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Mon, Feb 23, 2015, at 12:10, Peter Cordes wrote:
> -spaces.  Lines starting with '#' are comments, blank lines are ignored. The
> +spaces.  Lines starting with '#' are comments.  Blank lines are ignored. The

When changing a line, please also fix a single space after a period: ".  The".
I would have changed the comma to semicolon, by the way.  :)

> +This is a typical example of an [...]

Please add a .PP instead of a blank line before this line.  And
replace "This" with "The following", because when starting
to read the sentence, it is completely unclear what "This"
refers to.

> +.B fstab
> +entry:
> +.sp 1

A plain ".sp" is enough.

> +LABEL=t-home2   /home      ext4    defaults,auto_da_alloc      0 2

Please add a ".RS 7" before and a ".RE" after it.
And for clarity maybe doublespace the "0 2".

> -For ordinary mounts it will hold (a link to) a block special
> +For ordinary mounts, it will hold (a link to) a block special

I don't agree with this comma.  For me it hinders comprehension
a bit rather than helping.  When speaking the phrase aloud, the
pause between "mounts" and "it" is negligible, even inaudible.
A comma makes me think something parenthetic is getting said.
But... matter of taste.

> +This is the recommended method, as device names are often a coincidence
> +of hardware detection order, and can change when other disks are added or removed.
> +(cf.

The period after "removed" shouldn't be there.
And when replacing "e.g." with the better "for example",
please also replace "cf." with a clearer "compare" or "see also".

> +This field describes the type of the filesystem.  Linux supports many
> +filesystem types, including ext4, xfs, btrfs, vfat, ntfs, hfsplus,
> +tmpfs, sysfs, proc, iso9660, udf, nfs, cifs, and many more. [...]

Ah, no, you can't say "including", name some, and then add
"and many more".  It's either "including", name some, and period,
or replace "including" with a colon, name some, and finish with
"and many more".  So, it was fine the way it was.

> +It is formatted as a comma separated list of options.
 
comma-separated

> -Basic file system independent options are:
> +Basic filesystem independent options are:

filesystem-independent


The other changes are good.

Benno

-- 
http://www.fastmail.com - Choose from over 50 domains or use your own

--
To unsubscribe from this list: send the line "unsubscribe util-linux" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html




[Index of Archives]     [Netdev]     [Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux