[PATCH 1/4] Documentation: migration-guides: don't warn about migration-master

[PATCH 1/4] Documentation: migration-guides: don't warn about migration-master

[Ahmad Fatoum]

This file holds pending migration notes and is unreferenced, so mark it
orphan to suppress the warning.

Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
 Documentation/migration-guides/migration-master.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/migration-guides/migration-master.rst b/Documentation/migration-guides/migration-master.rst
index bb9a24bc06ab..ffbb36a0d4b7 100644
--- a/Documentation/migration-guides/migration-master.rst
+++ b/Documentation/migration-guides/migration-master.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 <config.h> removal for PowerPC
 ------------------------------
 
-- 
2.47.3

[PATCH 2/4] Documentation: factor out build rules into stand-alone Makefile

[Ahmad Fatoum]

To make it easier to invoke from CI, let's add a dedicated Documentation
Makefile.

Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
 Documentation/Makefile | 35 +++++++++++++++++++++++++++++++++++
 Makefile               | 20 +++++++++++---------
 2 files changed, 46 insertions(+), 9 deletions(-)
 create mode 100644 Documentation/Makefile

diff --git a/Documentation/Makefile b/Documentation/Makefile
new file mode 100644
index 000000000000..825cd3ba0e7f
--- /dev/null
+++ b/Documentation/Makefile
@@ -0,0 +1,35 @@
+# SPDX-License-Identifier: GPL-2.0
+#
+# Makefile for Sphinx documentation
+# This was not generated by sphinx-quickstart, but nonetheless copies some
+# of its variable name conventions for easier integration with existing tooling
+
+SPHINXBUILD   = sphinx-build
+SPHINXOPTS    =
+
+# Internal variables.
+ALLSPHINXOPTS   =  $(SPHINXOPTS)
+
+srctree ?= $(realpath $(dir $(lastword $(MAKEFILE_LIST)))/..)
+objtree ?= $(srctree)
+
+docs: htmldocs FORCE
+
+htmldocs: FORCE
+	@mkdir -p $(srctree)/Documentation/commands
+	@$(srctree)/Documentation/gen_commands.py $(srctree) $(srctree)/Documentation/commands
+	@$(SPHINXBUILD) -b html -d $(objtree)/doctrees $(srctree)/Documentation \
+		$(objtree)/Documentation/html $(ALLSPHINXOPTS)
+
+dochelp: FORCE
+	@echo  ' barebox internal documentation from ReST:'
+	@echo  '  htmldocs        - HTML'
+	@echo  '  docs            - alias for htmldocs'
+	@echo
+	@echo  '  Default location for the generated documents is Documentation/html'
+
+
+PHONY += FORCE
+FORCE:
+
+.PHONY: $(PHONY)
diff --git a/Makefile b/Makefile
index b138ae674878..22e306e69d9e 100644
--- a/Makefile
+++ b/Makefile
@@ -1491,6 +1491,8 @@ endif
 	@echo  '  tags/TAGS	  - Generate tags file for editors'
 	@echo  '  cscope	  - Generate cscope index'
 	@echo  '                    (default: $(INSTALL_HDR_PATH))'
+	@echo  'Documentation targets:'
+	@$(MAKE) -f $(srctree)/Documentation/Makefile dochelp
 	@echo  ''
 	@echo  'Architecture specific targets ($(SRCARCH)):'
 	@$(if $(archhelp),$(archhelp),\
@@ -1515,6 +1517,15 @@ endif
 	@echo  'Execute "make" or "make all" to build all targets marked with [*] '
 	@echo  'For further info see the documentation'
 
+
+# Documentation targets
+# ---------------------------------------------------------------------------
+DOC_TARGETS := docs htmldocs dochelp
+
+PHONY += $(DOC_TARGETS)
+$(DOC_TARGETS):
+	$(Q)$(MAKE) -f $(srctree)/Documentation/Makefile $@
+
 # Code Coverage
 # ---------------------------------------------------------------------------
 
@@ -1541,15 +1552,6 @@ quiet_cmd_tags = GEN     $@
 tags TAGS cscope gtags: FORCE
 	$(call cmd,tags)
 
-SPHINXBUILD   = sphinx-build
-ALLSPHINXOPTS   =  source
-
-docs: FORCE
-	@mkdir -p $(srctree)/Documentation/commands
-	@$(srctree)/Documentation/gen_commands.py $(srctree) $(srctree)/Documentation/commands
-	@$(SPHINXBUILD) -b html -d $(objtree)/doctrees $(srctree)/Documentation \
-		$(objtree)/Documentation/html
-
 bareboxversion:
 	@echo $(KERNELVERSION)
 
-- 
2.47.3

[PATCH 3/4] ci: add workflow to check documentation build is warning free

[Ahmad Fatoum]

With latest changes, we have a warning-free documentation build.
Add a CI check that builds the docs and translates warnings to
annotations on Github.

Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
 .github/workflows/sphinx-docs.yml | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 .github/workflows/sphinx-docs.yml

diff --git a/.github/workflows/sphinx-docs.yml b/.github/workflows/sphinx-docs.yml
new file mode 100644
index 000000000000..6d9745d9fd5a
--- /dev/null
+++ b/.github/workflows/sphinx-docs.yml
@@ -0,0 +1,17 @@
+name: Pull Request Docs Check
+
+on: [push, pull_request]
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Build docs
+      uses: ammaraskar/sphinx-action@master
+      with:
+        docs-folder: "Documentation/"
+        build-command: "make htmldocs"
-- 
2.47.3

[PATCH 4/4] ARM: Rockchip: document changing console baud rate

[Ahmad Fatoum]

The rkbin-specific parts originate from the U-Boot ts433
documentation[1].

As they are useful to barebox users as well, import them here and add
some more barebox-specific info on baudrate configuration.

Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
 Documentation/boards/rockchip.rst | 49 +++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/Documentation/boards/rockchip.rst b/Documentation/boards/rockchip.rst
index eb1bbe81819a..34b0a0e5aa1a 100644
--- a/Documentation/boards/rockchip.rst
+++ b/Documentation/boards/rockchip.rst
@@ -126,3 +126,52 @@ MaskROM mode when no other bootsource contains a valid bootloader. This means to
 you have to make all other bootsources invalid by removing SD cards and shortcircuiting
 eMMCs. The RK3568 EVB has a pushbutton to disable the eMMC.
 On the Quartz64 boards, remove the eMMC module if present.
+
+Console Output
+--------------
+
+The DDR-init in the rkbin repository will set up a serial console
+at 1.5 MBaud, while barebox will set up the console with the baudrate it
+has been configured with in DT and/or Kconfig, which may be different.
+
+It can be useful for debugging to have the same baudrate for all components.
+
+The barebox baudrate is defined by device tree::
+
+  / {
+    chosen {
+      stdout-path = "serial0:1500000n8";
+    };
+  };
+
+and ``CONFIG_BAUDRATE`` controls the default if no baud rate is specified
+or the device tree has not been parsed yet:
+
+.. code-block:: console
+
+  $ scripts/config --file .config --set-str CONFIG_BAUDRATE 1500000
+
+
+The DDR-init baudrate can be modified by setting a ``uart baudrate``
+override in the ``ddrbin_param.txt`` file in the rkbin repository:
+
+.. code-block:: diff
+
+  diff --git a/tools/ddrbin_param.txt b/tools/ddrbin_param.txt
+  index 0d0f53884a72..f71e09aafc4c 100644
+  --- a/tools/ddrbin_param.txt
+  +++ b/tools/ddrbin_param.txt
+  @@ -11,7 +11,7 @@ lp5_freq=
+   
+   uart id=
+   uart iomux=
+  -uart baudrate=
+  +uart baudrate=115200
+   
+   sr_idle=
+   pd_idle=
+
+And after that the ``ddrbin_tool`` binary can be used to apply this
+modification to the relevant ddr init blob::
+
+$ tools/ddrbin_tool rk3568 tools/ddrbin_param.txt bin/rk35/rk3568_ddr_1560MHz_v1.21.bin
-- 
2.47.3

Re: [PATCH 1/4] Documentation: migration-guides: don't warn about migration-master

[Sascha Hauer]

On Fri, 28 Nov 2025 19:49:14 +0100, Ahmad Fatoum wrote:
> This file holds pending migration notes and is unreferenced, so mark it
> orphan to suppress the warning.
> 
> 

Applied, thanks!

[1/4] Documentation: migration-guides: don't warn about migration-master
      https://git.pengutronix.de/cgit/barebox/commit/?id=67181e72d855 (link may not be stable)
[2/4] Documentation: factor out build rules into stand-alone Makefile
      https://git.pengutronix.de/cgit/barebox/commit/?id=6360393099d6 (link may not be stable)
[3/4] ci: add workflow to check documentation build is warning free
      https://git.pengutronix.de/cgit/barebox/commit/?id=4a8d9ab1c500 (link may not be stable)
[4/4] ARM: Rockchip: document changing console baud rate
      https://git.pengutronix.de/cgit/barebox/commit/?id=f5312a751648 (link may not be stable)

Best regards,
-- 
Sascha Hauer <s.hauer@pengutronix.de>