Re: [PATCH] docs: fixed minor typos

[Stefano Lattarini]

Hi Eric.

On Monday 08 August 2011, Eric Blake wrote:
> On 08/08/2011 11:21 AM, Stefano Lattarini wrote:
> > * doc/autoconf.texi (Shell Functions): Fixed a couple of minor
> > typos.
> 
> For ChangeLog and commit messages, we prefer 2nd-person imperative tense 
> over past tense.  In English, 2nd person imperative and 1st person 
> present tense are often the same word ("I fix" as present, and "you fix" 
> as imperative counterparts to "I/you fixed" past); the 3rd person is not 
> always the same word ("this fixes" as present, "this shall fix" as 
> imperative, "this fixed" as past).  Or, using "is" as an example:
> 
> Imperative: "Be more precise" (I'm giving you a command, which you 
> fulfil by applying this patch)
> Present: "Is more precise" (This patch provides this functionality)
> Past: "Was more precise" (What the patch did)
> 
> My rule of thumb is to decide if what I wrote still makes sense when I 
> append "when you apply this patch", such that what I wrote is addressed 
> as a command to you as the unspoken second person reader.
>
Thanks for the explanation, I'll try to keep it in mind.

> > ---
> >   ChangeLog |6 ++
> >   doc/autoconf.texi |6 +++---
> >   2 files changed, 9 insertions(+), 3 deletions(-)
> >
> > diff --git a/ChangeLog b/ChangeLog
> > index 4d850bd..b3b721b 100644
> > --- a/ChangeLog
> > +++ b/ChangeLog
> > @@ -1,3 +1,9 @@
> > +2011-08-08  Stefano Lattarini
> > +
> > +   docs: fixed minor typos
> > +   * doc/autoconf.texi (Shell Functions): Fixed a couple of minor
> 
> Change both "Fixed" to "fix", then ACK.
> 
Done and pushed.

Thanks,
  Stefano 

Re: [PATCH] docs: fixed minor typos

[Eric Blake]

On 08/08/2011 11:21 AM, Stefano Lattarini wrote:

* doc/autoconf.texi (Shell Functions): Fixed a couple of minor
typos.


For ChangeLog and commit messages, we prefer 2nd-person imperative tense 
over past tense.  In English, 2nd person imperative and 1st person 
present tense are often the same word ("I fix" as present, and "you fix" 
as imperative counterparts to "I/you fixed" past); the 3rd person is not 
always the same word ("this fixes" as present, "this shall fix" as 
imperative, "this fixed" as past).  Or, using "is" as an example:


Imperative: "Be more precise" (I'm giving you a command, which you 
fulfil by applying this patch)

Present: "Is more precise" (This patch provides this functionality)
Past: "Was more precise" (What the patch did)

My rule of thumb is to decide if what I wrote still makes sense when I 
append "when you apply this patch", such that what I wrote is addressed 
as a command to you as the unspoken second person reader.



---
  ChangeLog |6 ++
  doc/autoconf.texi |6 +++---
  2 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 4d850bd..b3b721b 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2011-08-08  Stefano Lattarini
+
+   docs: fixed minor typos
+   * doc/autoconf.texi (Shell Functions): Fixed a couple of minor


Change both "Fixed" to "fix", then ACK.

--
Eric Blake   ebl...@redhat.com+1-801-349-2682
Libvirt virtualization library http://libvirt.org

[PATCH] docs: fixed minor typos

[Stefano Lattarini]

* doc/autoconf.texi (Shell Functions): Fixed a couple of minor
typos.
---
 ChangeLog |6 ++
 doc/autoconf.texi |6 +++---
 2 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 4d850bd..b3b721b 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2011-08-08  Stefano Lattarini  
+
+   docs: fixed minor typos
+   * doc/autoconf.texi (Shell Functions): Fixed a couple of minor
+   typos.
+
 2011-08-04  Stefano Lattarini  
 
docs: another Solaris sh bug with redirected `:'
diff --git a/doc/autoconf.texi b/doc/autoconf.texi
index c6837eb..7c1818d 100644
--- a/doc/autoconf.texi
+++ b/doc/autoconf.texi
@@ -16929,11 +16929,11 @@ segmentation fault.  To work around the issue, you 
can use
 in the execution flow of the function (@pxref{Common Shell Constructs}).
 
 Not all shells treat shell functions as simple commands impacted by
-@samp{set -e}, for example with Solaris 10 @command{bin/sh}:
+@samp{set -e}, for example with Solaris 10 @command{/bin/sh}:
 
 @example
-$ @kbd{bash -c 'f() @{ return 1; @}; set -e; f; echo oops}
-$ @kbd{/bin/sh -c 'f() @{ return 1; @}; set -e; f; echo oops}
+$ @kbd{bash -c 'f() @{ return 1; @}; set -e; f; echo oops'}
+$ @kbd{/bin/sh -c 'f() @{ return 1; @}; set -e; f; echo oops'}
 oops
 @end example
 
-- 
1.7.2.3