public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Frans Klaver <fransklaver@gmail.com>
To: Oscar Utbult <oscar@oscr.io>
Cc: Randy Dunlap <rdunlap@infradead.org>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 1/1] Changed "&" with "and" in Documentation/applying-patches.txt.
Date: Thu, 25 Sep 2014 21:12:54 +0200	[thread overview]
Message-ID: <20140925191254.GA2073@gmail.com> (raw)
In-Reply-To: <e692e73445c591af1bea3ce0a87755c6@oscr.io>

On Thu, Sep 25, 2014 at 06:28:47PM +0200, Oscar Utbult wrote:
> On 2014-09-25 16:48, Frans Klaver wrote:
> > On Thu, Sep 25, 2014 at 3:41 PM,  <oscar@oscr.io> wrote:
> >> Subject: [PATCH 1/1] Changed "&" with "and" in 
> >> Documentation/applying-patches.txt.
> > 
> > Documentation/SubmittingPatches says:
> > 
> > Describe your changes in imperative mood, e.g. "make xyzzy do frotz"
> > instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy
> > to do frotz", as if you are giving orders to the codebase to change
> > its behaviour.
> 
> Thank you for your feedback Frans.
> 
> So for example a better description would have been: "use 'and' instead 
> of '&'"?

Yes. It is useful to still mention it is affecting documentation only
though. This helps identifying whether a change may be related to a
defect for example.

By the way, I just grepped through the documentation, and there are
quite some situations where this same change would happen, so if we care
enough, all those instances could be changed. I don't know if we care
enough though. That's for others, like Randy, to decide.

Frans

  reply	other threads:[~2014-09-25 19:13 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-09-25 13:41 [PATCH 1/1] Changed "&" with "and" in Documentation/applying-patches.txt oscar
2014-09-25 14:48 ` Frans Klaver
2014-09-25 16:28   ` Oscar Utbult
2014-09-25 19:12     ` Frans Klaver [this message]
2014-09-25 19:35       ` Randy Dunlap
2014-09-25 17:21 ` Randy Dunlap

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20140925191254.GA2073@gmail.com \
    --to=fransklaver@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=oscar@oscr.io \
    --cc=rdunlap@infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox