Skip to contentSkip to conversation

turris-omnia-mcu doc fixes

PATCH Applied Marek Behún 2 participants 4 messages Jul 30, 2024 – Aug 6, 2024 Arm/cz.nic turris support

lore
Share & tools
lore

Marek Behún

author maintainer
#0 lore raw

cover turris-omnia-mcu doc fixes

Hello Arnd,

here come two fixes for turris-omnia-mcu driver documentation.

Marek

Marek Behún (2):
doc: platform: cznic: turris-omnia-mcu: Fix sphinx-build warning
doc: platform: cznic: turris-omnia-mcu: Use double backticks for
attribute value

 .../ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu      | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
Signature · 1 line
2.44.2
author maintainer
#1 lore raw

PATCH 1/2 doc: platform: cznic: turris-omnia-mcu: Fix sphinx-build warning

Fix sphinx-build warnings
ERROR: Unexpected indentation.
WARNING: Block quote ends without a blank line; unexpected unindent
in Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu.

Reported-by Stephen Rothwell <[email protected]>
Link https://lore.kernel.org/all/[email protected]/ open here
Fixes dfa556e45ae9 ("platform: cznic: turris-omnia-mcu: Add support for MCU connected GPIOs")
Tested-by Stephen Rothwell <[email protected]>
Signed-off-by Marek Behún <[email protected]>
---
 .../ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu      | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu +3 -3
index 307a55f599cb..210a39043dc1 100644
@@ -32,9 +32,9 @@ Description:	(RW) The front button on the Turris Omnia router can be
 		interrupt.
 
 		This file switches between these two modes:
-		- "mcu" makes the button press event be handled by the MCU to
-		  change the LEDs panel intensity.
-		- "cpu" makes the button press event be handled by the CPU.
+		 - "mcu" makes the button press event be handled by the MCU to
+		   change the LEDs panel intensity.
+		 - "cpu" makes the button press event be handled by the CPU.
 
 		Format: %s.
Signature · 1 line
2.44.2
author maintainer
#2 lore raw

PATCH 2/2 doc: platform: cznic: turris-omnia-mcu: Use double backticks for attribute value

In reply to Marek Behún

Use double backticks instead of quotes for sysfs attribute value. This makes sphinx generate the "mcu" and "cpu" values in monospace when rendering to HTML.

Fixes dfa556e45ae9 ("platform: cznic: turris-omnia-mcu: Add support for MCU connected GPIOs")
Tested-by Stephen Rothwell <[email protected]>
Signed-off-by Marek Behún <[email protected]>
---
 .../ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu        | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu +2 -2
index 210a39043dc1..35a8f6dae5bf 100644
@@ -32,9 +32,9 @@ Description:	(RW) The front button on the Turris Omnia router can be
 		interrupt.
 
 		This file switches between these two modes:
-		 - "mcu" makes the button press event be handled by the MCU to
+		 - ``mcu`` makes the button press event be handled by the MCU to
 		   change the LEDs panel intensity.
-		 - "cpu" makes the button press event be handled by the CPU.
+		 - ``cpu`` makes the button press event be handled by the CPU.
 
 		Format: %s.
Signature · 1 line
2.44.2
CI Applied
#3 lore raw
In reply to Marek Behún
This series was applied to soc/soc.git (arm/fixes) by Arnd Bergmann <[email protected]>:

Hello:

This series was applied to soc/soc.git (arm/fixes) by Arnd Bergmann <[email protected]>:

Quoted 4 lines · On Tue, 30 Jul 2024 16:49:22 +0200 you wrote:

Hello Arnd,

here come two fixes for turris-omnia-mcu driver documentation.

Quoted 8 lines

Marek

Marek Behún (2):
doc: platform: cznic: turris-omnia-mcu: Fix sphinx-build warning
doc: platform: cznic: turris-omnia-mcu: Use double backticks for
attribute value

[...]

Here is the summary with links:
- [1/2] doc: platform: cznic: turris-omnia-mcu: Fix sphinx-build warning

    https://git.kernel.org/soc/soc/c/d76fd4a9bc03
  - [2/2] doc: platform: cznic: turris-omnia-mcu: Use double backticks for attribute value
    https://git.kernel.org/soc/soc/c/888c67765db6

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html