Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]


Groups > linux.kernel > #1640472

[PATCH 24/36] fs: jbd2: escape a string with special chars on a kernel-doc

From Mauro Carvalho Chehab <mchehab@s-opensource.com>
Newsgroups linux.kernel
Subject [PATCH 24/36] fs: jbd2: escape a string with special chars on a kernel-doc
Date 2017-05-12 16:10 +0200
Message-ID <tGjqy-5DF-27@gated-at.bofh.it> (permalink)
References <tGjqy-5DF-3@gated-at.bofh.it>
Organization linux.* mail to news gateway

Show all headers | View raw


kernel-doc will try to interpret a foo() string, except if
properly escaped.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 fs/jbd2/transaction.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/fs/jbd2/transaction.c b/fs/jbd2/transaction.c
index fe7f4a373436..38e1dcabbaca 100644
--- a/fs/jbd2/transaction.c
+++ b/fs/jbd2/transaction.c
@@ -1066,10 +1066,10 @@ static bool jbd2_write_access_granted(handle_t *handle, struct buffer_head *bh,
  * @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)
-- 
2.9.3

Back to linux.kernel | Previous | NextNext in thread | Find similar | Unroll thread


Thread

[PATCH 24/36] fs: jbd2: escape a string with special chars on a kernel-doc Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-12 16:10 +0200
  Re: [PATCH 24/36] fs: jbd2: escape a string with special chars on a  kernel-doc Jan Kara <jack@suse.cz> - 2017-05-15 15:10 +0200

csiph-web