diff mbox series

mtd: rawnand: Fix sphinx syntax

Message ID 20190321235242.32158-1-j.neuschaefer@gmx.net
State Accepted
Delegated to: Miquel Raynal
Headers show
Series mtd: rawnand: Fix sphinx syntax | expand

Commit Message

Jonathan Neuschäfer March 21, 2019, 11:52 p.m. UTC
Sphinx doesn't handle expressions in identifier references.

This fixes the following warnings:

./include/linux/mtd/rawnand.h:1184: WARNING: Inline strong start-string without end-string.
./include/linux/mtd/rawnand.h:1186: WARNING: Inline strong start-string without end-string.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
 include/linux/mtd/rawnand.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--
2.20.1

Comments

Miquel Raynal April 18, 2019, 4:09 p.m. UTC | #1
Hi Jonathan,

Jonathan Neuschäfer <j.neuschaefer@gmx.net> wrote on Fri, 22 Mar 2019
00:52:41 +0100:

> Sphinx doesn't handle expressions in identifier references.
> 
> This fixes the following warnings:
> 
> ./include/linux/mtd/rawnand.h:1184: WARNING: Inline strong start-string without end-string.
> ./include/linux/mtd/rawnand.h:1186: WARNING: Inline strong start-string without end-string.
> 
> Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
> ---

Applied to 
https://git.kernel.org/pub/scm/linux/kernel/git/mtd/linux.git 
branch nand/next.

Thanks, Miquèl
diff mbox series

Patch

diff --git a/include/linux/mtd/rawnand.h b/include/linux/mtd/rawnand.h
index b7445a44a814..27c2db8e4a1f 100644
--- a/include/linux/mtd/rawnand.h
+++ b/include/linux/mtd/rawnand.h
@@ -1180,9 +1180,9 @@  static inline void *nand_get_manufacturer_data(struct nand_chip *chip)
  * @name: a human-readable name of the NAND chip
  * @dev_id: the device ID (the second byte of the full chip ID array)
  * @mfr_id: manufecturer ID part of the full chip ID array (refers the same
- *          memory address as @id[0])
+ *          memory address as ``id[0]``)
  * @dev_id: device ID part of the full chip ID array (refers the same memory
- *          address as @id[1])
+ *          address as ``id[1]``)
  * @id: full device ID array
  * @pagesize: size of the NAND page in bytes; if 0, then the real page size (as
  *            well as the eraseblock size) is determined from the extended NAND