[PATCH] docs: fix grammar and punctuation of 2.26 release notes

[PATCH] docs: fix grammar and punctuation of 2.26 release notes

[Benno Schulenberg]

Also trim some trailing whitespace.

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
---
 Documentation/releases/v2.26-ReleaseNotes |   70 ++++++++++++++--------------
 1 files changed, 35 insertions(+), 35 deletions(-)

diff --git a/Documentation/releases/v2.26-ReleaseNotes b/Documentation/releases/v2.26-ReleaseNotes
index b7712f7..68b09dd 100644
--- a/Documentation/releases/v2.26-ReleaseNotes
+++ b/Documentation/releases/v2.26-ReleaseNotes
@@ -1,29 +1,29 @@
 Util-linux 2.26 Release Notes
 =============================
 
- This version provides completely new sfdisk(8) command, the new version is
- based on libfdisk. If your use-cases depend on sfdisk(8) then it is strongly
+ This version provides a completely new sfdisk(8) command; the new version is
+ based on libfdisk. If your use cases depend on sfdisk(8) then it is strongly
  recommended to be careful and re-test your scripts. The new version supports
- MBR and GPT disk labels (SGI and SUN are also supported but no well tested).
- The new version does no more support some obscure MBR specific command line
+ MBR and GPT disk labels (SGI and SUN are also supported but not well tested).
+ The new version no longer supports some obscure MBR-specific command-line
  options and legacy CHS addressing.
 
 
- The library libblkid (and blkid(8) on command line) now uses the same UDF
- fields like Windows and another operations systems to get human readable
- UDF volume identifiers (LABEL= tag). This change maybe backwardly incompatible 
+ The library libblkid (and blkid(8) on the command line) now uses the same UDF
+ fields as Windows and other operating systems in order to get human-readable
+ UDF volume identifiers (LABEL= tag). This change may be backwardly incompatible
  for some UDF volumes.
 
 
  The command hwclock(8) uses the drift correction for all relevant operations
- and it is unnecessary to specify --adjuts on hwclock command line now.
+ and it is unnecessary to specify --adjust on the hwclock command line now.
 
- The command hwclock(8) does not automatically (re)calculate drift factor on
- --systohc to avoid several problem (ntpd with an '11 minute mode', etc.), but
- new command line option --update-drift has to be explicitly used to force
- hwclock(8) to update /etc/adjtime. 
+ The command hwclock(8) does not automatically (re)calculate the drift factor on
+ --systohc to avoid several problems (ntpd with '11 minute mode', for example),
+ but the new command-line option --update-drift has to be explicitly used to
+ force hwclock(8) to update /etc/adjtime.
 
- For more details see hwclock(8) man page.
+ For more details see the hwclock(8) man page.
 
 
 Release highlights
@@ -34,55 +34,55 @@ zramctl(8):
 
 agetty(8):
  - supports new options --reload to force already running agetty processes to
-   reprint /etc/issue file. 
+   reprint the /etc/issue file
 
 cfdisk(8), sfdisk(8) and fdisk(8):
- - supports sfdisk compatible scripts, it's possible to save your partitioning 
-   layout to text files and (re)use it in all fdisks.
+ - supports sfdisk compatible scripts; it's possible to save your partitioning
+   layout to text files and (re)use it in all fdisks
 
 fdisk(8), sfdisk(8):
- - support new command line option "--output <list>" to specify output columns
-   for --list or print commands.
+ - support new command-line option "--output <list>" to specify output columns
+   for --list or print commands
 
 nsenter(1):
  - has been updated to work with the latest kernel changes in user namespaces
- - supports new command line option --preserve-credentials
+ - supports new command-line option --preserve-credentials
 
 unshare(1):
  - has been updated to work with the latest kernel changes in user namespaces
- - suuports new command line option "--setgroups=<deny|allow>"
+ - supports new command-line option "--setgroups=<deny|allow>"
 
 swapon(8):
- - supports new command line option "-o <list>" with the same semantic like
-   -o for mount(8); now it's possible to specify swap options on command line
-   by the same string like in fstab 
+ - supports new command-line option "-o <list>" with the same semantic as
+   -o for mount(8); it's now possible to specify swap options on the command
+   line by the same string as in fstab
 
 fdformat(8):
- - supports new command line options --from/to to specify tracks and --repear
-   for broken floppies.
+ - supports new command-line options --from and --to to specify tracks and
+   --repair for broken floppies
 
 getopt(1):
- - has been updated to the latest version (originally maintained out of
-   util-linux) and refactored.
+ - has been updated to the latest version (originally maintained outside of
+   util-linux) and refactored
 
 ldattach(8):
- - has been improved to support GSM0710 and intro modem commands 
+ - has been improved to support GSM0710 and intro modem commands
 
 logger(1):
- - supports new command line option --id= to specify PID (or another ID)
+ - supports new command-line option --id= to specify PID (or another ID)
  - allows to specify --rfc3164 or --rfc5424 syslog protocols
 
 libfdisk:
- - the library is distributed as shared library with stable API and standard
-   header file.
+ - the library is distributed as a shared library with a stable API and a
+   standard header file
 
 libmount:
- - provides new simple API to monitor mount table changes (including
-   changes in userspace mount options).
+ - provides a new simple API to monitor mount-table changes (including
+   changes in userspace mount options)
 
 
-The debug infrastructure in libraries libmount, libsmartcolsm, libfdisk and
-libblkid allows to specify debug options by human readable strings too. For
+The debug infrastructure in the libraries libmount, libsmartcolsm, libfdisk and
+libblkid allows to specify debug options by human-readable strings too. For
 example "LIBMOUNT_DEBUG=all mount /mnt".
 
 
-- 
1.7.0.4

Re: [PATCH] docs: fix grammar and punctuation of 2.26 release notes

[Peter Cordes]

 Looks good, glad someone is taking the time to do this.  I ended up
taking the time myself to look up a few usage things in cases where it
looked odd to my English-Canadian eyes, but I wasn't sure.  :P


On Thu, Jan 15, 2015 at 08:09:05PM +0100, Benno Schulenberg wrote:
> Also trim some trailing whitespace.
> 
> Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
> ---
>  Documentation/releases/v2.26-ReleaseNotes |   70 ++++++++++++++--------------
>  1 files changed, 35 insertions(+), 35 deletions(-)
> 
> diff --git a/Documentation/releases/v2.26-ReleaseNotes b/Documentation/releases/v2.26-ReleaseNotes
> index b7712f7..68b09dd 100644
> --- a/Documentation/releases/v2.26-ReleaseNotes
> +++ b/Documentation/releases/v2.26-ReleaseNotes
> @@ -1,29 +1,29 @@
>  Util-linux 2.26 Release Notes
>  =============================
>  
> - This version provides completely new sfdisk(8) command, the new version is
> - based on libfdisk. If your use-cases depend on sfdisk(8) then it is strongly
> + This version provides a completely new sfdisk(8) command; the new version is
> + based on libfdisk. If your use cases depend on sfdisk(8) then it is strongly

 Should put a comma after "sfdisk(8)".

 At least some style guides are firm on this point, according to a
very quick google for if comma then.
https://www.constant-content.com/blog/2007/12/if-then-statements-require-commas/


>   recommended to be careful and re-test your scripts. The new version supports
> - MBR and GPT disk labels (SGI and SUN are also supported but no well tested).
> - The new version does no more support some obscure MBR specific command line
> + MBR and GPT disk labels (SGI and SUN are also supported but not well tested).
> + The new version no longer supports some obscure MBR-specific command-line
>   options and legacy CHS addressing.

 s/and/or/ in the last line.  "no longer supports x or y" is the proper
usage here.

>  
>  
> - The library libblkid (and blkid(8) on command line) now uses the same UDF
> - fields like Windows and another operations systems to get human readable
> - UDF volume identifiers (LABEL= tag). This change maybe backwardly incompatible 
> + The library libblkid (and blkid(8) on the command line) now uses the same UDF
> + fields as Windows and other operating systems in order to get human-readable
> + UDF volume identifiers (LABEL= tag). This change may be backwardly incompatible
>   for some UDF volumes.
>  
>  
>   The command hwclock(8) uses the drift correction for all relevant operations
> - and it is unnecessary to specify --adjuts on hwclock command line now.
> + and it is unnecessary to specify --adjust on the hwclock command line now.
>  
> - The command hwclock(8) does not automatically (re)calculate drift factor on
> - --systohc to avoid several problem (ntpd with an '11 minute mode', etc.), but
> - new command line option --update-drift has to be explicitly used to force
> - hwclock(8) to update /etc/adjtime. 
> + The command hwclock(8) does not automatically (re)calculate the drift factor on
> + --systohc to avoid several problems (ntpd with '11 minute mode', for example),
> + but the new command-line option --update-drift has to be explicitly used to
> + force hwclock(8) to update /etc/adjtime.

 Can we just start the sentence "hwclock(8) ...", instead of "The
command hwclock(8)"?  I don't think there's any ambiguity that you
might actually be talking about the man page.


>  
> - For more details see hwclock(8) man page.
> + For more details see the hwclock(8) man page.
>  
>  
>  Release highlights
> @@ -34,55 +34,55 @@ zramctl(8):
>  
>  agetty(8):
>   - supports new options --reload to force already running agetty processes to
> -   reprint /etc/issue file. 
> +   reprint the /etc/issue file

 "reprint /etc/issue" would work, and be shorter.


>  
>  cfdisk(8), sfdisk(8) and fdisk(8):
> - - supports sfdisk compatible scripts, it's possible to save your partitioning 
> -   layout to text files and (re)use it in all fdisks.
> + - supports sfdisk compatible scripts; it's possible to save your partitioning
> +   layout to text files and (re)use it in all fdisks

 Kudos for good use of a semicolon.  I always like a good semicolon. :)

>  
>  fdisk(8), sfdisk(8):
> - - support new command line option "--output <list>" to specify output columns
> -   for --list or print commands.
> + - support new command-line option "--output <list>" to specify output columns
> +   for --list or print commands
>  
>  nsenter(1):
>   - has been updated to work with the latest kernel changes in user namespaces
> - - supports new command line option --preserve-credentials
> + - supports new command-line option --preserve-credentials
>  
>  unshare(1):
>   - has been updated to work with the latest kernel changes in user namespaces
> - - suuports new command line option "--setgroups=<deny|allow>"
> + - supports new command-line option "--setgroups=<deny|allow>"
>  
>  swapon(8):
> - - supports new command line option "-o <list>" with the same semantic like
> -   -o for mount(8); now it's possible to specify swap options on command line
> -   by the same string like in fstab 
> + - supports new command-line option "-o <list>" with the same semantic as

 semantics, not semantic.

http://dictionary.reference.com/browse/semantic defines "semantic" as 
"of or relating to semantics".

> +   -o for mount(8); it's now possible to specify swap options on the command
> +   line by the same string as in fstab

 I think "with the same string", rather than "by the same string".

>  
>  fdformat(8):
> - - supports new command line options --from/to to specify tracks and --repear
> -   for broken floppies.
> + - supports new command-line options --from and --to to specify tracks and
> +   --repair for broken floppies

 Wow, people still use floppies, and are writing new code for them?

>  getopt(1):
> - - has been updated to the latest version (originally maintained out of
> -   util-linux) and refactored.
> + - has been updated to the latest version (originally maintained outside of
> +   util-linux) and refactored
>  
>  ldattach(8):
> - - has been improved to support GSM0710 and intro modem commands 
> + - has been improved to support GSM0710 and intro modem commands
>  
>  logger(1):
> - - supports new command line option --id= to specify PID (or another ID)
> + - supports new command-line option --id= to specify PID (or another ID)
>   - allows to specify --rfc3164 or --rfc5424 syslog protocols
>  
>  libfdisk:
> - - the library is distributed as shared library with stable API and standard
> -   header file.
> + - the library is distributed as a shared library with a stable API and a
> +   standard header file
>  
>  libmount:
> - - provides new simple API to monitor mount table changes (including
> -   changes in userspace mount options).
> + - provides a new simple API to monitor mount-table changes (including
> +   changes in userspace mount options)
>  
>  
> -The debug infrastructure in libraries libmount, libsmartcolsm, libfdisk and
> -libblkid allows to specify debug options by human readable strings too. For
> +The debug infrastructure in the libraries libmount, libsmartcolsm, libfdisk and
> +libblkid allows to specify debug options by human-readable strings too. For
>  example "LIBMOUNT_DEBUG=all mount /mnt".

"libblkid allows specifying debug options with human-readable strings, too. For"

 would read a bit better.

-- 
#define X(x,y) x##y
Peter Cordes ;  e-mail: X(peter@cor , des.ca)

"The gods confound the man who first found out how to distinguish the hours!
 Confound him, too, who in this place set up a sundial, to cut and hack
 my day so wretchedly into small pieces!" -- Plautus, 200 BC

Re: [PATCH] docs: fix grammar and punctuation of 2.26 release notes

[Benno Schulenberg]

On Fri, Jan 16, 2015, at 04:15, Peter Cordes wrote:
> > + based on libfdisk. If your use cases depend on sfdisk(8) then it is strongly
> 
>  Should put a comma after "sfdisk(8)".

True.  Will be in V2.

> > + The new version no longer supports some obscure MBR-specific command-line
> >   options and legacy CHS addressing.
> 
>  s/and/or/ in the last line.  "no longer supports x or y" is the proper
> usage here.

Hmm.   I would tend to use "nor" here.  It may not be grammatical or
proper usage, but I think it is the most clear.  ("No longer foo or bar"
works fine, but "no longer foo-foo-baz-foo-baz or bar" is unclear to me --
the negation has been mostly forgotten when the eye arrives at "or bar".
The "nor" is then a nice reminder.)

> > + The command hwclock(8) does not automatically (re)calculate the drift factor on
> > + --systohc to avoid several problems (ntpd with '11 minute mode', for example),
> > + but the new command-line option --update-drift has to be explicitly used to
> > + force hwclock(8) to update /etc/adjtime.
> 
>  Can we just start the sentence "hwclock(8) ...", instead of "The
> command hwclock(8)"?  I don't think there's any ambiguity that you
> might actually be talking about the man page.

True.  But it's what Karel wrote, and it's fine, it works.

> >   - supports new options --reload to force already running agetty processes to
> > -   reprint /etc/issue file. 
> > +   reprint the /etc/issue file
> 
>  "reprint /etc/issue" would work, and be shorter.

Same comment as above.

> > - - supports sfdisk compatible scripts, it's possible to save your partitioning 
> > -   layout to text files and (re)use it in all fdisks.
> > + - supports sfdisk compatible scripts; it's possible to save your partitioning
> > +   layout to text files and (re)use it in all fdisks
> 
>  Kudos for good use of a semicolon.  I always like a good semicolon. :)

:)

> > + - supports new command-line option "-o <list>" with the same semantic as
> 
>  semantics, not semantic.

Right.  Will be in V2.

> > +   -o for mount(8); it's now possible to specify swap options on the command
> > +   line by the same string as in fstab
> 
>  I think "with the same string", rather than "by the same string".

Well, "is specified by" gives me many more google hits than "is specified with".
This comparison may not be valid, but I think "by" is okay here.  And even if
most native speakers would prefer "with" here, I think it's fine to let some of
the foreignness of Karel's tongue sound through in his text.
 
> > +The debug infrastructure in the libraries libmount, libsmartcolsm, libfdisk and
> > +libblkid allows to specify debug options by human-readable strings too. For
> >  example "LIBMOUNT_DEBUG=all mount /mnt".
> 
> "libblkid allows specifying debug options with human-readable strings, too. For"
> 
>  would read a bit better.

To a native speaker probably yes.  But I'm trying to make the minimum
amount of changes, fixing just the things where my comprehension is
hindered.  There's no need to make this text into "English English";
"understandable and acceptable foreigner English" seems good enough.

Thanks for the review.
Shall I add a Reviewed-by tag to V2?  Or an Acked-by?

Benno

-- 
http://www.fastmail.com - Does exactly what it says on the tin

[PATCH V2] docs: fix grammar and punctuation and typos in 2.26 release notes

[Benno Schulenberg]

Also trim some trailing whitespace.

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
---
 Documentation/releases/v2.26-ReleaseNotes |   74 ++++++++++++++--------------
 1 files changed, 37 insertions(+), 37 deletions(-)

diff --git a/Documentation/releases/v2.26-ReleaseNotes b/Documentation/releases/v2.26-ReleaseNotes
index b7712f7..655aebe 100644
--- a/Documentation/releases/v2.26-ReleaseNotes
+++ b/Documentation/releases/v2.26-ReleaseNotes
@@ -1,29 +1,29 @@
 Util-linux 2.26 Release Notes
 =============================
 
- This version provides completely new sfdisk(8) command, the new version is
- based on libfdisk. If your use-cases depend on sfdisk(8) then it is strongly
+ This version provides a completely new sfdisk(8) command; the new version is
+ based on libfdisk. If your use cases depend on sfdisk(8), then it is strongly
  recommended to be careful and re-test your scripts. The new version supports
- MBR and GPT disk labels (SGI and SUN are also supported but no well tested).
- The new version does no more support some obscure MBR specific command line
- options and legacy CHS addressing.
+ MBR and GPT disk labels (SGI and SUN are also supported but not well tested).
+ The new version no longer supports some obscure MBR-specific command-line
+ options nor legacy CHS addressing.
 
 
- The library libblkid (and blkid(8) on command line) now uses the same UDF
- fields like Windows and another operations systems to get human readable
- UDF volume identifiers (LABEL= tag). This change maybe backwardly incompatible 
+ The library libblkid (and blkid(8) on the command line) now uses the same UDF
+ fields as Windows and other operating systems in order to get human-readable
+ UDF volume identifiers (LABEL= tag). This change may be backwardly incompatible
  for some UDF volumes.
 
 
  The command hwclock(8) uses the drift correction for all relevant operations
- and it is unnecessary to specify --adjuts on hwclock command line now.
+ and it is unnecessary to specify --adjust on the hwclock command line now.
 
- The command hwclock(8) does not automatically (re)calculate drift factor on
- --systohc to avoid several problem (ntpd with an '11 minute mode', etc.), but
- new command line option --update-drift has to be explicitly used to force
- hwclock(8) to update /etc/adjtime. 
+ The command hwclock(8) does not automatically (re)calculate the drift factor on
+ --systohc to avoid several problems (ntpd with '11 minute mode', for example),
+ but the new command-line option --update-drift has to be explicitly used to
+ force hwclock(8) to update /etc/adjtime.
 
- For more details see hwclock(8) man page.
+ For more details see the hwclock(8) man page.
 
 
 Release highlights
@@ -33,56 +33,56 @@ zramctl(8):
  - this NEW COMMAND allows to control /dev/zramN devices
 
 agetty(8):
- - supports new options --reload to force already running agetty processes to
-   reprint /etc/issue file. 
+ - supports new option --reload to force already running agetty processes to
+   reprint the /etc/issue file
 
 cfdisk(8), sfdisk(8) and fdisk(8):
- - supports sfdisk compatible scripts, it's possible to save your partitioning 
-   layout to text files and (re)use it in all fdisks.
+ - support sfdisk-compatible scripts; it's possible to save your partitioning
+   layout to text files and (re)use it in all fdisks
 
 fdisk(8), sfdisk(8):
- - support new command line option "--output <list>" to specify output columns
-   for --list or print commands.
+ - support new command-line option "--output <list>" to specify output columns
+   for --list or print commands
 
 nsenter(1):
  - has been updated to work with the latest kernel changes in user namespaces
- - supports new command line option --preserve-credentials
+ - supports new command-line option --preserve-credentials
 
 unshare(1):
  - has been updated to work with the latest kernel changes in user namespaces
- - suuports new command line option "--setgroups=<deny|allow>"
+ - supports new command-line option "--setgroups=<deny|allow>"
 
 swapon(8):
- - supports new command line option "-o <list>" with the same semantic like
-   -o for mount(8); now it's possible to specify swap options on command line
-   by the same string like in fstab 
+ - supports new command-line option "-o <list>" with the same semantics as
+   -o for mount(8); it's now possible to specify swap options on the command
+   line by the same string as in fstab
 
 fdformat(8):
- - supports new command line options --from/to to specify tracks and --repear
-   for broken floppies.
+ - supports new command-line options --from and --to to specify tracks and
+   --repair for broken floppies
 
 getopt(1):
- - has been updated to the latest version (originally maintained out of
-   util-linux) and refactored.
+ - has been updated to the latest version (originally maintained outside of
+   util-linux) and refactored
 
 ldattach(8):
- - has been improved to support GSM0710 and intro modem commands 
+ - has been improved to support GSM0710 and intro modem commands
 
 logger(1):
- - supports new command line option --id= to specify PID (or another ID)
+ - supports new command-line option --id= to specify PID (or another ID)
  - allows to specify --rfc3164 or --rfc5424 syslog protocols
 
 libfdisk:
- - the library is distributed as shared library with stable API and standard
-   header file.
+ - the library is distributed as a shared library with a stable API and a
+   standard header file
 
 libmount:
- - provides new simple API to monitor mount table changes (including
-   changes in userspace mount options).
+ - provides a new simple API to monitor mount-table changes (including
+   changes in userspace mount options)
 
 
-The debug infrastructure in libraries libmount, libsmartcolsm, libfdisk and
-libblkid allows to specify debug options by human readable strings too. For
+The debug infrastructure in the libraries libmount, libsmartcolsm, libfdisk and
+libblkid allows to specify debug options by human-readable strings too. For
 example "LIBMOUNT_DEBUG=all mount /mnt".
 
 
-- 
1.7.0.4

Re: [PATCH] docs: fix grammar and punctuation of 2.26 release notes

[Peter Cordes]

On Sat, Jan 17, 2015 at 06:56:43PM +0100, Benno Schulenberg wrote:
> 
> On Fri, Jan 16, 2015, at 04:15, Peter Cordes wrote:
> > > + The new version no longer supports some obscure MBR-specific command-line
> > >   options and legacy CHS addressing.
> > 
> >  s/and/or/ in the last line.  "no longer supports x or y" is the proper
> > usage here.
> 
> Hmm.   I would tend to use "nor" here.  It may not be grammatical or
> proper usage, but I think it is the most clear.  ("No longer foo or bar"
> works fine, but "no longer foo-foo-baz-foo-baz or bar" is unclear to me --
> the negation has been mostly forgotten when the eye arrives at "or bar".
> The "nor" is then a nice reminder.)

 You're right, nor might actually be more proper.  And agree on using
it to avoid ambiguity.

> 
> > > +   -o for mount(8); it's now possible to specify swap options on the command
> > > +   line by the same string as in fstab
> > 
> >  I think "with the same string", rather than "by the same string".
> 
> Well, "is specified by" gives me many more google hits than "is specified with".

 "Is specified by <name of standard / person / organization>" is common usage.
 "Is specified with <how you specify it>" is a strange usage that I'm
not sure is correct.  What I am pretty sure about is that "by" isn't
correct usage for the 2nd case.  If we were writing a book, I'd
probably think of a way to reword the whole sentence.

 Perhaps "using the same string as in fstab"?  I think that sounds
less clunky than either "by" or "with".

> This comparison may not be valid, but I think "by" is okay here.  And even if
> most native speakers would prefer "with" here, I think it's fine to let some of
> the foreignness of Karel's tongue sound through in his text.

 I agree that the meaning is still clear, so it doesn't really need a
change.

>  
> > > +The debug infrastructure in the libraries libmount, libsmartcolsm, libfdisk and
> > > +libblkid allows to specify debug options by human-readable strings too. For
> > >  example "LIBMOUNT_DEBUG=all mount /mnt".
> > 
> > "libblkid allows specifying debug options with human-readable strings, too. For"
> > 
> >  would read a bit better.
> 
> To a native speaker probably yes.

 Definitely, not just probably.  The meaning is totally clear, but I
don't think any native speaker would have used "by" instead of "with"
or "as".

>  But I'm trying to make the minimum
> amount of changes, fixing just the things where my comprehension is
> hindered.

 Fair enough.  I didn't think it would be a problem to make more
changes around lines you're already changing anyway, but if there's a
downside, it can stay.

>  There's no need to make this text into "English English";
> "understandable and acceptable foreigner English" seems good enough.

 Yup, "acceptable foreigner English" is a good description of a lot of
free software docs.  I agree it's not worth the time to try to get
global open-source projects up to the level a book editor would be
happy with.  It just caught my interest, so I took the time, and
probably found some changes just for the sake of changing something.


> Thanks for the review.
> Shall I add a Reviewed-by tag to V2?  Or an Acked-by?

 Either would be cool.  I'm not too familiar with the usual practices
for tagging git commits, so whichever you think is most appropriate
would be appreciated.

-- 
#define X(x,y) x##y
Peter Cordes ;  e-mail: X(peter@cor , des.ca)

"The gods confound the man who first found out how to distinguish the hours!
 Confound him, too, who in this place set up a sundial, to cut and hack
 my day so wretchedly into small pieces!" -- Plautus, 200 BC

[PATCH V3] docs: fix grammar and punctuation and typos in 2.26 release notes

[Benno Schulenberg]

Also trim some trailing whitespace.

Reviewed-by: Peter Cordes <peter@cordes.ca>
Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
---
 Documentation/releases/v2.26-ReleaseNotes |   74 ++++++++++++++--------------
 1 files changed, 37 insertions(+), 37 deletions(-)

diff --git a/Documentation/releases/v2.26-ReleaseNotes b/Documentation/releases/v2.26-ReleaseNotes
index b7712f7..655aebe 100644
--- a/Documentation/releases/v2.26-ReleaseNotes
+++ b/Documentation/releases/v2.26-ReleaseNotes
@@ -1,29 +1,29 @@
 Util-linux 2.26 Release Notes
 =============================
 
- This version provides completely new sfdisk(8) command, the new version is
- based on libfdisk. If your use-cases depend on sfdisk(8) then it is strongly
+ This version provides a completely new sfdisk(8) command; the new version is
+ based on libfdisk. If your use cases depend on sfdisk(8), then it is strongly
  recommended to be careful and re-test your scripts. The new version supports
- MBR and GPT disk labels (SGI and SUN are also supported but no well tested).
- The new version does no more support some obscure MBR specific command line
- options and legacy CHS addressing.
+ MBR and GPT disk labels (SGI and SUN are also supported but not well tested).
+ The new version no longer supports some obscure MBR-specific command-line
+ options nor legacy CHS addressing.
 
 
- The library libblkid (and blkid(8) on command line) now uses the same UDF
- fields like Windows and another operations systems to get human readable
- UDF volume identifiers (LABEL= tag). This change maybe backwardly incompatible 
+ The library libblkid (and blkid(8) on the command line) now uses the same UDF
+ fields as Windows and other operating systems in order to get human-readable
+ UDF volume identifiers (LABEL= tag). This change may be backwardly incompatible
  for some UDF volumes.
 
 
  The command hwclock(8) uses the drift correction for all relevant operations
- and it is unnecessary to specify --adjuts on hwclock command line now.
+ and it is unnecessary to specify --adjust on the hwclock command line now.
 
- The command hwclock(8) does not automatically (re)calculate drift factor on
- --systohc to avoid several problem (ntpd with an '11 minute mode', etc.), but
- new command line option --update-drift has to be explicitly used to force
- hwclock(8) to update /etc/adjtime. 
+ The command hwclock(8) does not automatically (re)calculate the drift factor on
+ --systohc to avoid several problems (ntpd with '11 minute mode', for example),
+ but the new command-line option --update-drift has to be explicitly used to
+ force hwclock(8) to update /etc/adjtime.
 
- For more details see hwclock(8) man page.
+ For more details see the hwclock(8) man page.
 
 
 Release highlights
@@ -33,56 +33,56 @@ zramctl(8):
  - this NEW COMMAND allows to control /dev/zramN devices
 
 agetty(8):
- - supports new options --reload to force already running agetty processes to
-   reprint /etc/issue file. 
+ - supports new option --reload to force already running agetty processes to
+   reprint the /etc/issue file
 
 cfdisk(8), sfdisk(8) and fdisk(8):
- - supports sfdisk compatible scripts, it's possible to save your partitioning 
-   layout to text files and (re)use it in all fdisks.
+ - support sfdisk-compatible scripts; it's possible to save your partitioning
+   layout to text files and (re)use it in all fdisks
 
 fdisk(8), sfdisk(8):
- - support new command line option "--output <list>" to specify output columns
-   for --list or print commands.
+ - support new command-line option "--output <list>" to specify output columns
+   for --list or print commands
 
 nsenter(1):
  - has been updated to work with the latest kernel changes in user namespaces
- - supports new command line option --preserve-credentials
+ - supports new command-line option --preserve-credentials
 
 unshare(1):
  - has been updated to work with the latest kernel changes in user namespaces
- - suuports new command line option "--setgroups=<deny|allow>"
+ - supports new command-line option "--setgroups=<deny|allow>"
 
 swapon(8):
- - supports new command line option "-o <list>" with the same semantic like
-   -o for mount(8); now it's possible to specify swap options on command line
-   by the same string like in fstab 
+ - supports new command-line option "-o <list>" with the same semantics as
+   -o for mount(8); it's now possible to specify swap options on the command
+   line by the same string as in fstab
 
 fdformat(8):
- - supports new command line options --from/to to specify tracks and --repear
-   for broken floppies.
+ - supports new command-line options --from and --to to specify tracks and
+   --repair for broken floppies
 
 getopt(1):
- - has been updated to the latest version (originally maintained out of
-   util-linux) and refactored.
+ - has been updated to the latest version (originally maintained outside of
+   util-linux) and refactored
 
 ldattach(8):
- - has been improved to support GSM0710 and intro modem commands 
+ - has been improved to support GSM0710 and intro modem commands
 
 logger(1):
- - supports new command line option --id= to specify PID (or another ID)
+ - supports new command-line option --id= to specify PID (or another ID)
  - allows to specify --rfc3164 or --rfc5424 syslog protocols
 
 libfdisk:
- - the library is distributed as shared library with stable API and standard
-   header file.
+ - the library is distributed as a shared library with a stable API and a
+   standard header file
 
 libmount:
- - provides new simple API to monitor mount table changes (including
-   changes in userspace mount options).
+ - provides a new simple API to monitor mount-table changes (including
+   changes in userspace mount options)
 
 
-The debug infrastructure in libraries libmount, libsmartcolsm, libfdisk and
-libblkid allows to specify debug options by human readable strings too. For
+The debug infrastructure in the libraries libmount, libsmartcolsm, libfdisk and
+libblkid allows to specify debug options by human-readable strings too. For
 example "LIBMOUNT_DEBUG=all mount /mnt".
 
 
-- 
1.7.0.4

Re: [PATCH V3] docs: fix grammar and punctuation and typos in 2.26 release notes

[Peter Cordes]

On Mon, Jan 19, 2015 at 10:08:23PM +0100, Benno Schulenberg wrote:
> Also trim some trailing whitespace.
> 
> Reviewed-by: Peter Cordes <peter@cordes.ca>
> Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
> ---
>  Documentation/releases/v2.26-ReleaseNotes |   74 ++++++++++++++--------------
>  1 files changed, 37 insertions(+), 37 deletions(-)
> 
> diff --git a/Documentation/releases/v2.26-ReleaseNotes b/Documentation/releases/v2.26-ReleaseNotes
> index b7712f7..655aebe 100644
> --- a/Documentation/releases/v2.26-ReleaseNotes
> +++ b/Documentation/releases/v2.26-ReleaseNotes
> @@ -1,29 +1,29 @@
>  Util-linux 2.26 Release Notes
>  =============================
>  
> - This version provides completely new sfdisk(8) command, the new version is
> - based on libfdisk. If your use-cases depend on sfdisk(8) then it is strongly
> + This version provides a completely new sfdisk(8) command; the new version is
> + based on libfdisk. If your use cases depend on sfdisk(8), then it is strongly
>   recommended to be careful and re-test your scripts. The new version supports
> - MBR and GPT disk labels (SGI and SUN are also supported but no well tested).
> - The new version does no more support some obscure MBR specific command line
> - options and legacy CHS addressing.
> + MBR and GPT disk labels (SGI and SUN are also supported but not well tested).
> + The new version no longer supports some obscure MBR-specific command-line
> + options nor legacy CHS addressing.

 I think it's still not quite proper English, and might be worse.  I
think you might technically need an "either" to introduce the list, to
make "no longer supports" apply to "MBR opts or CHS addressing".  Like
a map operator.  But I'm not sure, and I don't want to take the time to
track it down.

 It doesn't really matter.  Leave it, or go back to "and", and people
will understand the "foreigner speak" if they notice a problem at all. :P

 Or change it to:

+ The new version drops support for some obscure MBR-specific command-line
+ options and legacy CHS addressing.

 I think that's fine without an "either" or a "both", but I can't
explain why.  Oh, the problems of knowing English without having been
formally taught all the grammar rules.  If I'd gone to school decades
earlier than I did, I'm sure I would have been taught all this stuff
formally. :P

-- 
#define X(x,y) x##y
Peter Cordes ;  e-mail: X(peter@cor , des.ca)

"The gods confound the man who first found out how to distinguish the hours!
 Confound him, too, who in this place set up a sundial, to cut and hack
 my day so wretchedly into small pieces!" -- Plautus, 200 BC

Re: [PATCH V3] docs: fix grammar and punctuation and typos in 2.26 release notes

[Karel Zak]

On Mon, Jan 19, 2015 at 10:08:23PM +0100, Benno Schulenberg wrote:
>  Documentation/releases/v2.26-ReleaseNotes |   74 ++++++++++++++--------------
>  1 files changed, 37 insertions(+), 37 deletions(-)

 Applied, thanks.

-- 
 Karel Zak  <kzak@redhat.com>
 http://karelzak.blogspot.com