| Message ID | 20220324165918.22005-2-hdegoede@redhat.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Documentation/ABI/testing: Sphinx warning fixes | expand |
Hi, On 3/24/22 17:59, Hans de Goede wrote: > 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> I see that this was already fixed by escaping the '*' with a '\', apologies. So this patch can be ignored / dropped. Regards, Hans > --- > 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). >
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).
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(-)