* [PATCH 1/7] Documentation: OKUD Max9331: fix sphinx warning
2022-09-12 8:44 [PATCH 0/7] Documentation misc fixes Antony Pavlov
@ 2022-09-12 8:44 ` Antony Pavlov
2022-09-12 8:44 ` [PATCH 2/7] Documentation: Altera SOCFPGA FPGA Manager: fix sphinx error Antony Pavlov
` (6 subsequent siblings)
7 siblings, 0 replies; 9+ messages in thread
From: Antony Pavlov @ 2022-09-12 8:44 UTC (permalink / raw)
To: barebox; +Cc: Ahmad Fatoum
sphinx warning:
Documentation/boards/mips/max9331.rst:129: WARNING:
Pygments lexer name 'assembly' is not known
Use pygments lexer for Gas (AT&T) assembly code, see
https://pygments.org/docs/lexers/#lexers-for-assembly-languages
for details.
Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com>
---
Documentation/boards/mips/max9331.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/boards/mips/max9331.rst b/Documentation/boards/mips/max9331.rst
index f09dabc2da1..f7529f9874d 100644
--- a/Documentation/boards/mips/max9331.rst
+++ b/Documentation/boards/mips/max9331.rst
@@ -126,7 +126,7 @@ it jump to 0x9f020000 where the first instruction of barebox.
This is usefull when debug with jtag or choosing different bootloaders.
or even boot kernel without bootloader.
-.. code-block:: assembly
+.. code-block:: asm
lui ra, 0x9f02
jr ra
--
2.37.2
^ permalink raw reply [flat|nested] 9+ messages in thread* [PATCH 2/7] Documentation: Altera SOCFPGA FPGA Manager: fix sphinx error
2022-09-12 8:44 [PATCH 0/7] Documentation misc fixes Antony Pavlov
2022-09-12 8:44 ` [PATCH 1/7] Documentation: OKUD Max9331: fix sphinx warning Antony Pavlov
@ 2022-09-12 8:44 ` Antony Pavlov
2022-09-12 8:44 ` [PATCH 3/7] Documentation: Altera FPGAs in passive-serial mode: fix sphinx issues Antony Pavlov
` (5 subsequent siblings)
7 siblings, 0 replies; 9+ messages in thread
From: Antony Pavlov @ 2022-09-12 8:44 UTC (permalink / raw)
To: barebox; +Cc: Ahmad Fatoum
sphinx error:
Documentation/devicetree/bindings/firmware/altr,socfpga-fpga-mgr.rst:10:
ERROR: Unexpected indentation.
Insert necessary whitespaces and empty lines to form correct
nested lists structure.
Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com>
---
.../devicetree/bindings/firmware/altr,socfpga-fpga-mgr.rst | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/Documentation/devicetree/bindings/firmware/altr,socfpga-fpga-mgr.rst b/Documentation/devicetree/bindings/firmware/altr,socfpga-fpga-mgr.rst
index 9f7de6b9858..478e8e6fc44 100644
--- a/Documentation/devicetree/bindings/firmware/altr,socfpga-fpga-mgr.rst
+++ b/Documentation/devicetree/bindings/firmware/altr,socfpga-fpga-mgr.rst
@@ -5,10 +5,12 @@ This binding defines the FPGA Manager on Altera SOCFPGAs. This is used to upload
the firmware to the FPGA part of the SoC.
Required properties:
+
- ``compatible``: shall be ``"altr,socfpga-fpga-mgr"``
- ``reg``: Must contain 2 register ranges:
- 1. The control address space of the FPGA manager.
- 2. The configuration data address space where the firmware data is written to.
+
+ 1. The control address space of the FPGA manager.
+ 2. The configuration data address space where the firmware data is written to.
Example:
--
2.37.2
^ permalink raw reply [flat|nested] 9+ messages in thread* [PATCH 3/7] Documentation: Altera FPGAs in passive-serial mode: fix sphinx issues
2022-09-12 8:44 [PATCH 0/7] Documentation misc fixes Antony Pavlov
2022-09-12 8:44 ` [PATCH 1/7] Documentation: OKUD Max9331: fix sphinx warning Antony Pavlov
2022-09-12 8:44 ` [PATCH 2/7] Documentation: Altera SOCFPGA FPGA Manager: fix sphinx error Antony Pavlov
@ 2022-09-12 8:44 ` Antony Pavlov
2022-09-12 8:44 ` [PATCH 4/7] Documentation: barebox DT aliases: " Antony Pavlov
` (4 subsequent siblings)
7 siblings, 0 replies; 9+ messages in thread
From: Antony Pavlov @ 2022-09-12 8:44 UTC (permalink / raw)
To: barebox; +Cc: Ahmad Fatoum
sphinx issues:
Documentation/devicetree/bindings/firmware/altr,passive-serial.rst:10:
ERROR: Unexpected indentation.
Documentation/devicetree/bindings/firmware/altr,passive-serial.rst:11:
WARNING: Block quote ends without a blank line; unexpected unindent.
Insert necessary empty line to fix the problem.
Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com>
---
.../devicetree/bindings/firmware/altr,passive-serial.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/Documentation/devicetree/bindings/firmware/altr,passive-serial.rst b/Documentation/devicetree/bindings/firmware/altr,passive-serial.rst
index 1012137bc93..cbddd700ce9 100644
--- a/Documentation/devicetree/bindings/firmware/altr,passive-serial.rst
+++ b/Documentation/devicetree/bindings/firmware/altr,passive-serial.rst
@@ -6,6 +6,7 @@ passive serial mode. This is used to upload the firmware and
to start the FPGA.
Required properties:
+
- ``compatible``: shall be ``"altr,fpga-passive-serial"`` or
``"altr,fpga-arria10-passive-serial"`` for Arria 10
- ``reg``: SPI chip select
--
2.37.2
^ permalink raw reply [flat|nested] 9+ messages in thread* [PATCH 4/7] Documentation: barebox DT aliases: fix sphinx issues
2022-09-12 8:44 [PATCH 0/7] Documentation misc fixes Antony Pavlov
` (2 preceding siblings ...)
2022-09-12 8:44 ` [PATCH 3/7] Documentation: Altera FPGAs in passive-serial mode: fix sphinx issues Antony Pavlov
@ 2022-09-12 8:44 ` Antony Pavlov
2022-09-12 8:44 ` [PATCH 5/7] Documentation: barebox environment: fix list rendering Antony Pavlov
` (3 subsequent siblings)
7 siblings, 0 replies; 9+ messages in thread
From: Antony Pavlov @ 2022-09-12 8:44 UTC (permalink / raw)
To: barebox; +Cc: Ahmad Fatoum
sphinx issues:
Documentation/devicetree/bindings/barebox/aliases.rst:8:
ERROR: Unexpected indentation.
Documentation/devicetree/bindings/barebox/aliases.rst:12:
WARNING: Definition list ends without a blank line; unexpected unindent.
Documentation/devicetree/bindings/barebox/aliases.rst:13:
WARNING: Definition list ends without a blank line; unexpected unindent.
Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com>
---
Documentation/devicetree/bindings/barebox/aliases.rst | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/Documentation/devicetree/bindings/barebox/aliases.rst b/Documentation/devicetree/bindings/barebox/aliases.rst
index 527cc85ef69..e6face2c331 100644
--- a/Documentation/devicetree/bindings/barebox/aliases.rst
+++ b/Documentation/devicetree/bindings/barebox/aliases.rst
@@ -2,9 +2,10 @@ barebox DT aliases
==================
barebox can use the properties in the ``/aliases`` node to arrive
-at deterministic names for devices, e.g.::
+at deterministic names for devices, e.g.:
.. code-block:: none
+
/ {
aliases {
mmc0 = &sdhci;
--
2.37.2
^ permalink raw reply [flat|nested] 9+ messages in thread* [PATCH 5/7] Documentation: barebox environment: fix list rendering
2022-09-12 8:44 [PATCH 0/7] Documentation misc fixes Antony Pavlov
` (3 preceding siblings ...)
2022-09-12 8:44 ` [PATCH 4/7] Documentation: barebox DT aliases: " Antony Pavlov
@ 2022-09-12 8:44 ` Antony Pavlov
2022-09-12 8:44 ` [PATCH 6/7] Documentation: Common leds properties: fix 'panic-indicator' list entry rendering Antony Pavlov
` (2 subsequent siblings)
7 siblings, 0 replies; 9+ messages in thread
From: Antony Pavlov @ 2022-09-12 8:44 UTC (permalink / raw)
To: barebox; +Cc: Ahmad Fatoum
Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com>
---
.../devicetree/bindings/barebox/barebox,environment.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/Documentation/devicetree/bindings/barebox/barebox,environment.rst b/Documentation/devicetree/bindings/barebox/barebox,environment.rst
index 918efd15f55..8a57bf1add8 100644
--- a/Documentation/devicetree/bindings/barebox/barebox,environment.rst
+++ b/Documentation/devicetree/bindings/barebox/barebox,environment.rst
@@ -9,6 +9,7 @@ Required properties:
* ``device-path``: path to the device environment is on
Optional properties:
+
* ``file-path``: path to a file in the device named by device-path
The device-path is a multistring property. The first string should contain
--
2.37.2
^ permalink raw reply [flat|nested] 9+ messages in thread* [PATCH 6/7] Documentation: Common leds properties: fix 'panic-indicator' list entry rendering
2022-09-12 8:44 [PATCH 0/7] Documentation misc fixes Antony Pavlov
` (4 preceding siblings ...)
2022-09-12 8:44 ` [PATCH 5/7] Documentation: barebox environment: fix list rendering Antony Pavlov
@ 2022-09-12 8:44 ` Antony Pavlov
2022-09-12 8:44 ` [PATCH 7/7] Documentation: Voltage/Current Regulators: fix sphinx error Antony Pavlov
2022-09-13 8:10 ` [PATCH 0/7] Documentation misc fixes Sascha Hauer
7 siblings, 0 replies; 9+ messages in thread
From: Antony Pavlov @ 2022-09-12 8:44 UTC (permalink / raw)
To: barebox; +Cc: Ahmad Fatoum
Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com>
---
Documentation/devicetree/bindings/leds/common.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/devicetree/bindings/leds/common.rst b/Documentation/devicetree/bindings/leds/common.rst
index 911a55f4f66..09b4e401bc2 100644
--- a/Documentation/devicetree/bindings/leds/common.rst
+++ b/Documentation/devicetree/bindings/leds/common.rst
@@ -14,4 +14,4 @@ Common leds properties
from the node name (excluding the unit address).
* ``panic-indicator`` - This property specifies that the LED should be used as a
- panic indicator.
+ panic indicator.
--
2.37.2
^ permalink raw reply [flat|nested] 9+ messages in thread* [PATCH 7/7] Documentation: Voltage/Current Regulators: fix sphinx error
2022-09-12 8:44 [PATCH 0/7] Documentation misc fixes Antony Pavlov
` (5 preceding siblings ...)
2022-09-12 8:44 ` [PATCH 6/7] Documentation: Common leds properties: fix 'panic-indicator' list entry rendering Antony Pavlov
@ 2022-09-12 8:44 ` Antony Pavlov
2022-09-13 8:10 ` [PATCH 0/7] Documentation misc fixes Sascha Hauer
7 siblings, 0 replies; 9+ messages in thread
From: Antony Pavlov @ 2022-09-12 8:44 UTC (permalink / raw)
To: barebox; +Cc: Ahmad Fatoum
sphinx error:
Documentation/devicetree/bindings/regulator/regulator.rst:8:
ERROR: Unexpected indentation.
Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com>
---
Documentation/devicetree/bindings/regulator/regulator.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/Documentation/devicetree/bindings/regulator/regulator.rst b/Documentation/devicetree/bindings/regulator/regulator.rst
index 9afc020acd3..754c4743286 100644
--- a/Documentation/devicetree/bindings/regulator/regulator.rst
+++ b/Documentation/devicetree/bindings/regulator/regulator.rst
@@ -4,6 +4,7 @@ Voltage/Current Regulators
In addition to the upstream bindings, another property is added:
Optional properties:
+
- ``barebox,allow-dummy-supply`` : A property to allow usage of dummy power
regulator. This can be added to regulator nodes, whose drivers are not yet
supported. It will rely on regulator reset defaults and use of dummy regulator
--
2.37.2
^ permalink raw reply [flat|nested] 9+ messages in thread* Re: [PATCH 0/7] Documentation misc fixes
2022-09-12 8:44 [PATCH 0/7] Documentation misc fixes Antony Pavlov
` (6 preceding siblings ...)
2022-09-12 8:44 ` [PATCH 7/7] Documentation: Voltage/Current Regulators: fix sphinx error Antony Pavlov
@ 2022-09-13 8:10 ` Sascha Hauer
7 siblings, 0 replies; 9+ messages in thread
From: Sascha Hauer @ 2022-09-13 8:10 UTC (permalink / raw)
To: Antony Pavlov; +Cc: barebox, Ahmad Fatoum
On Mon, Sep 12, 2022 at 11:44:23AM +0300, Antony Pavlov wrote:
> Antony Pavlov (7):
> Documentation: OKUD Max9331: fix sphinx warning
> Documentation: Altera SOCFPGA FPGA Manager: fix sphinx error
> Documentation: Altera FPGAs in passive-serial mode: fix sphinx issues
> Documentation: barebox DT aliases: fix sphinx issues
> Documentation: barebox environment: fix list rendering
> Documentation: Common leds properties: fix 'panic-indicator' list
> entry rendering
> Documentation: Voltage/Current Regulators: fix sphinx error
>
> Documentation/boards/mips/max9331.rst | 2 +-
> Documentation/devicetree/bindings/barebox/aliases.rst | 3 ++-
> .../devicetree/bindings/barebox/barebox,environment.rst | 1 +
> .../devicetree/bindings/firmware/altr,passive-serial.rst | 1 +
> .../devicetree/bindings/firmware/altr,socfpga-fpga-mgr.rst | 6 ++++--
> Documentation/devicetree/bindings/leds/common.rst | 2 +-
> Documentation/devicetree/bindings/regulator/regulator.rst | 1 +
> 7 files changed, 11 insertions(+), 5 deletions(-)
Applied, thanks
Sascha
--
Pengutronix e.K. | |
Steuerwalder Str. 21 | http://www.pengutronix.de/ |
31137 Hildesheim, Germany | Phone: +49-5121-206917-0 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |
^ permalink raw reply [flat|nested] 9+ messages in thread