mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	David Woodhouse <dwmw2@infradead.org>,
	Brian Norris <computersforpeace@gmail.com>,
	Boris Brezillon <boris.brezillon@free-electrons.com>,
	Marek Vasut <marek.vasut@gmail.com>,
	Richard Weinberger <richard@nod.at>,
	Cyrille Pitchen <cyrille.pitchen@atmel.com>,
	linux-mtd@lists.infradead.org,
	"David S. Miller" <davem@davemloft.net>,
	Eric Dumazet <edumazet@google.com>,
	Daniel Borkmann <daniel@iogearbox.net>,
	Willem de Bruijn <willemb@google.com>,
	Marcelo Ricardo Leitner <marcelo.leitner@gmail.com>,
	Al Viro <viro@zeniv.linux.org.uk>,
	Florian Westphal <fw@strlen.de>,
	WANG Cong <xiyou.wangcong@gmail.com>,
	Julian Anastasov <ja@ssi.bg>, Ido Schimmel <idosch@mellanox.com>
Subject: [PATCH v2 29/53] net: skbuff.h: properly escape a macro name on kernel-doc
Date: Tue, 16 May 2017 09:16:21 -0300	[thread overview]
Message-ID: <771b00a84be46d10e3f74af2d86d226302c907c5.1494935649.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <cover.1494935649.git.mchehab@s-opensource.com>
In-Reply-To: <cover.1494935649.git.mchehab@s-opensource.com>

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

  parent reply	other threads:[~2017-05-16 12:26 UTC|newest]

Thread overview: 79+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-05-16 12:15 [PATCH v2 00/53] Get rid of Docbook Mauro Carvalho Chehab
2017-05-16 12:15 ` [PATCH v2 01/53] docs-rst: convert kernel-hacking to ReST Mauro Carvalho Chehab
2017-05-16 12:15 ` [PATCH v2 02/53] kernel-hacking: update document Mauro Carvalho Chehab
2017-05-16 12:15 ` [PATCH v2 03/53] docs-rst: convert kernel-locking to ReST Mauro Carvalho Chehab
2017-05-16 12:15 ` [PATCH v2 04/53] mutex, futex: adjust kernel-doc markups to generate ReST Mauro Carvalho Chehab
2017-05-16 17:35   ` Darren Hart
2017-05-16 18:24     ` Mauro Carvalho Chehab
2017-05-16 19:00       ` Darren Hart
2017-05-16 12:15 ` [PATCH v2 05/53] locking.rst: reformat locking table Mauro Carvalho Chehab
2017-05-16 12:15 ` [PATCH v2 06/53] locking.rst: add captions to two tables Mauro Carvalho Chehab
2017-05-16 12:15 ` [PATCH v2 07/53] locking.rst: Update some ReST markups Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 08/53] docs-rst: convert kgdb DocBook to ReST Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 09/53] kgdb.rst: Adjust ReST markups Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 10/53] conf.py: define a color for important markup on PDF output Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 11/53] docs-rst: conf.py: sort LaTeX documents in alphabetical order Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 12/53] docs-rst: conf.py: remove kernel-documentation from LaTeX Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 13/53] docs-rst: add crypto API book to pdf output Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 14/53] docs-rst: add dev-tools " Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 15/53] docs-rst: add sound " Mauro Carvalho Chehab
2017-05-16 19:02   ` Takashi Iwai
2017-05-16 12:16 ` [PATCH v2 16/53] docs-rst: add userspace API " Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 17/53] docs-rst: convert filesystems book to ReST Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 18/53] docs-rst: filesystems: use c domain references where needed Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 19/53] fs: jbd2: make jbd2_journal_start() kernel-doc parseable Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 20/53] docs-rst: don't ignore internal functions for jbd2 docs Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 21/53] fs: add a blank lines on some kernel-doc comments Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 22/53] fs: eventfd: fix identation on kernel-doc Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 23/53] fs: jbd2: escape a string with special chars on a kernel-doc Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 24/53] docs-rst: convert libata book to ReST Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 25/53] libata.rst: add c function and struct cross-references Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 26/53] libata: fix identation on a kernel-doc markup Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 27/53] docs-rst: convert s390-drivers DocBook to ReST Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 28/53] docs-rst: convert networking book " Mauro Carvalho Chehab
2017-05-16 12:16 ` Mauro Carvalho Chehab [this message]
2017-05-16 12:16 ` [PATCH v2 30/53] net: fix some identation issues at kernel-doc markups Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 31/53] docs-rst: convert z8530book DocBook to ReST Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 32/53] docs-rst: convert scsi " Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 33/53] scsi: fix some kernel-doc markups Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 34/53] docs-rst: convert w1 book to ReST Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 35/53] docs-rst: convert rapidio " Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 36/53] docs-rst: convert librs " Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 37/53] docs-rst: convert mtdnand " Mauro Carvalho Chehab
2017-05-16 13:11   ` Boris Brezillon
2017-05-16 12:16 ` [PATCH v2 38/53] mtdnand.rst: group the "::" with previous line Mauro Carvalho Chehab
2017-05-16 13:12   ` Boris Brezillon
2017-05-16 12:16 ` [PATCH v2 39/53] mtd: adjust kernel-docs to avoid Sphinx/kerneldoc warnings Mauro Carvalho Chehab
2017-05-16 13:13   ` Boris Brezillon
2017-05-16 12:16 ` [PATCH v2 40/53] docs-rst: convert sh book to ReST Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 41/53] docs-rst: convert lsm from DocBook " Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 42/53] docs: remove DocBook from the building system Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 43/53] docs: update old references for DocBook from the documentation Mauro Carvalho Chehab
2017-05-16 12:47   ` Bartlomiej Zolnierkiewicz
2017-05-17 16:51   ` Bjorn Helgaas
2017-05-16 12:16 ` [PATCH v2 44/53] MAINTAINERS: update old references for DocBook directory Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 45/53] ata: update references for libata documentation Mauro Carvalho Chehab
2017-05-16 12:47   ` Bartlomiej Zolnierkiewicz
2017-05-16 12:16 ` [PATCH v2 46/53] ia64, scsi: update references for the device-io book Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 47/53] irq: update genericirq book location Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 48/53] fs: update location of filesystems documentation Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 49/53] lib: update location of kgdb documentation Mauro Carvalho Chehab
2017-05-16 12:38 ` [PATCH v2 30/53] net: fix some identation issues at kernel-doc markups David Howells
2017-05-16 18:11 ` [PATCH v2 50/53] fs: fix the location of the kernel-api book Mauro Carvalho Chehab
2017-05-16 12:16   ` Mauro Carvalho Chehab
2017-05-16 18:11 ` [PATCH v2 51/53] usb: fix the comment with regards to DocBook Mauro Carvalho Chehab
2017-05-16 12:16   ` Mauro Carvalho Chehab
2017-05-17 11:13   ` Felipe Balbi
2017-05-16 18:11 ` [PATCH v2 52/53] docs-rst: get rid of Documentation/sphinx/tmplcvt script Mauro Carvalho Chehab
2017-05-16 12:16   ` Mauro Carvalho Chehab
2017-05-16 18:12 ` [PATCH v2 53/53] kernel-doc: describe the ``literal`` syntax Mauro Carvalho Chehab
2017-05-16 12:16   ` Mauro Carvalho Chehab
2018-06-06 16:31   ` Markus Heiser
2017-05-18 17:26 ` [PATCH v2 00/53] Get rid of Docbook Jonathan Corbet
2017-05-18 23:01   ` Mauro Carvalho Chehab
2017-06-16 14:03     ` Markus Heiser
2017-06-23 20:26       ` Jonathan Corbet
2017-07-05 21:45       ` Jim Davis
2017-07-06  8:54         ` Markus Heiser
2017-07-14 23:15           ` Jim Davis
2017-07-15  1:52             ` Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=771b00a84be46d10e3f74af2d86d226302c907c5.1494935649.git.mchehab@s-opensource.com \
    --to=mchehab@s-opensource.com \
    --cc=boris.brezillon@free-electrons.com \
    --cc=computersforpeace@gmail.com \
    --cc=corbet@lwn.net \
    --cc=cyrille.pitchen@atmel.com \
    --cc=daniel@iogearbox.net \
    --cc=davem@davemloft.net \
    --cc=dwmw2@infradead.org \
    --cc=edumazet@google.com \
    --cc=fw@strlen.de \
    --cc=idosch@mellanox.com \
    --cc=ja@ssi.bg \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mtd@lists.infradead.org \
    --cc=marcelo.leitner@gmail.com \
    --cc=marek.vasut@gmail.com \
    --cc=mchehab@infradead.org \
    --cc=richard@nod.at \
    --cc=viro@zeniv.linux.org.uk \
    --cc=willemb@google.com \
    --cc=xiyou.wangcong@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®