* [PATCH 0/3] Documentation/ABI/testing: Sphinx warning fixes
@ 2022-03-24 16:59 Hans de Goede
2022-03-24 16:59 ` [PATCH 1/3] Documentation/ABI: sysfs-driver-aspeed-uart-routing: Fix sphinx warning Hans de Goede
` (2 more replies)
0 siblings, 3 replies; 6+ messages in thread
From: Hans de Goede @ 2022-03-24 16:59 UTC (permalink / raw)
To: Rafael J . Wysocki, Daniel Lezcano, Zhang Rui, Huang Jianan,
Chia-Wei Wang, Arnd Bergmann
Cc: Hans de Goede, Amit Kucheria, Gao Xiang, Joel Stanley,
Andrew Jeffery, Stephen Rothwell, linux-pm, linux-arm-kernel,
linux-aspeed, linux-kernel
Hi All,
After Stephen reported some Sphinx warnings for the platform-drivers-x86,
I had to first figure out how to reproduce these. It turns out that to
regenerate the htmldocs for Documentation/ABI/testing one has to run:
touch Documentation/admin-guide/abi-testing.rst && make htmldocs
This turned up not only warnings from platform/x86 driver ABI but also
for some others. While at it I've written fixes for those too.
I'm not sure how these should be merged, I guess that the relevant
subsys maintainers will pick these up?
Regards,
Hans
Hans de Goede (3):
Documentation/ABI: sysfs-driver-aspeed-uart-routing: Fix sphinx
warning
Documentation/ABI: sysfs-class-thermal: Fix Sphinx warning
Documentation/ABI: sysfs-fs-erofs: Fix Sphinx errors
Documentation/ABI/testing/sysfs-class-thermal | 2 +-
Documentation/ABI/testing/sysfs-driver-aspeed-uart-routing | 7 ++++---
Documentation/ABI/testing/sysfs-fs-erofs | 5 +++--
3 files changed, 8 insertions(+), 6 deletions(-)
--
2.35.1
^ permalink raw reply [flat|nested] 6+ messages in thread* [PATCH 1/3] Documentation/ABI: sysfs-driver-aspeed-uart-routing: Fix sphinx warning
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
2022-03-25 10:43 ` 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
2 siblings, 1 reply; 6+ messages in thread
From: Hans de Goede @ 2022-03-24 16:59 UTC (permalink / raw)
To: Rafael J . Wysocki, Daniel Lezcano, Zhang Rui, Huang Jianan,
Chia-Wei Wang, Arnd Bergmann
Cc: Hans de Goede, Amit Kucheria, Gao Xiang, Joel Stanley,
Andrew Jeffery, Stephen Rothwell, linux-pm, linux-arm-kernel,
linux-aspeed, linux-kernel
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
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH 1/3] Documentation/ABI: sysfs-driver-aspeed-uart-routing: Fix sphinx warning
2022-03-24 16:59 ` [PATCH 1/3] Documentation/ABI: sysfs-driver-aspeed-uart-routing: Fix sphinx warning Hans de Goede
@ 2022-03-25 10:43 ` Hans de Goede
0 siblings, 0 replies; 6+ messages in thread
From: Hans de Goede @ 2022-03-25 10:43 UTC (permalink / raw)
To: Rafael J . Wysocki, Daniel Lezcano, Zhang Rui, Huang Jianan,
Chia-Wei Wang, Arnd Bergmann
Cc: Amit Kucheria, Gao Xiang, Joel Stanley, Andrew Jeffery,
Stephen Rothwell, linux-pm, linux-arm-kernel, linux-aspeed,
linux-kernel
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).
>
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH 2/3] Documentation/ABI: sysfs-class-thermal: Fix Sphinx warning
2022-03-24 16:59 [PATCH 0/3] Documentation/ABI/testing: Sphinx warning fixes Hans de Goede
2022-03-24 16:59 ` [PATCH 1/3] Documentation/ABI: sysfs-driver-aspeed-uart-routing: Fix sphinx warning Hans de Goede
@ 2022-03-24 16:59 ` Hans de Goede
2022-03-24 16:59 ` [PATCH 3/3] Documentation/ABI: sysfs-fs-erofs: Fix Sphinx errors Hans de Goede
2 siblings, 0 replies; 6+ messages in thread
From: Hans de Goede @ 2022-03-24 16:59 UTC (permalink / raw)
To: Rafael J . Wysocki, Daniel Lezcano, Zhang Rui, Huang Jianan,
Chia-Wei Wang, Arnd Bergmann
Cc: Hans de Goede, Amit Kucheria, Gao Xiang, Joel Stanley,
Andrew Jeffery, Stephen Rothwell, linux-pm, linux-arm-kernel,
linux-aspeed, linux-kernel
Fix the following warning from "make htmldocs":
Documentation/ABI/testing/sysfs-class-thermal:201:
WARNING: Bullet list ends without a blank line; unexpected unindent.
Signed-off-by: Hans de Goede <hdegoede@redhat.com>
---
Documentation/ABI/testing/sysfs-class-thermal | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/ABI/testing/sysfs-class-thermal b/Documentation/ABI/testing/sysfs-class-thermal
index 2c52bb1f864c..8eee37982b2a 100644
--- a/Documentation/ABI/testing/sysfs-class-thermal
+++ b/Documentation/ABI/testing/sysfs-class-thermal
@@ -203,7 +203,7 @@ Description:
- for generic ACPI: should be "Fan", "Processor" or "LCD"
- for memory controller device on intel_menlow platform:
- should be "Memory controller".
+ should be "Memory controller".
RO, Required
--
2.35.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [PATCH 3/3] Documentation/ABI: sysfs-fs-erofs: Fix Sphinx errors
2022-03-24 16:59 [PATCH 0/3] Documentation/ABI/testing: Sphinx warning fixes Hans de Goede
2022-03-24 16:59 ` [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 ` Hans de Goede
2022-03-25 4:33 ` Gao Xiang
2 siblings, 1 reply; 6+ messages in thread
From: Hans de Goede @ 2022-03-24 16:59 UTC (permalink / raw)
To: Rafael J . Wysocki, Daniel Lezcano, Zhang Rui, Huang Jianan,
Chia-Wei Wang, Arnd Bergmann
Cc: Hans de Goede, Amit Kucheria, Gao Xiang, Joel Stanley,
Andrew Jeffery, Stephen Rothwell, linux-pm, linux-arm-kernel,
linux-aspeed, linux-kernel
Fix the following warnings from "make htmldocs":
Documentation/ABI/testing/sysfs-fs-erofs:10:
ERROR: Unexpected indentation.
WARNING: Block quote ends without a blank line; unexpected unindent.
Signed-off-by: Hans de Goede <hdegoede@redhat.com>
---
Documentation/ABI/testing/sysfs-fs-erofs | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/Documentation/ABI/testing/sysfs-fs-erofs b/Documentation/ABI/testing/sysfs-fs-erofs
index 05482374a741..bb4681a01811 100644
--- a/Documentation/ABI/testing/sysfs-fs-erofs
+++ b/Documentation/ABI/testing/sysfs-fs-erofs
@@ -9,8 +9,9 @@ Description: Shows all enabled kernel features.
What: /sys/fs/erofs/<disk>/sync_decompress
Date: November 2021
Contact: "Huang Jianan" <huangjianan@oppo.com>
-Description: Control strategy of sync decompression
+Description: Control strategy of sync decompression:
+
- 0 (default, auto): enable for readpage, and enable for
- readahead on atomic contexts only,
+ readahead on atomic contexts only.
- 1 (force on): enable for readpage and readahead.
- 2 (force off): disable for all situations.
--
2.35.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH 3/3] Documentation/ABI: sysfs-fs-erofs: Fix Sphinx errors
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
0 siblings, 0 replies; 6+ messages in thread
From: Gao Xiang @ 2022-03-25 4:33 UTC (permalink / raw)
To: Hans de Goede
Cc: Rafael J . Wysocki, Daniel Lezcano, Zhang Rui, Huang Jianan,
Chia-Wei Wang, Arnd Bergmann, Amit Kucheria, Joel Stanley,
Andrew Jeffery, Stephen Rothwell, linux-pm, linux-arm-kernel,
linux-aspeed, linux-kernel
On Thu, Mar 24, 2022 at 05:59:18PM +0100, Hans de Goede wrote:
> Fix the following warnings from "make htmldocs":
>
> Documentation/ABI/testing/sysfs-fs-erofs:10:
> ERROR: Unexpected indentation.
> WARNING: Block quote ends without a blank line; unexpected unindent.
>
> Signed-off-by: Hans de Goede <hdegoede@redhat.com>
Thanks!
Acked-by: Gao Xiang <hsiangkao@linux.alibaba.com>
Thanks,
Gao Xiang
> ---
> Documentation/ABI/testing/sysfs-fs-erofs | 5 +++--
> 1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/ABI/testing/sysfs-fs-erofs b/Documentation/ABI/testing/sysfs-fs-erofs
> index 05482374a741..bb4681a01811 100644
> --- a/Documentation/ABI/testing/sysfs-fs-erofs
> +++ b/Documentation/ABI/testing/sysfs-fs-erofs
> @@ -9,8 +9,9 @@ Description: Shows all enabled kernel features.
> What: /sys/fs/erofs/<disk>/sync_decompress
> Date: November 2021
> Contact: "Huang Jianan" <huangjianan@oppo.com>
> -Description: Control strategy of sync decompression
> +Description: Control strategy of sync decompression:
> +
> - 0 (default, auto): enable for readpage, and enable for
> - readahead on atomic contexts only,
> + readahead on atomic contexts only.
> - 1 (force on): enable for readpage and readahead.
> - 2 (force off): disable for all situations.
> --
> 2.35.1
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2022-03-25 10:43 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-03-24 16:59 [PATCH 0/3] Documentation/ABI/testing: Sphinx warning fixes Hans de Goede
2022-03-24 16:59 ` [PATCH 1/3] Documentation/ABI: sysfs-driver-aspeed-uart-routing: Fix sphinx warning Hans de Goede
2022-03-25 10:43 ` 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
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).