All of lore.kernel.org
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: Frans Klaver <fransklaver@gmail.com>, Oscar Utbult <oscar@oscr.io>
Cc: 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 12:35:30 -0700	[thread overview]
Message-ID: <54246E82.1050305@infradead.org> (raw)
In-Reply-To: <20140925191254.GA2073@gmail.com>

On 09/25/14 12:12, Frans Klaver wrote:
> 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.

I think that we don't care enough.  The referenced web page talks about
formal documentation.  We aren't quite formal IMO.


-- 
~Randy

  reply	other threads:[~2014-09-25 19:35 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
2014-09-25 19:35       ` Randy Dunlap [this message]
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=54246E82.1050305@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=fransklaver@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=oscar@oscr.io \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.