From: Chao Fan <fanc.fnst@cn.fujitsu.com>
To: Baoquan He <bhe@redhat.com>
Cc: Michal Hocko <mhocko@kernel.org>, <linux-kernel@vger.kernel.org>,
<linux-mm@kvack.org>, <akpm@linux-foundation.org>,
<rppt@linux.ibm.com>, <osalvador@suse.de>, <willy@infradead.org>,
<william.kucharski@oracle.com>
Subject: Re: [PATCH v2 1/4] mm/sparse: Clean up the obsolete code comment
Date: Tue, 26 Mar 2019 17:46:42 +0800 [thread overview]
Message-ID: <20190326094642.GE4234@localhost.localdomain> (raw)
In-Reply-To: <20190326094348.GT3659@MiWiFi-R3L-srv>
On Tue, Mar 26, 2019 at 05:43:48PM +0800, Baoquan He wrote:
>On 03/26/19 at 05:36pm, Chao Fan wrote:
>> On Tue, Mar 26, 2019 at 05:30:57PM +0800, Baoquan He wrote:
>> >On 03/26/19 at 10:23am, Michal Hocko wrote:
>> >> On Tue 26-03-19 17:02:24, Baoquan He wrote:
>> >> > The code comment above sparse_add_one_section() is obsolete and
>> >> > incorrect, clean it up and write new one.
>> >> >
>> >> > Signed-off-by: Baoquan He <bhe@redhat.com>
>> >>
>> >> Please note that you need /** to start a kernel doc. Other than that.
>> >
>> >I didn't find a template in coding-style.rst, and saw someone is using
>> >/*, others use /**. I will use '/**' instead. Thanks for telling.
>>
>> How to format kernel-doc comments
>> ---------------------------------
>>
>> The opening comment mark ``/**`` is used for kernel-doc comments. The
>> ``kernel-doc`` tool will extract comments marked this way. The rest of
>> the comment is formatted like a normal multi-line comment with a column
>> of asterisks on the left side, closing with ``*/`` on a line by itself.
>>
>> See Documentation/doc-guide/kernel-doc.rst for more details.
>> Hope that can help you.
>
>Great, there's a specific kernel-doc file. Thanks, I will update and
>repost this one with '/**'.
In that file, there is also some sample for a function comment:
Function documentation
----------------------
The general format of a function and function-like macro kernel-doc comment is::
/**
* function_name() - Brief description of function.
* @arg1: Describe the first argument.
* @arg2: Describe the second argument.
* One can provide multiple line descriptions
* for arguments.
*
* A longer description, with more discussion of the function function_name()
* that might be useful to those using or modifying it. Begins with an
* empty comment line, and may include additional embedded empty
* comment lines.
*
* The longer description may have multiple paragraphs.
*
* Context: Describes whether the function can sleep, what locks it takes,
* releases, or expects to be held. It can extend over multiple
* lines.
* Return: Describe the return value of function_name.
*
* The return value description can also have multiple paragraphs, and should
* be placed at the end of the comment block.
*/
Anyway, I think you can get more information in that document.
Thanks,
Chao Fan
>
>
next prev parent reply other threads:[~2019-03-26 9:47 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-03-26 9:02 [PATCH v2 0/4] Clean up comments and codes in sparse_add_one_section() Baoquan He
2019-03-26 9:02 ` [PATCH v2 1/4] mm/sparse: Clean up the obsolete code comment Baoquan He
2019-03-26 9:23 ` Mike Rapoport
2019-03-26 9:23 ` Michal Hocko
2019-03-26 9:30 ` Baoquan He
2019-03-26 9:36 ` Chao Fan
2019-03-26 9:43 ` Baoquan He
2019-03-26 9:46 ` Chao Fan [this message]
2019-03-26 9:02 ` [PATCH v2 2/4] mm/sparse: Optimize sparse_add_one_section() Baoquan He
2019-03-26 9:23 ` Mike Rapoport
2019-03-26 9:29 ` Michal Hocko
2019-03-26 10:08 ` Baoquan He
2019-03-26 10:17 ` Michal Hocko
2019-03-26 13:45 ` Baoquan He
2019-03-26 13:57 ` Mike Rapoport
2019-03-26 14:03 ` Michal Hocko
2019-03-26 14:18 ` Baoquan He
2019-03-26 14:31 ` Michal Hocko
2019-03-26 22:57 ` Baoquan He
2019-03-26 9:02 ` [PATCH v2 3/4] mm/sparse: Rename function related to section memmap allocation/free Baoquan He
2019-03-26 9:02 ` [PATCH v2 4/4] drivers/base/memory.c: Rename the misleading parameter Baoquan He
2019-03-26 9:20 ` Rafael J. Wysocki
2019-03-26 9:33 ` Michal Hocko
2019-03-26 11:43 ` Matthew Wilcox
2019-03-26 12:42 ` Baoquan He
2019-03-29 6:44 ` [PATCH v2 0/4] Clean up comments and codes in sparse_add_one_section() Baoquan He
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=20190326094642.GE4234@localhost.localdomain \
--to=fanc.fnst@cn.fujitsu.com \
--cc=akpm@linux-foundation.org \
--cc=bhe@redhat.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=mhocko@kernel.org \
--cc=osalvador@suse.de \
--cc=rppt@linux.ibm.com \
--cc=william.kucharski@oracle.com \
--cc=willy@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;
as well as URLs for NNTP newsgroup(s).