Re: [PATCH v7 6/6] rockchip: doc: add notes section

Quentin Schulz <[email protected]>
Newsgroups org.u-boot-project.lists.u-boot
Message-ID <[email protected]>
Hi Johan,

On 8/15/26 3:08 PM, Johan Jonker wrote:
> Add a notes section for things that don't need
> a chapter. Include some rk3036/rk3066 cases.
> 
> Signed-off-by: Johan Jonker <[email protected]>
> Reviewed-by: Simon Glass <[email protected]>
> ---
>   doc/board/rockchip/rockchip.rst | 8 ++++++++
>   1 file changed, 8 insertions(+)
> 
> diff --git a/doc/board/rockchip/rockchip.rst b/doc/board/rockchip/rockchip.rst
> index d5945e805ba8..6dbff5b72d90 100644
> --- a/doc/board/rockchip/rockchip.rst
> +++ b/doc/board/rockchip/rockchip.rst
> @@ -325,6 +325,14 @@ To build rk3588 boards:
>           make evb-rk3588_defconfig
>           make CROSS_COMPILE=aarch64-linux-gnu-
>   
> +Notes
> +^^^^^
> +
> +* rk3036: SDMMC and the debug uart share the same iomux, so if
> +  a SD card is the boot medium, the debug uart must be disabled.
> +* rk3066: eMMC and NAND share the same iomux, so if in Mask ROM mode
> +  and a NAND is the boot medium, clear the emmc_flash_sel bit in GRF_SOC_CON0.
> +

Use .. note:: admonitions (c.f. 
https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-note) 
instead, so we don't have an additional section.

Something like:

"""
diff --git a/doc/board/rockchip/rockchip.rst 
b/doc/board/rockchip/rockchip.rst
index 6dbff5b72d90..b7705b1df6f3 100644
--- a/doc/board/rockchip/rockchip.rst
+++ b/doc/board/rockchip/rockchip.rst
@@ -325,13 +325,13 @@ To build rk3588 boards:
          make evb-rk3588_defconfig
          make CROSS_COMPILE=aarch64-linux-gnu-

-Notes
-^^^^^
+.. note::
+   On RK3036, the SDMMC and the debug uart share the same iomux, so if
+   a SD card is the boot medium, the debug uart must be disabled.

-* rk3036: SDMMC and the debug uart share the same iomux, so if
-  a SD card is the boot medium, the debug uart must be disabled.
-* rk3066: eMMC and NAND share the same iomux, so if in Mask ROM mode
-  and a NAND is the boot medium, clear the emmc_flash_sel bit in 
GRF_SOC_CON0.
+.. note::
+   On RK3066, the eMMC and NAND share the same iomux, so if in Mask ROM 
mode
+   and a NAND is the boot medium, clear the emmc_flash_sel bit in 
GRF_SOC_CON0.

  Mask ROM mode
  -------------
"""

(I didn't reword Mask ROM but please take into account Jonas's feedback 
on the v6).

Where did you get the info for RK3066, it's not in the current 
doc/README.rockchip. If it's something new, then keep it in a separate 
patch like you've done here and add some more info in the commit log. If 
it's something that already exists and I missed it, please tell me and 
also squash with the patch that removes the text from other files if 
applicable.

For the rk3036 part, please squash with patch 4.

Thanks!
Quentin
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.