| Message ID | 20180420235904.27496-2-mcgrof@kernel.org (mailing list archive) |
|---|---|
| State | Changes Requested, archived |
| Delegated to: | Eduardo Valentin |
| Headers | show |
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. Bart.
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
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.
On Fri 20-04-18 16:59:02, Luis R. Rodriguez wrote: > On commit 08fdc8a0138a ("buffer.c: call thaw_super during emergency thaw") > Mateusz added thaw_super_locked() and made thaw_super() use it, but > forgot to move the documentation. > > Signed-off-by: Luis R. Rodriguez <mcgrof@kernel.org> Looks good (modulo the -- which is probably worth fixing when touching the comment anyway). You can add: Reviewed-by: Jan Kara <jack@suse.cz> Honza > --- > fs/super.c | 12 ++++++------ > 1 file changed, 6 insertions(+), 6 deletions(-) > > diff --git a/fs/super.c b/fs/super.c > index 5fa9a8d8d865..9d0eb5e20a1f 100644 > --- a/fs/super.c > +++ b/fs/super.c > @@ -1532,12 +1532,6 @@ int freeze_super(struct super_block *sb) > } > EXPORT_SYMBOL(freeze_super); > > -/** > - * thaw_super -- unlock filesystem > - * @sb: the super to thaw > - * > - * Unlocks the filesystem and marks it writeable again after freeze_super(). > - */ > static int thaw_super_locked(struct super_block *sb) > { > int error; > @@ -1573,6 +1567,12 @@ static int thaw_super_locked(struct super_block *sb) > return 0; > } > > +/** > + * thaw_super -- unlock filesystem > + * @sb: the super to thaw > + * > + * Unlocks the filesystem and marks it writeable again after freeze_super(). > + */ > int thaw_super(struct super_block *sb) > { > down_write(&sb->s_umount); > -- > 2.16.3 >
diff --git a/fs/super.c b/fs/super.c index 5fa9a8d8d865..9d0eb5e20a1f 100644 --- a/fs/super.c +++ b/fs/super.c @@ -1532,12 +1532,6 @@ int freeze_super(struct super_block *sb) } EXPORT_SYMBOL(freeze_super); -/** - * thaw_super -- unlock filesystem - * @sb: the super to thaw - * - * Unlocks the filesystem and marks it writeable again after freeze_super(). - */ static int thaw_super_locked(struct super_block *sb) { int error; @@ -1573,6 +1567,12 @@ static int thaw_super_locked(struct super_block *sb) return 0; } +/** + * thaw_super -- unlock filesystem + * @sb: the super to thaw + * + * Unlocks the filesystem and marks it writeable again after freeze_super(). + */ int thaw_super(struct super_block *sb) { down_write(&sb->s_umount);
On commit 08fdc8a0138a ("buffer.c: call thaw_super during emergency thaw") Mateusz added thaw_super_locked() and made thaw_super() use it, but forgot to move the documentation. Signed-off-by: Luis R. Rodriguez <mcgrof@kernel.org> --- fs/super.c | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)