linux-kernel - Re: [PATCH] kernel: events: use correct articles in comments

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20180705122750.2vsgjy35cfri2665@lakrids.cambridge.arm.com>
Date:   Thu, 5 Jul 2018 13:27:50 +0100
From:   Mark Rutland <mark.rutland@....com>
To:     Tobias Tefke <tobias.tefke@...il.com>
Cc:     tobias.tefke@...anota.com, peterz@...radead.org, mingo@...hat.com,
        acme@...nel.org, alexander.shishkin@...ux.intel.com,
        jolsa@...hat.com, namhyung@...nel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] kernel: events: use correct articles in comments

On Thu, Jul 05, 2018 at 01:26:08PM +0100, Mark Rutland wrote:
> On Thu, Jul 05, 2018 at 01:27:56PM +0200, Tobias Tefke wrote:
> > These words are pronounced (and start) with a vowel sound.
> > Therefore the article we use has to be 'an' instead of 'a'.
> > 
> > Signed-off-by: Tobias Tefke <tobias.tefke@...anota.com>
> 
> To clarify Alexander's reply, there's some guidance on writing commit
> messages in section 2 of:
> 
> Documentation/process/submitting-patches.rst
> 
> The basic idea is that the commit message should make sense on its own,
> even if you can't see the diff. Describe the problem first, any
> caveats, then the solution taken (in the imperative tense).
> 
> e.g. the above could be:
> 
> ----
> Some of the comments in the kernel events code use articles incorrectly,
> 'a' for words beginning with a vowel sound, where 'an' should be used.

Whoops, dropped a word here. That should say:

Some of the comments in the kernel events code use articles incorrectly,
using 'a' for words beginning with a vowel sound, where 'an' should be
used.

Mark.