2022-01-24 15:05:05

by ChiaWei Wang

Subject: [PATCH next] docs/ABI: testing: aspeed-uart-routing: Escape asterisk

Escape asterisk symbols to fix the following warning:

"WARNING: Inline emphasis start-string without end-string"

Fixes: c6807970c3bc ("soc: aspeed: Add UART routing support")
Signed-off-by: Chia-Wei Wang <[email protected]>
---
Documentation/ABI/testing/sysfs-driver-aspeed-uart-routing | 6 +++---
1 file changed, 3 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..910df0e5815a 100644
--- a/Documentation/ABI/testing/sysfs-driver-aspeed-uart-routing
+++ b/Documentation/ABI/testing/sysfs-driver-aspeed-uart-routing
@@ -1,4 +1,4 @@
-What: /sys/bus/platform/drivers/aspeed-uart-routing/*/uart*
+What: /sys/bus/platform/drivers/aspeed-uart-routing/\*/uart\*
Date: September 2021
Contact: Oskar Senft <[email protected]>
Chia-Wei Wang <[email protected]>
@@ -9,7 +9,7 @@ Description: Selects the RX source of the UARTx device.
depends on the selected file.

e.g.
- cat /sys/bus/platform/drivers/aspeed-uart-routing/*.uart_routing/uart1
+ 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).
@@ -17,7 +17,7 @@ Description: Selects the RX source of the UARTx device.
Users: OpenBMC. Proposed changes should be mailed to
[email protected]

-What: /sys/bus/platform/drivers/aspeed-uart-routing/*/io*
+What: /sys/bus/platform/drivers/aspeed-uart-routing/\*/io\*
Date: September 2021
Contact: Oskar Senft <[email protected]>
Chia-Wei Wang <[email protected]>
--
2.25.1

2022-02-02 08:41:28

by Joel Stanley

Subject: Re: [PATCH next] docs/ABI: testing: aspeed-uart-routing: Escape asterisk

On Mon, 24 Jan 2022 at 01:44, Chia-Wei Wang <[email protected]> wrote:
>
> Escape asterisk symbols to fix the following warning:
>
> "WARNING: Inline emphasis start-string without end-string"
>
> Fixes: c6807970c3bc ("soc: aspeed: Add UART routing support")
> Signed-off-by: Chia-Wei Wang <[email protected]>

Thanks Chai-Wei, I've sent this to the soc maintainers to apply as a fix.

> ---
> Documentation/ABI/testing/sysfs-driver-aspeed-uart-routing | 6 +++---
> 1 file changed, 3 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..910df0e5815a 100644
> --- a/Documentation/ABI/testing/sysfs-driver-aspeed-uart-routing
> +++ b/Documentation/ABI/testing/sysfs-driver-aspeed-uart-routing
> @@ -1,4 +1,4 @@
> -What: /sys/bus/platform/drivers/aspeed-uart-routing/*/uart*
> +What: /sys/bus/platform/drivers/aspeed-uart-routing/\*/uart\*
> Date: September 2021
> Contact: Oskar Senft <[email protected]>
> Chia-Wei Wang <[email protected]>
> @@ -9,7 +9,7 @@ Description: Selects the RX source of the UARTx device.
> depends on the selected file.
>
> e.g.
> - cat /sys/bus/platform/drivers/aspeed-uart-routing/*.uart_routing/uart1
> + 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).
> @@ -17,7 +17,7 @@ Description: Selects the RX source of the UARTx device.
> Users: OpenBMC. Proposed changes should be mailed to
> [email protected]
>
> -What: /sys/bus/platform/drivers/aspeed-uart-routing/*/io*
> +What: /sys/bus/platform/drivers/aspeed-uart-routing/\*/io\*
> Date: September 2021
> Contact: Oskar Senft <[email protected]>
> Chia-Wei Wang <[email protected]>
> --
> 2.25.1
>

2022-02-07 19:22:03

by ChiaWei Wang

Subject: RE: [PATCH next] docs/ABI: testing: aspeed-uart-routing: Escape asterisk

> From: Joel Stanley <[email protected]>
> Sent: Tuesday, February 1, 2022 3:02 PM
>
> On Mon, 24 Jan 2022 at 01:44, Chia-Wei Wang
> <[email protected]> wrote:
> >
> > Escape asterisk symbols to fix the following warning:
> >
> > "WARNING: Inline emphasis start-string without end-string"
> >
> > Fixes: c6807970c3bc ("soc: aspeed: Add UART routing support")
> > Signed-off-by: Chia-Wei Wang <[email protected]>
>
> Thanks Chai-Wei, I've sent this to the soc maintainers to apply as a fix.

Thanks for helping on this!

Regards,
Chiawei