* [PATCH] Documentation: tty: add closing double backticks for lookahead_buf() prototype [not found] <20220614164745.7b746354@canb.auug.org.au> @ 2022-06-14 9:12 ` Bagas Sanjaya 2022-06-27 12:34 ` Greg Kroah-Hartman 0 siblings, 1 reply; 3+ messages in thread From: Bagas Sanjaya @ 2022-06-14 9:12 UTC (permalink / raw) To: linux-doc Cc: Bagas Sanjaya, Stephen Rothwell, Greg Kroah-Hartman, Jiri Slaby, Ilpo Järvinen, linux-kernel 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. Link: https://lore.kernel.org/linux-next/20220614164745.7b746354@canb.auug.org.au/ Fixes: 6bb6fa6908ebd3 ("tty: Implement lookahead to process XON/XOFF timely") Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: Jiri Slaby <jirislaby@kernel.org> Cc: "Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com> Cc: linux-kernel@vger.kernel.org Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> --- This patch is based on next-20220614. include/linux/tty_ldisc.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/linux/tty_ldisc.h b/include/linux/tty_ldisc.h index 33678e1936f6a6..ede6f2157f329f 100644 --- a/include/linux/tty_ldisc.h +++ b/include/linux/tty_ldisc.h @@ -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 -- An old man doll... just what I always wanted! - Clara ^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] Documentation: tty: add closing double backticks for lookahead_buf() prototype 2022-06-14 9:12 ` [PATCH] Documentation: tty: add closing double backticks for lookahead_buf() prototype Bagas Sanjaya @ 2022-06-27 12:34 ` Greg Kroah-Hartman 2022-06-28 0:41 ` Bagas Sanjaya 0 siblings, 1 reply; 3+ messages in thread From: Greg Kroah-Hartman @ 2022-06-27 12:34 UTC (permalink / raw) To: Bagas Sanjaya Cc: linux-doc, Stephen Rothwell, Jiri Slaby, Ilpo Järvinen, linux-kernel On Tue, Jun 14, 2022 at 04:12:15PM +0700, Bagas Sanjaya wrote: > 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. > > Link: https://lore.kernel.org/linux-next/20220614164745.7b746354@canb.auug.org.au/ > Fixes: 6bb6fa6908ebd3 ("tty: Implement lookahead to process XON/XOFF timely") > Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> > Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> > Cc: Jiri Slaby <jirislaby@kernel.org> > Cc: "Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com> > Cc: linux-kernel@vger.kernel.org > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> > --- > This patch is based on next-20220614. Ilpo's patch was sent before yours, so I took theirs, sorry. greg k-h ^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] Documentation: tty: add closing double backticks for lookahead_buf() prototype 2022-06-27 12:34 ` Greg Kroah-Hartman @ 2022-06-28 0:41 ` Bagas Sanjaya 0 siblings, 0 replies; 3+ messages in thread From: Bagas Sanjaya @ 2022-06-28 0:41 UTC (permalink / raw) To: Greg Kroah-Hartman Cc: linux-doc, Stephen Rothwell, Jiri Slaby, Ilpo Järvinen, linux-kernel On 6/27/22 19:34, Greg Kroah-Hartman wrote: > 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. -- An old man doll... just what I always wanted! - Clara ^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2022-06-28 0:41 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
[not found] <20220614164745.7b746354@canb.auug.org.au>
2022-06-14 9:12 ` [PATCH] Documentation: tty: add closing double backticks for lookahead_buf() prototype Bagas Sanjaya
2022-06-27 12:34 ` Greg Kroah-Hartman
2022-06-28 0:41 ` Bagas Sanjaya
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).