LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: "Luis R. Rodriguez" <mcgrof@kernel.org>,
Bart Van Assche <Bart.VanAssche@wdc.com>
Cc: "viro@zeniv.linux.org.uk" <viro@zeniv.linux.org.uk>,
"linux-fsdevel@vger.kernel.org" <linux-fsdevel@vger.kernel.org>,
"mguzik@redhat.com" <mguzik@redhat.com>,
"jack@suse.cz" <jack@suse.cz>,
"linux-block@vger.kernel.org" <linux-block@vger.kernel.org>,
"linux-pm@vger.kernel.org" <linux-pm@vger.kernel.org>,
"rjw@rjwysocki.net" <rjw@rjwysocki.net>,
"ming.lei@redhat.com" <ming.lei@redhat.com>,
"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH 1/3] fs: move documentation for thaw_super() where appropriate
Date: Fri, 20 Apr 2018 17:09:48 -0700 [thread overview]
Message-ID: <aeeed05a-36c6-34b3-040e-d6ba4872c033@infradead.org> (raw)
In-Reply-To: <20180421000719.GH14440@wotan.suse.de>
On 04/20/18 17:07, Luis R. Rodriguez wrote:
> On Sat, Apr 21, 2018 at 12:01:31AM +0000, Bart Van Assche wrote:
>> On Fri, 2018-04-20 at 16:59 -0700, Luis R. Rodriguez wrote:
>>> +/**
>>> + * thaw_super -- unlock filesystem
>>> + * @sb: the super to thaw
>>> + *
>>> + * Unlocks the filesystem and marks it writeable again after freeze_super().
>>> + */
>>
>> Have you verified the output generated by scripts/kernel-doc? Last
>> time I checked the output for headers containing a double dash looked
>> weird.
>
> No, I just moved the block of kdoc crap. Randy would have this memorized I'm
> sure though so I should just fix the kdoc if its bad while at it.
>
> Luis
>
"--" does sound odd. I've never seen it used on purpose.
FWIW, I just go by what is in Documentation/doc-guide/kernel-doc.rst:
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.
--
~Randy
next prev parent reply other threads:[~2018-04-21 0:10 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-04-20 23:59 [PATCH 0/3] fs: minor fs thaw fixes and adjustments Luis R. Rodriguez
2018-04-20 23:59 ` [PATCH 1/3] fs: move documentation for thaw_super() where appropriate Luis R. Rodriguez
2018-04-21 0:01 ` Bart Van Assche
2018-04-21 0:07 ` Luis R. Rodriguez
2018-04-21 0:09 ` Randy Dunlap [this message]
2018-05-03 14:53 ` Jan Kara
2018-04-20 23:59 ` [PATCH 2/3] fs: make thaw_super_locked() really just a helper Luis R. Rodriguez
2018-05-03 15:07 ` Jan Kara
2018-04-20 23:59 ` [PATCH 3/3] fs: fix corner case race on freeze_bdev() when sb disappears Luis R. Rodriguez
2018-05-03 15:02 ` Jan Kara
2018-04-21 0:02 ` [PATCH 0/3] fs: minor fs thaw fixes and adjustments Luis R. Rodriguez
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=aeeed05a-36c6-34b3-040e-d6ba4872c033@infradead.org \
--to=rdunlap@infradead.org \
--cc=Bart.VanAssche@wdc.com \
--cc=jack@suse.cz \
--cc=linux-block@vger.kernel.org \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=mcgrof@kernel.org \
--cc=mguzik@redhat.com \
--cc=ming.lei@redhat.com \
--cc=rjw@rjwysocki.net \
--cc=viro@zeniv.linux.org.uk \
--subject='Re: [PATCH 1/3] fs: move documentation for thaw_super() where appropriate' \
/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
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).