soc.lore.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 0/2] turris-omnia-mcu doc fixes
@ 2024-07-30 14:49 Marek Behún
  2024-07-30 14:49 ` [PATCH 1/2] doc: platform: cznic: turris-omnia-mcu: Fix sphinx-build warning Marek Behún
                   ` (2 more replies)
  0 siblings, 3 replies; 4+ messages in thread
From: Marek Behún @ 2024-07-30 14:49 UTC (permalink / raw)
  To: Arnd Bergmann, soc; +Cc: arm, Stephen Rothwell, Marek Behún

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(-)

-- 
2.44.2


^ permalink raw reply	[flat|nested] 4+ messages in thread

* [PATCH 1/2] doc: platform: cznic: turris-omnia-mcu: Fix sphinx-build warning
  2024-07-30 14:49 [PATCH 0/2] turris-omnia-mcu doc fixes Marek Behún
@ 2024-07-30 14:49 ` Marek Behún
  2024-07-30 14:49 ` [PATCH 2/2] doc: platform: cznic: turris-omnia-mcu: Use double backticks for attribute value Marek Behún
  2024-08-06 20:08 ` [PATCH 0/2] turris-omnia-mcu doc fixes patchwork-bot+linux-soc
  2 siblings, 0 replies; 4+ messages in thread
From: Marek Behún @ 2024-07-30 14:49 UTC (permalink / raw)
  To: Arnd Bergmann, soc; +Cc: arm, Stephen Rothwell, Marek Behún

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 <sfr@canb.auug.org.au>
Link: https://lore.kernel.org/all/20240702174938.04c12aab@canb.auug.org.au/
Fixes: dfa556e45ae9 ("platform: cznic: turris-omnia-mcu: Add support for MCU connected GPIOs")
Tested-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Marek Behún <kabel@kernel.org>
---
 .../ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu      | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu b/Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu
index 307a55f599cb..210a39043dc1 100644
--- a/Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu
+++ b/Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu
@@ -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.
 
-- 
2.44.2


^ permalink raw reply related	[flat|nested] 4+ messages in thread

* [PATCH 2/2] doc: platform: cznic: turris-omnia-mcu: Use double backticks for attribute value
  2024-07-30 14:49 [PATCH 0/2] turris-omnia-mcu doc fixes Marek Behún
  2024-07-30 14:49 ` [PATCH 1/2] doc: platform: cznic: turris-omnia-mcu: Fix sphinx-build warning Marek Behún
@ 2024-07-30 14:49 ` Marek Behún
  2024-08-06 20:08 ` [PATCH 0/2] turris-omnia-mcu doc fixes patchwork-bot+linux-soc
  2 siblings, 0 replies; 4+ messages in thread
From: Marek Behún @ 2024-07-30 14:49 UTC (permalink / raw)
  To: Arnd Bergmann, soc; +Cc: arm, Stephen Rothwell, 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 <sfr@canb.auug.org.au>
Signed-off-by: Marek Behún <kabel@kernel.org>
---
 .../ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu        | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu b/Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu
index 210a39043dc1..35a8f6dae5bf 100644
--- a/Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu
+++ b/Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu
@@ -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.
 
-- 
2.44.2


^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: [PATCH 0/2] turris-omnia-mcu doc fixes
  2024-07-30 14:49 [PATCH 0/2] turris-omnia-mcu doc fixes Marek Behún
  2024-07-30 14:49 ` [PATCH 1/2] doc: platform: cznic: turris-omnia-mcu: Fix sphinx-build warning Marek Behún
  2024-07-30 14:49 ` [PATCH 2/2] doc: platform: cznic: turris-omnia-mcu: Use double backticks for attribute value Marek Behún
@ 2024-08-06 20:08 ` patchwork-bot+linux-soc
  2 siblings, 0 replies; 4+ messages in thread
From: patchwork-bot+linux-soc @ 2024-08-06 20:08 UTC (permalink / raw)
  To: =?utf-8?q?Marek_Beh=C3=BAn_=3Ckabel=40kernel=2Eorg=3E?=; +Cc: soc

Hello:

This series was applied to soc/soc.git (arm/fixes)
by Arnd Bergmann <arnd@arndb.de>:

On Tue, 30 Jul 2024 16:49:22 +0200 you wrote:
> 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
> 
> [...]

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!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html



^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2024-08-06 20:08 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-07-30 14:49 [PATCH 0/2] turris-omnia-mcu doc fixes Marek Behún
2024-07-30 14:49 ` [PATCH 1/2] doc: platform: cznic: turris-omnia-mcu: Fix sphinx-build warning Marek Behún
2024-07-30 14:49 ` [PATCH 2/2] doc: platform: cznic: turris-omnia-mcu: Use double backticks for attribute value Marek Behún
2024-08-06 20:08 ` [PATCH 0/2] turris-omnia-mcu doc fixes patchwork-bot+linux-soc

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).