From: Hans de Goede <hdegoede@redhat.com>
To: "Rafael J . Wysocki" <rafael@kernel.org>,
Daniel Lezcano <daniel.lezcano@linaro.org>,
Zhang Rui <rui.zhang@intel.com>,
Huang Jianan <huangjianan@oppo.com>,
Chia-Wei Wang <chiawei_wang@aspeedtech.com>,
Arnd Bergmann <arnd@arndb.de>
Cc: Hans de Goede <hdegoede@redhat.com>,
Amit Kucheria <amitk@kernel.org>,
Gao Xiang <hsiangkao@linux.alibaba.com>,
Joel Stanley <joel@jms.id.au>, Andrew Jeffery <andrew@aj.id.au>,
Stephen Rothwell <sfr@canb.auug.org.au>,
linux-pm@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
linux-aspeed@lists.ozlabs.org, linux-kernel@vger.kernel.org
Subject: [PATCH 1/3] Documentation/ABI: sysfs-driver-aspeed-uart-routing: Fix sphinx warning
Date: Thu, 24 Mar 2022 17:59:16 +0100 [thread overview]
Message-ID: <20220324165918.22005-2-hdegoede@redhat.com> (raw)
In-Reply-To: <20220324165918.22005-1-hdegoede@redhat.com>
Fix the following warning from "make htmldocs":
Documentation/ABI/testing/sysfs-driver-aspeed-uart-routing:2:
WARNING: Inline emphasis start-string without end-string.
This is caused by the used of '*' in the example cat command,
mark the command as code to fix this.
Signed-off-by: Hans de Goede <hdegoede@redhat.com>
---
Documentation/ABI/testing/sysfs-driver-aspeed-uart-routing | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/Documentation/ABI/testing/sysfs-driver-aspeed-uart-routing b/Documentation/ABI/testing/sysfs-driver-aspeed-uart-routing
index b363827da437..1e25cd2cacc1 100644
--- a/Documentation/ABI/testing/sysfs-driver-aspeed-uart-routing
+++ b/Documentation/ABI/testing/sysfs-driver-aspeed-uart-routing
@@ -8,9 +8,10 @@ Description: Selects the RX source of the UARTx device.
selected option marked by brackets "[]". The list of available options
depends on the selected file.
- e.g.
- cat /sys/bus/platform/drivers/aspeed-uart-routing/*.uart_routing/uart1
- [io1] io2 io3 io4 uart2 uart3 uart4 io6
+ e.g.::
+
+ # cat /sys/bus/platform/drivers/aspeed-uart-routing/*.uart_routing/uart1
+ [io1] io2 io3 io4 uart2 uart3 uart4 io6
In this case, UART1 gets its input from IO1 (physical serial port 1).
--
2.35.1
next prev parent reply other threads:[~2022-03-24 16:59 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-24 16:59 [PATCH 0/3] Documentation/ABI/testing: Sphinx warning fixes Hans de Goede
2022-03-24 16:59 ` Hans de Goede [this message]
2022-03-25 10:43 ` [PATCH 1/3] Documentation/ABI: sysfs-driver-aspeed-uart-routing: Fix sphinx warning Hans de Goede
2022-03-24 16:59 ` [PATCH 2/3] Documentation/ABI: sysfs-class-thermal: Fix Sphinx warning Hans de Goede
2022-03-24 16:59 ` [PATCH 3/3] Documentation/ABI: sysfs-fs-erofs: Fix Sphinx errors Hans de Goede
2022-03-25 4:33 ` Gao Xiang
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=20220324165918.22005-2-hdegoede@redhat.com \
--to=hdegoede@redhat.com \
--cc=amitk@kernel.org \
--cc=andrew@aj.id.au \
--cc=arnd@arndb.de \
--cc=chiawei_wang@aspeedtech.com \
--cc=daniel.lezcano@linaro.org \
--cc=hsiangkao@linux.alibaba.com \
--cc=huangjianan@oppo.com \
--cc=joel@jms.id.au \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-aspeed@lists.ozlabs.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=rafael@kernel.org \
--cc=rui.zhang@intel.com \
--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).