Skip to content

Commit 692b65c

Browse files
mchehabWolfram Sang
authored andcommitted
i2c: 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]> Signed-off-by: Wolfram Sang <[email protected]>
1 parent e1b9f99 commit 692b65c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

include/linux/i2c.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -506,7 +506,7 @@ i2c_register_board_info(int busnum, struct i2c_board_info const *info,
506506
* @smbus_xfer_atomic: same as @smbus_xfer. Yet, only using atomic context
507507
* so e.g. PMICs can be accessed very late before shutdown. Optional.
508508
* @functionality: Return the flags that this algorithm/adapter pair supports
509-
* from the I2C_FUNC_* flags.
509+
* from the ``I2C_FUNC_*`` flags.
510510
* @reg_slave: Register given client to I2C slave mode of this adapter
511511
* @unreg_slave: Unregister given client from I2C slave mode of this adapter
512512
*
@@ -515,7 +515,7 @@ i2c_register_board_info(int busnum, struct i2c_board_info const *info,
515515
* be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
516516
* to name two of the most common.
517517
*
518-
* The return codes from the @master_xfer{_atomic} fields should indicate the
518+
* The return codes from the ``master_xfer{_atomic}`` fields should indicate the
519519
* type of error code that occurred during the transfer, as documented in the
520520
* Kernel Documentation file Documentation/i2c/fault-codes.rst.
521521
*/

0 commit comments

Comments
 (0)