linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
To: Bagas Sanjaya <bagasdotme@gmail.com>
Cc: linux-doc@vger.kernel.org,
	"Stephen Rothwell" <sfr@canb.auug.org.au>,
	"Jiri Slaby" <jirislaby@kernel.org>,
	"Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com>,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH] Documentation: tty: add closing double backticks for lookahead_buf() prototype
Date: Mon, 27 Jun 2022 14:34:31 +0200	[thread overview]
Message-ID: <Yrmj14W7eOyuTS94@kroah.com> (raw)
In-Reply-To: <20220614091214.511791-1-bagasdotme@gmail.com>

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

  reply	other threads:[~2022-06-27 12:34 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [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 [this message]
2022-06-28  0:41     ` Bagas Sanjaya

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=Yrmj14W7eOyuTS94@kroah.com \
    --to=gregkh@linuxfoundation.org \
    --cc=bagasdotme@gmail.com \
    --cc=ilpo.jarvinen@linux.intel.com \
    --cc=jirislaby@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=sfr@canb.auug.org.au \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).