fs: jbd2: escape a string with special chars on a kernel-doc
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Fri, 12 May 2017 10:58:23 +0000 (07:58 -0300)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Tue, 16 May 2017 11:44:11 +0000 (08:44 -0300)
kernel-doc will try to interpret a foo() string, except if
properly escaped.

Reviewed-by: Jan Kara <jack@suse.cz>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
fs/jbd2/transaction.c

index fe7f4a3734361717ea2ca25e3e4bef7bd6dc28df..38e1dcabbaca128417b3f7f27e99595b74ffa4df 100644 (file)
@@ -1066,10 +1066,10 @@ out:
  * @handle: transaction to add buffer modifications to
  * @bh:     bh to be used for metadata writes
  *
- * Returns an error code or 0 on success.
+ * Returns: error code or 0 on success.
  *
  * In full data journalling mode the buffer may be of type BJ_AsyncData,
- * because we're write()ing a buffer which is also part of a shared mapping.
+ * because we're ``write()ing`` a buffer which is also part of a shared mapping.
  */
 
 int jbd2_journal_get_write_access(handle_t *handle, struct buffer_head *bh)