From: Johan Hovold <johan@kernel.org>
To: "Tobin C. Harding" <tobin@kernel.org>
Cc: Josh Poimboeuf <jpoimboe@redhat.com>,
Jiri Kosina <jikos@kernel.org>, Miroslav Benes <mbenes@suse.cz>,
Petr Mladek <pmladek@suse.com>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
"Rafael J. Wysocki" <rafael@kernel.org>,
Joe Lawrence <joe.lawrence@redhat.com>,
live-patching@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [RFC PATCH 3/5] kobject: Fix kernel-doc comment first line
Date: Thu, 2 May 2019 09:38:23 +0200 [thread overview]
Message-ID: <20190502073823.GQ26546@localhost> (raw)
In-Reply-To: <20190502023142.20139-4-tobin@kernel.org>
On Thu, May 02, 2019 at 12:31:40PM +1000, Tobin C. Harding wrote:
> kernel-doc comments have a prescribed format. This includes parenthesis
> on the function name. To be _particularly_ correct we should also
> capitalise the brief description and terminate it with a period.
Why do think capitalisation and full stop is required for the function
description?
Sure, the example in the current doc happen to use that, but I'm not
sure that's intended as a prescription.
The old kernel-doc nano-HOWTO specifically did not use this:
https://www.kernel.org/doc/Documentation/kernel-doc-nano-HOWTO.txt
Johan
next prev parent reply other threads:[~2019-05-02 7:38 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-05-02 2:31 [RFC PATCH 0/5] kobject: Add and use init predicate Tobin C. Harding
2019-05-02 2:31 ` [RFC PATCH 1/5] livepatch: Fix kobject memleak Tobin C. Harding
2019-05-02 7:22 ` Greg Kroah-Hartman
2019-05-02 8:46 ` Petr Mladek
2019-05-02 2:31 ` [RFC PATCH 2/5] kobject: Remove docstring reference to kset Tobin C. Harding
2019-05-02 7:20 ` Greg Kroah-Hartman
2019-05-02 2:31 ` [RFC PATCH 3/5] kobject: Fix kernel-doc comment first line Tobin C. Harding
2019-05-02 7:20 ` Greg Kroah-Hartman
2019-05-02 7:38 ` Johan Hovold [this message]
2019-05-02 8:25 ` Tobin C. Harding
2019-05-02 8:39 ` Johan Hovold
2019-05-03 1:40 ` Tobin C. Harding
2019-05-03 1:46 ` Randy Dunlap
2019-05-03 12:23 ` Jonathan Corbet
2019-05-03 7:56 ` Johan Hovold
2019-05-03 8:05 ` Petr Mladek
2019-05-06 23:00 ` Tobin C. Harding
2019-05-07 9:38 ` Johan Hovold
2019-05-02 2:31 ` [RFC PATCH 4/5] kobject: Add kobject initialized predicate Tobin C. Harding
2019-05-02 2:31 ` [RFC PATCH 5/5] livepatch: Do not manually track kobject initialization Tobin C. Harding
2019-05-02 7:12 ` Greg Kroah-Hartman
2019-05-02 7:30 ` Petr Mladek
2019-05-02 7:42 ` Greg Kroah-Hartman
2019-05-02 8:31 ` Tobin C. Harding
2019-05-02 8:51 ` Petr Mladek
2019-05-02 11:42 ` [RFC PATCH 0/5] kobject: Add and use init predicate Miroslav Benes
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=20190502073823.GQ26546@localhost \
--to=johan@kernel.org \
--cc=gregkh@linuxfoundation.org \
--cc=jikos@kernel.org \
--cc=joe.lawrence@redhat.com \
--cc=jpoimboe@redhat.com \
--cc=linux-kernel@vger.kernel.org \
--cc=live-patching@vger.kernel.org \
--cc=mbenes@suse.cz \
--cc=pmladek@suse.com \
--cc=rafael@kernel.org \
--cc=tobin@kernel.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 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.