From: Bagas Sanjaya <bagasdotme@gmail.com>
To: linux-doc@vger.kernel.org
Cc: "Bagas Sanjaya" <bagasdotme@gmail.com>,
"Stephen Rothwell" <sfr@canb.auug.org.au>,
"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
"Jiri Slaby" <jirislaby@kernel.org>,
"Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com>,
linux-kernel@vger.kernel.org
Subject: [PATCH] Documentation: tty: add closing double backticks for lookahead_buf() prototype
Date: Tue, 14 Jun 2022 16:12:15 +0700 [thread overview]
Message-ID: <20220614091214.511791-1-bagasdotme@gmail.com> (raw)
In-Reply-To: <20220614164745.7b746354@canb.auug.org.au>
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
next parent reply other threads:[~2022-06-14 9:12 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 ` Bagas Sanjaya [this message]
2022-06-27 12:34 ` [PATCH] Documentation: tty: add closing double backticks for lookahead_buf() prototype Greg Kroah-Hartman
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=20220614091214.511791-1-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=gregkh@linuxfoundation.org \
--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).