linux-kernel - Re: [RFC PATCH 3/5] kobject: Fix kernel-doc comment first line

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <20190503062320.62849fd4@lwn.net>
Date:   Fri, 3 May 2019 06:23:20 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     "Tobin C. Harding" <me@...in.cc>, Johan Hovold <johan@...nel.org>,
        "Tobin C. Harding" <tobin@...nel.org>,
        Josh Poimboeuf <jpoimboe@...hat.com>,
        Jiri Kosina <jikos@...nel.org>,
        Miroslav Benes <mbenes@...e.cz>,
        Petr Mladek <pmladek@...e.com>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        "Rafael J. Wysocki" <rafael@...nel.org>,
        Joe Lawrence <joe.lawrence@...hat.com>,
        live-patching@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [RFC PATCH 3/5] kobject: Fix kernel-doc comment first line

On Thu, 2 May 2019 18:46:16 -0700
Randy Dunlap <rdunlap@...radead.org> wrote:

> I have seen this discussion before also.  And sometimes it is not even
> a discussion -- it's more of an edict.  To which I object/disagree.
> The current (or past) comment style is perfectly fine IMO.
> No caps needed.  No ending '.' needed.

For however much this matters...I really don't see that there needs to be
a rule one way or the other on this; the documentation serves its purpose
either way.  I guess I see it like "British or American spelling";
there's nothing to drive a conversion in either direction.

jon