mirrors/u-boot
1
0
Fork 0
mirror of https://source.denx.de/u-boot/u-boot.git synced 2025-08-16 04:07:00 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: ti: update bash code-block directives to prompt

Browse Source 
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 <anshuld@ti.com>
This commit is contained in:
Anshul Dalal 2025-04-29 19:21:07 +05:30 committed by Heinrich Schuchardt
parent 485ab4c6aa
commit c00f08c20a
4 changed files with 33 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/board/ti/am62ax_sk.rst
View File

@ -81,16 +81,16 @@ Set the variables corresponding to this platform:
.. include:: ../ti/k3.rst .. include:: ../ti/k3.rst
:start-after: .. k3_rst_include_start_common_env_vars_defn :start-after: .. k3_rst_include_start_common_env_vars_defn
:end-before: .. k3_rst_include_end_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_CORTEXR=am62ax_evm_r5_defconfig
$ export UBOOT_CFG_CORTEXA=am62ax_evm_a53_defconfig export UBOOT_CFG_CORTEXA=am62ax_evm_a53_defconfig
$ export TFA_BOARD=lite export TFA_BOARD=lite
$ # we dont use any extra TFA parameters # we dont use any extra TFA parameters
$ unset TFA_EXTRA_ARGS unset TFA_EXTRA_ARGS
$ export OPTEE_PLATFORM=k3-am62ax export OPTEE_PLATFORM=k3-am62ax
$ # we dont use any extra OPTEE parameters # we dont use any extra OPTEE parameters
$ unset OPTEE_EXTRA_ARGS unset OPTEE_EXTRA_ARGS
1. Trusted Firmware-A: 1. Trusted Firmware-A:
@ -212,6 +212,6 @@ detailed setup information.
To start OpenOCD and connect to the board To start OpenOCD and connect to the board
.. code-block:: bash .. prompt:: bash
openocd -f board/ti_am62a7evm.cfg openocd -f board/ti_am62a7evm.cfg

18
doc/board/ti/am62px_sk.rst
View File

@ -91,15 +91,15 @@ Set the variables corresponding to this platform:
:start-after: .. k3_rst_include_start_common_env_vars_defn :start-after: .. k3_rst_include_start_common_env_vars_defn
:end-before: .. k3_rst_include_end_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_CORTEXR=am62px_evm_r5_defconfig
$ export UBOOT_CFG_CORTEXA=am62px_evm_a53_defconfig export UBOOT_CFG_CORTEXA=am62px_evm_a53_defconfig
$ export TFA_BOARD=lite export TFA_BOARD=lite
$ # we dont use any extra TFA parameters # we dont use any extra TFA parameters
$ unset TFA_EXTRA_ARGS unset TFA_EXTRA_ARGS
$ export OPTEE_PLATFORM=k3-am62x export OPTEE_PLATFORM=k3-am62x
$ export OPTEE_EXTRA_ARGS="CFG_WITH_SOFTWARE_PRNG=y" export OPTEE_EXTRA_ARGS="CFG_WITH_SOFTWARE_PRNG=y"
.. am62px_evm_rst_include_start_build_steps .. am62px_evm_rst_include_start_build_steps
@ -312,6 +312,6 @@ detailed setup information.
To start OpenOCD and connect to the board To start OpenOCD and connect to the board
.. code-block:: bash .. prompt:: bash
openocd -f board/ti_am62pevm.cfg openocd -f board/ti_am62pevm.cfg

12
doc/board/ti/j722s_evm.rst
View File

@ -68,12 +68,12 @@ Set the variables corresponding to this platform:
:start-after: .. k3_rst_include_start_common_env_vars_defn :start-after: .. k3_rst_include_start_common_env_vars_defn
:end-before: .. k3_rst_include_end_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_CORTEXR=j722s_evm_r5_defconfig
$ export UBOOT_CFG_CORTEXA=j722s_evm_a53_defconfig export UBOOT_CFG_CORTEXA=j722s_evm_a53_defconfig
$ export TFA_BOARD=lite export TFA_BOARD=lite
$ export OPTEE_PLATFORM=k3-am62x export OPTEE_PLATFORM=k3-am62x
.. j722s_evm_rst_include_start_build_steps .. j722s_evm_rst_include_start_build_steps
@ -258,6 +258,6 @@ detailed setup information.
To start OpenOCD and connect to the board To start OpenOCD and connect to the board
.. code-block:: bash .. prompt:: bash
openocd -f board/ti_j722sevm.cfg openocd -f board/ti_j722sevm.cfg

16
doc/board/ti/j784s4_evm.rst
View File

@ -81,14 +81,14 @@ Set the variables corresponding to this platform:
.. include:: k3.rst .. include:: k3.rst
:start-after: .. k3_rst_include_start_common_env_vars_defn :start-after: .. k3_rst_include_start_common_env_vars_defn
:end-before: .. k3_rst_include_end_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_CORTEXR=j784s4_evm_r5_defconfig
$ export UBOOT_CFG_CORTEXA=j784s4_evm_a72_defconfig export UBOOT_CFG_CORTEXA=j784s4_evm_a72_defconfig
$ export TFA_BOARD=j784s4 export TFA_BOARD=j784s4
$ export TFA_EXTRA_ARGS="K3_USART=0x8" export TFA_EXTRA_ARGS="K3_USART=0x8"
$ export OPTEE_PLATFORM=k3-j784s4 export OPTEE_PLATFORM=k3-j784s4
$ export OPTEE_EXTRA_ARGS="CFG_CONSOLE_UART=0x8" export OPTEE_EXTRA_ARGS="CFG_CONSOLE_UART=0x8"
.. j784s4_evm_rst_include_start_build_steps .. 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 To start OpenOCD and connect to J784S4-EVM or AM69-SK board, use the
following. following.
.. code-block:: bash .. prompt:: bash
openocd -f board/ti_j784s4evm.cfg openocd -f board/ti_j784s4evm.cfg