From c00f08c20adff6ad34bd967e7949d1f4dae02ef3 Mon Sep 17 00:00:00 2001 From: Anshul Dalal Date: Tue, 29 Apr 2025 19:21:07 +0530 Subject: [PATCH] doc: ti: update bash code-block directives to prompt The code-block directive requires addition of the prompt symbol for each line, using the prompt directive instead allows for auto insertion of the symbol per line[1]. For the readers, the character added by the prompt directive is un-selectable i.e the entire line can be more easily selected for copy pasting etc. Whereas with code-block, the prompt symbol like "$" is also selectable which is usually not the intent. This is mostly a QoL addition + making the docs consistent since k3.rst makes use of prompt directives which these board docs include from. [1]: https://pypi.org/project/sphinx-prompt/ Signed-off-by: Anshul Dalal --- doc/board/ti/am62ax_sk.rst | 20 ++++++++++---------- doc/board/ti/am62px_sk.rst | 18 +++++++++--------- doc/board/ti/j722s_evm.rst | 12 ++++++------ doc/board/ti/j784s4_evm.rst | 16 ++++++++-------- 4 files changed, 33 insertions(+), 33 deletions(-) diff --git a/doc/board/ti/am62ax_sk.rst b/doc/board/ti/am62ax_sk.rst index 262340ef59a..43a1db68873 100644 --- a/doc/board/ti/am62ax_sk.rst +++ b/doc/board/ti/am62ax_sk.rst @@ -81,16 +81,16 @@ Set the variables corresponding to this platform: .. include:: ../ti/k3.rst :start-after: .. k3_rst_include_start_common_env_vars_defn :end-before: .. k3_rst_include_end_common_env_vars_defn -.. code-block:: bash +.. prompt:: bash - $ export UBOOT_CFG_CORTEXR=am62ax_evm_r5_defconfig - $ export UBOOT_CFG_CORTEXA=am62ax_evm_a53_defconfig - $ export TFA_BOARD=lite - $ # we dont use any extra TFA parameters - $ unset TFA_EXTRA_ARGS - $ export OPTEE_PLATFORM=k3-am62ax - $ # we dont use any extra OPTEE parameters - $ unset OPTEE_EXTRA_ARGS + export UBOOT_CFG_CORTEXR=am62ax_evm_r5_defconfig + export UBOOT_CFG_CORTEXA=am62ax_evm_a53_defconfig + export TFA_BOARD=lite + # we dont use any extra TFA parameters + unset TFA_EXTRA_ARGS + export OPTEE_PLATFORM=k3-am62ax + # we dont use any extra OPTEE parameters + unset OPTEE_EXTRA_ARGS 1. Trusted Firmware-A: @@ -212,6 +212,6 @@ detailed setup information. To start OpenOCD and connect to the board -.. code-block:: bash +.. prompt:: bash openocd -f board/ti_am62a7evm.cfg diff --git a/doc/board/ti/am62px_sk.rst b/doc/board/ti/am62px_sk.rst index 99bdc034869..a07d6a4da45 100644 --- a/doc/board/ti/am62px_sk.rst +++ b/doc/board/ti/am62px_sk.rst @@ -91,15 +91,15 @@ Set the variables corresponding to this platform: :start-after: .. k3_rst_include_start_common_env_vars_defn :end-before: .. k3_rst_include_end_common_env_vars_defn -.. code-block:: bash +.. prompt:: bash - $ export UBOOT_CFG_CORTEXR=am62px_evm_r5_defconfig - $ export UBOOT_CFG_CORTEXA=am62px_evm_a53_defconfig - $ export TFA_BOARD=lite - $ # we dont use any extra TFA parameters - $ unset TFA_EXTRA_ARGS - $ export OPTEE_PLATFORM=k3-am62x - $ export OPTEE_EXTRA_ARGS="CFG_WITH_SOFTWARE_PRNG=y" + export UBOOT_CFG_CORTEXR=am62px_evm_r5_defconfig + export UBOOT_CFG_CORTEXA=am62px_evm_a53_defconfig + export TFA_BOARD=lite + # we dont use any extra TFA parameters + unset TFA_EXTRA_ARGS + export OPTEE_PLATFORM=k3-am62x + export OPTEE_EXTRA_ARGS="CFG_WITH_SOFTWARE_PRNG=y" .. am62px_evm_rst_include_start_build_steps @@ -312,6 +312,6 @@ detailed setup information. To start OpenOCD and connect to the board -.. code-block:: bash +.. prompt:: bash openocd -f board/ti_am62pevm.cfg diff --git a/doc/board/ti/j722s_evm.rst b/doc/board/ti/j722s_evm.rst index edc29a4f9e4..9c53fa50858 100644 --- a/doc/board/ti/j722s_evm.rst +++ b/doc/board/ti/j722s_evm.rst @@ -68,12 +68,12 @@ Set the variables corresponding to this platform: :start-after: .. k3_rst_include_start_common_env_vars_defn :end-before: .. k3_rst_include_end_common_env_vars_defn -.. code-block:: bash +.. prompt:: bash - $ export UBOOT_CFG_CORTEXR=j722s_evm_r5_defconfig - $ export UBOOT_CFG_CORTEXA=j722s_evm_a53_defconfig - $ export TFA_BOARD=lite - $ export OPTEE_PLATFORM=k3-am62x + export UBOOT_CFG_CORTEXR=j722s_evm_r5_defconfig + export UBOOT_CFG_CORTEXA=j722s_evm_a53_defconfig + export TFA_BOARD=lite + export OPTEE_PLATFORM=k3-am62x .. j722s_evm_rst_include_start_build_steps @@ -258,6 +258,6 @@ detailed setup information. To start OpenOCD and connect to the board -.. code-block:: bash +.. prompt:: bash openocd -f board/ti_j722sevm.cfg diff --git a/doc/board/ti/j784s4_evm.rst b/doc/board/ti/j784s4_evm.rst index a1e927cb743..349fb394d74 100644 --- a/doc/board/ti/j784s4_evm.rst +++ b/doc/board/ti/j784s4_evm.rst @@ -81,14 +81,14 @@ Set the variables corresponding to this platform: .. include:: k3.rst :start-after: .. k3_rst_include_start_common_env_vars_defn :end-before: .. k3_rst_include_end_common_env_vars_defn -.. code-block:: bash +.. prompt:: bash - $ export UBOOT_CFG_CORTEXR=j784s4_evm_r5_defconfig - $ export UBOOT_CFG_CORTEXA=j784s4_evm_a72_defconfig - $ export TFA_BOARD=j784s4 - $ export TFA_EXTRA_ARGS="K3_USART=0x8" - $ export OPTEE_PLATFORM=k3-j784s4 - $ export OPTEE_EXTRA_ARGS="CFG_CONSOLE_UART=0x8" + export UBOOT_CFG_CORTEXR=j784s4_evm_r5_defconfig + export UBOOT_CFG_CORTEXA=j784s4_evm_a72_defconfig + export TFA_BOARD=j784s4 + export TFA_EXTRA_ARGS="K3_USART=0x8" + export OPTEE_PLATFORM=k3-j784s4 + export OPTEE_EXTRA_ARGS="CFG_CONSOLE_UART=0x8" .. j784s4_evm_rst_include_start_build_steps @@ -326,6 +326,6 @@ Debugging U-Boot on J784S4-EVM and AM69-SK To start OpenOCD and connect to J784S4-EVM or AM69-SK board, use the following. -.. code-block:: bash +.. prompt:: bash openocd -f board/ti_j784s4evm.cfg -- 2.39.5