Re: [PATCH] Documentation: tty: add closing double backticks for lookahead_buf() prototype

From: Greg Kroah-Hartman
Date: Mon Jun 27 2022 - 08:34:42 EST


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@xxxxxxxxxxxxxxxx/
> Fixes: 6bb6fa6908ebd3 ("tty: Implement lookahead to process XON/XOFF timely")
> Reported-by: Stephen Rothwell <sfr@xxxxxxxxxxxxxxxx>
> Cc: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>
> Cc: Jiri Slaby <jirislaby@xxxxxxxxxx>
> Cc: "Ilpo Järvinen" <ilpo.jarvinen@xxxxxxxxxxxxxxx>
> Cc: linux-kernel@xxxxxxxxxxxxxxx
> Signed-off-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx>
> ---
> This patch is based on next-20220614.

Ilpo's patch was sent before yours, so I took theirs, sorry.

greg k-h