diff mbox

[21/36] fs: locks: Fix some troubles at kernel-doc comments

Message ID 3d50c955e3c153d37ab872f9b0f98b292d6c347a.1494596071.git.mchehab@s-opensource.com (mailing list archive)
State New, archived
Headers show

Commit Message

Mauro Carvalho Chehab May 12, 2017, 2 p.m. UTC
There are a few syntax violations that cause outputs of
a few comments to not be properly parsed in ReST format.

No functional changes.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 fs/locks.c | 18 ++++++++----------
 1 file changed, 8 insertions(+), 10 deletions(-)

Comments

Mauro Carvalho Chehab May 13, 2017, 9:14 a.m. UTC | #1
Hi Jeff,

Em Fri, 12 May 2017 10:02:56 -0400
Jeff Layton <jlayton@poochiereds.net> escreveu:

> On Fri, 2017-05-12 at 11:00 -0300, Mauro Carvalho Chehab wrote:
> > There are a few syntax violations that cause outputs of
> > a few comments to not be properly parsed in ReST format.
> > 
> > No functional changes.
> > 
> > Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
> > ---
> >  fs/locks.c | 18 ++++++++----------
> >  1 file changed, 8 insertions(+), 10 deletions(-)
> > 
> > diff --git a/fs/locks.c b/fs/locks.c
> > index 26811321d39b..bdce708e4251 100644
> > --- a/fs/locks.c
> > +++ b/fs/locks.c
> > @@ -1858,8 +1858,8 @@ EXPORT_SYMBOL(generic_setlease);
> >   *
> >   * Call this to establish a lease on the file. The "lease" argument is not
> >   * used for F_UNLCK requests and may be NULL. For commands that set or alter
> > - * an existing lease, the (*lease)->fl_lmops->lm_break operation must be set;
> > - * if not, this function will return -ENOLCK (and generate a scary-looking
> > + * an existing lease, the ``(*lease)->fl_lmops->lm_break`` operation must be
> > + * set; if not, this function will return -ENOLCK (and generate a scary-looking
> >   * stack trace).
> >   *
> >   * The "priv" pointer is passed directly to the lm_setup function as-is. It
> > @@ -1972,15 +1972,13 @@ EXPORT_SYMBOL(locks_lock_inode_wait);
> >   *	@cmd: the type of lock to apply.
> >   *
> >   *	Apply a %FL_FLOCK style lock to an open file descriptor.
> > - *	The @cmd can be one of
> > + *	The @cmd can be one of:
> >   *
> > - *	%LOCK_SH -- a shared lock.
> > - *
> > - *	%LOCK_EX -- an exclusive lock.
> > - *
> > - *	%LOCK_UN -- remove an existing lock.
> > - *
> > - *	%LOCK_MAND -- a `mandatory' flock.  This exists to emulate Windows Share Modes.
> > + *	- %LOCK_SH -- a shared lock.
> > + *	- %LOCK_EX -- an exclusive lock.
> > + *	- %LOCK_UN -- remove an existing lock.
> > + *	- %LOCK_MAND -- a 'mandatory' flock.
> > + *	  This exists to emulate Windows Share Modes.
> >   *
> >   *	%LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
> >   *	processes read and write access respectively.  
> 
> LGTM. Do you need me or Bruce to pick this one up?

Feel free to pick it, if it works best for you.

> Reviewed-by: Jeff Layton <jlayton@poochiereds.net>


Thanks,
Mauro
J. Bruce Fields May 15, 2017, 2:51 p.m. UTC | #2
On Sat, May 13, 2017 at 06:14:06AM -0300, Mauro Carvalho Chehab wrote:
> Hi Jeff,
> 
> Em Fri, 12 May 2017 10:02:56 -0400
> Jeff Layton <jlayton@poochiereds.net> escreveu:
> 
> > On Fri, 2017-05-12 at 11:00 -0300, Mauro Carvalho Chehab wrote:
> > > There are a few syntax violations that cause outputs of
> > > a few comments to not be properly parsed in ReST format.
> > > 
> > > No functional changes.
> > > 
> > > Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
> > > ---
> > >  fs/locks.c | 18 ++++++++----------
> > >  1 file changed, 8 insertions(+), 10 deletions(-)
> > > 
> > > diff --git a/fs/locks.c b/fs/locks.c
> > > index 26811321d39b..bdce708e4251 100644
> > > --- a/fs/locks.c
> > > +++ b/fs/locks.c
> > > @@ -1858,8 +1858,8 @@ EXPORT_SYMBOL(generic_setlease);
> > >   *
> > >   * Call this to establish a lease on the file. The "lease" argument is not
> > >   * used for F_UNLCK requests and may be NULL. For commands that set or alter
> > > - * an existing lease, the (*lease)->fl_lmops->lm_break operation must be set;
> > > - * if not, this function will return -ENOLCK (and generate a scary-looking
> > > + * an existing lease, the ``(*lease)->fl_lmops->lm_break`` operation must be
> > > + * set; if not, this function will return -ENOLCK (and generate a scary-looking
> > >   * stack trace).
> > >   *
> > >   * The "priv" pointer is passed directly to the lm_setup function as-is. It
> > > @@ -1972,15 +1972,13 @@ EXPORT_SYMBOL(locks_lock_inode_wait);
> > >   *	@cmd: the type of lock to apply.
> > >   *
> > >   *	Apply a %FL_FLOCK style lock to an open file descriptor.
> > > - *	The @cmd can be one of
> > > + *	The @cmd can be one of:
> > >   *
> > > - *	%LOCK_SH -- a shared lock.
> > > - *
> > > - *	%LOCK_EX -- an exclusive lock.
> > > - *
> > > - *	%LOCK_UN -- remove an existing lock.
> > > - *
> > > - *	%LOCK_MAND -- a `mandatory' flock.  This exists to emulate Windows Share Modes.
> > > + *	- %LOCK_SH -- a shared lock.
> > > + *	- %LOCK_EX -- an exclusive lock.
> > > + *	- %LOCK_UN -- remove an existing lock.
> > > + *	- %LOCK_MAND -- a 'mandatory' flock.
> > > + *	  This exists to emulate Windows Share Modes.
> > >   *
> > >   *	%LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
> > >   *	processes read and write access respectively.  
> > 
> > LGTM. Do you need me or Bruce to pick this one up?
> 
> Feel free to pick it, if it works best for you.
> 
> > Reviewed-by: Jeff Layton <jlayton@poochiereds.net>

I'll take it for 4.13.  Thanks!

--b.
diff mbox

Patch

diff --git a/fs/locks.c b/fs/locks.c
index 26811321d39b..bdce708e4251 100644
--- a/fs/locks.c
+++ b/fs/locks.c
@@ -1858,8 +1858,8 @@  EXPORT_SYMBOL(generic_setlease);
  *
  * Call this to establish a lease on the file. The "lease" argument is not
  * used for F_UNLCK requests and may be NULL. For commands that set or alter
- * an existing lease, the (*lease)->fl_lmops->lm_break operation must be set;
- * if not, this function will return -ENOLCK (and generate a scary-looking
+ * an existing lease, the ``(*lease)->fl_lmops->lm_break`` operation must be
+ * set; if not, this function will return -ENOLCK (and generate a scary-looking
  * stack trace).
  *
  * The "priv" pointer is passed directly to the lm_setup function as-is. It
@@ -1972,15 +1972,13 @@  EXPORT_SYMBOL(locks_lock_inode_wait);
  *	@cmd: the type of lock to apply.
  *
  *	Apply a %FL_FLOCK style lock to an open file descriptor.
- *	The @cmd can be one of
+ *	The @cmd can be one of:
  *
- *	%LOCK_SH -- a shared lock.
- *
- *	%LOCK_EX -- an exclusive lock.
- *
- *	%LOCK_UN -- remove an existing lock.
- *
- *	%LOCK_MAND -- a `mandatory' flock.  This exists to emulate Windows Share Modes.
+ *	- %LOCK_SH -- a shared lock.
+ *	- %LOCK_EX -- an exclusive lock.
+ *	- %LOCK_UN -- remove an existing lock.
+ *	- %LOCK_MAND -- a 'mandatory' flock.
+ *	  This exists to emulate Windows Share Modes.
  *
  *	%LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
  *	processes read and write access respectively.