2020-03-17 14:56:30

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 13/17] i2c: include/linux/i2c.h: fix a doc warning

Don't let non-letters inside a literal block without escaping it, as
the toolchain would mis-interpret it:

./include/linux/i2c.h:518: WARNING: Inline strong start-string without end-string.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
include/linux/i2c.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/linux/i2c.h b/include/linux/i2c.h
index f834687989f7..f6b942150631 100644
--- a/include/linux/i2c.h
+++ b/include/linux/i2c.h
@@ -506,7 +506,7 @@ i2c_register_board_info(int busnum, struct i2c_board_info const *info,
* @smbus_xfer_atomic: same as @smbus_xfer. Yet, only using atomic context
* so e.g. PMICs can be accessed very late before shutdown. Optional.
* @functionality: Return the flags that this algorithm/adapter pair supports
- * from the I2C_FUNC_* flags.
+ * from the ``I2C_FUNC_*`` flags.
* @reg_slave: Register given client to I2C slave mode of this adapter
* @unreg_slave: Unregister given client from I2C slave mode of this adapter
*
@@ -515,7 +515,7 @@ i2c_register_board_info(int busnum, struct i2c_board_info const *info,
* be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
* to name two of the most common.
*
- * The return codes from the @master_xfer{_atomic} fields should indicate the
+ * The return codes from the ``master_xfer{_atomic}`` fields should indicate the
* type of error code that occurred during the transfer, as documented in the
* Kernel Documentation file Documentation/i2c/fault-codes.rst.
*/
--
2.24.1


2020-03-17 15:04:49

by Wolfram Sang

[permalink] [raw]
Subject: Re: [PATCH 13/17] i2c: include/linux/i2c.h: fix a doc warning

On Tue, Mar 17, 2020 at 03:54:22PM +0100, Mauro Carvalho Chehab wrote:
> Don't let non-letters inside a literal block without escaping it, as
> the toolchain would mis-interpret it:
>
> ./include/linux/i2c.h:518: WARNING: Inline strong start-string without end-string.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>

Shall I take this via I2C?

If not:

Acked-by: Wolfram Sang <[email protected]>


Attachments:
(No filename) (436.00 B)
signature.asc (849.00 B)
Download all attachments

2020-03-17 15:08:30

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: Re: [PATCH 13/17] i2c: include/linux/i2c.h: fix a doc warning

Em Tue, 17 Mar 2020 16:03:22 +0100
Wolfram Sang <[email protected]> escreveu:

> On Tue, Mar 17, 2020 at 03:54:22PM +0100, Mauro Carvalho Chehab wrote:
> > Don't let non-letters inside a literal block without escaping it, as
> > the toolchain would mis-interpret it:
> >
> > ./include/linux/i2c.h:518: WARNING: Inline strong start-string without end-string.
> >
> > Signed-off-by: Mauro Carvalho Chehab <[email protected]>
>
> Shall I take this via I2C?

Yeah, feel free to pick it. The patches on this series are pretty
much independent from the others.

Thanks,
Mauro

2020-03-22 16:23:16

by Wolfram Sang

[permalink] [raw]
Subject: Re: [PATCH 13/17] i2c: include/linux/i2c.h: fix a doc warning

On Tue, Mar 17, 2020 at 03:54:22PM +0100, Mauro Carvalho Chehab wrote:
> Don't let non-letters inside a literal block without escaping it, as
> the toolchain would mis-interpret it:
>
> ./include/linux/i2c.h:518: WARNING: Inline strong start-string without end-string.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>

Applied to for-current, thanks!


Attachments:
(No filename) (384.00 B)
signature.asc (849.00 B)
Download all attachments