fs: locks: Fix some troubles at kernel-doc comments
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Sat, 27 May 2017 10:07:18 +0000 (06:07 -0400)
committerJeff Layton <jlayton@redhat.com>
Sat, 27 May 2017 10:07:18 +0000 (06:07 -0400)
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>
Signed-off-by: Jeff Layton <jlayton@redhat.com>
fs/locks.c

index af2031a1fcff14fcfb05e108b9d49bfc4a74685f..4a4543a7f9c11baec01c01eb3e18ebc9637fcac1 100644 (file)
@@ -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.