[PATCH 30/36] net: skbuff.h: properly escape a macro name on kernel-doc

From	Mauro Carvalho Chehab <mchehab@s-opensource.com>
Newsgroups	linux.kernel
Subject	[PATCH 30/36] net: skbuff.h: properly escape a macro name on kernel-doc
Date	2017-05-12 16:10 +0200
Message-ID	<tGjqz-5DF-57@gated-at.bofh.it> (permalink)
References	<tGjqy-5DF-3@gated-at.bofh.it>
Organization	linux.* mail to news gateway

Show all headers | View raw

The "%" escape code of kernel-doc only handle letters. It
doesn't handle special chars. So, use the ``literal``
notation. That fixes this warning:

./include/linux/skbuff.h:2695: WARNING: Inline literal start-string without end-string.

No functional changes.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 include/linux/skbuff.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/skbuff.h b/include/linux/skbuff.h
index a098d95b3d84..25b1659c832a 100644
--- a/include/linux/skbuff.h
+++ b/include/linux/skbuff.h
@@ -2691,7 +2691,7 @@ bool skb_page_frag_refill(unsigned int sz, struct page_frag *pfrag, gfp_t prio);
  * @offset: the offset within the fragment (starting at the
  *          fragment's own offset)
  * @size: the number of bytes to map
- * @dir: the direction of the mapping (%PCI_DMA_*)
+ * @dir: the direction of the mapping (``PCI_DMA_*``)
  *
  * Maps the page associated with @frag to @device.
  */
-- 
2.9.3

Back to linux.kernel | Previous | Next | Find similar | Unroll thread

Thread

[PATCH 30/36] net: skbuff.h: properly escape a macro name on kernel-doc Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-12 16:10 +0200

csiph-web