linux-next: build warnings after merge of the tty tree
Subsystems (3)
Hi all,
After merging the tty tree, today's linux-next build (htmldocs) produced these warnings:
Documentation/driver-api/tty/tty_ldisc:46: include/linux/tty_ldisc.h:190: WARNING: Inline literal start-string without end-string. Documentation/driver-api/tty/tty_ldisc:46: include/linux/tty_ldisc.h:190: WARNING: Inline emphasis start-string without end-string. Documentation/driver-api/tty/tty_ldisc:46: include/linux/tty_ldisc.h:190: WARNING: Inline emphasis start-string without end-string. Documentation/driver-api/tty/tty_ldisc:46: include/linux/tty_ldisc.h:190: WARNING: Inline emphasis start-string without end-string.
Introduced by commit
6bb6fa6908eb ("tty: Implement lookahead to process XON/XOFF timely")
Signature · 2 lines
Cheers, Stephen Rothwell
PATCH 1/1 Documentation: tty: add closing double backticks for lookahead_buf() prototype
After merging tty tree for linux-next testing, Stephen Rothwell reported htmldocs warning:
Documentation/driver-api/tty/tty_ldisc:46: include/linux/tty_ldisc.h:190: WARNING: Inline literal start-string without end-string. Documentation/driver-api/tty/tty_ldisc:46: include/linux/tty_ldisc.h:190: WARNING: Inline emphasis start-string without end-string. Documentation/driver-api/tty/tty_ldisc:46: include/linux/tty_ldisc.h:190: WARNING: Inline emphasis start-string without end-string. Documentation/driver-api/tty/tty_ldisc:46: include/linux/tty_ldisc.h:190: WARNING: Inline emphasis start-string without end-string.
The warning is because of missing closing double backticks at lookahead_buf() function prototype ([DRV] directive), which cause the prototype to be rendered as normal paragraph text instead of inline code (monospace).
Fix the warning by adding missing closing backticks.
---
This patch is based on next-20220614.
include/linux/tty_ldisc.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/tty_ldisc.h +1 -1
@@ -187,7 +187,7 @@ int ldsem_down_write_nested(struct ld_semaphore *sem, int subclass,* function for automatic flow control. * * @lookahead_buf: [DRV] ``void ()(struct tty_struct *tty, -* const unsigned char *cp, const char *fp, int count) +* const unsigned char *cp, const char *fp, int count)`` * * This function is called by the low-level tty driver for characters * not eaten by ->receive_buf() or ->receive_buf2(). It is useful for
base-commit: 35d872b9ea5b3ad784d7479ea728dcb688df2db7
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Greg Kroah-Hartman
maintainerRe: [PATCH] Documentation: tty: add closing double backticks for lookahead_buf() prototype
Quoted 23 lines · Bagas Sanjaya
After merging tty tree for linux-next testing, Stephen Rothwell reported htmldocs warning:
Documentation/driver-api/tty/tty_ldisc:46:include/linux/tty_ldisc.h:190: WARNING: Inline literal start-string without end-string.Documentation/driver-api/tty/tty_ldisc:46:include/linux/tty_ldisc.h:190: WARNING: Inline emphasis start-string without end-string.Documentation/driver-api/tty/tty_ldisc:46:include/linux/tty_ldisc.h:190: WARNING: Inline emphasis start-string without end-string.Documentation/driver-api/tty/tty_ldisc:46:include/linux/tty_ldisc.h:190: WARNING: Inline emphasis start-string without end-string.The warning is because of missing closing double backticks at
lookahead_buf()function prototype ([DRV] directive), which cause the prototype to be rendered as normal paragraph text instead of inline code (monospace).Fix the warning by adding missing closing backticks.
Fixes 6bb6fa6908ebd3 ("tty: Implement lookahead to process XON/XOFF timely")Reported-by Stephen Rothwell <[email protected]>Cc Greg Kroah-Hartman <[email protected]>Cc Jiri Slaby <[email protected]>Cc "Ilpo Järvinen" <[email protected]>Signed-off-by Bagas Sanjaya <[email protected]>
Quoted 2 lines
---
This patch is based on next-20220614.
Ilpo's patch was sent before yours, so I took theirs, sorry.
greg k-h
Re: [PATCH] Documentation: tty: add closing double backticks for lookahead_buf() prototype
Quoted 2 lines · Greg Kroah-Hartman
Ilpo's patch was sent before yours, so I took theirs, sorry.
Ah! I don't see his patch before submitting mine. Thanks anyway for reminding me.
Signature · 1 line
An old man doll... just what I always wanted! - Clara