On 7/26/24 19:18, Grzegorz Szymaszek wrote:
Thanks for looking at improving this documentation.
Please, provide a commit message.
Signed-off-by: Grzegorz Szymaszek <gszymas...@short.pl>
---
doc/board/st/stm32mp1.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/doc/board/st/stm32mp1.rst b/doc/board/st/stm32mp1.rst
index 239e18b5e17..98167e80618 100644
--- a/doc/board/st/stm32mp1.rst
+++ b/doc/board/st/stm32mp1.rst
@@ -265,7 +265,7 @@ Build Procedure
# make stm32mp15_defconfig
# make DEVICE_TREE=stm32mp157c-ev1-scmi all
- or without SCMI support
+ or without SCMI support::
Either use
.. code-block:: bash
or
.. prompt:: bash $
# export KBUILD_OUTPUT=stm32mp15
# make stm32mp15_defconfig
# is the prompt for root. Please, do not suggest to build as root.
Please, do not start lines with a prompt as this does not allow to copy
multiple lines to a terminal. .. prompt:: allows you to display a prompt
which will not be copied. .. code-block:: avoids showing the prompt
which could be seen as distractive.
@@ -796,7 +796,7 @@ You can update the boot device:
When the board is booting for nor0 or nand0,
only the MTD partition on the boot devices are available, for example:
-- NOR (nor0 = alt 20, nor1 = alt 26) & NAND (nand0 = alt 27) :
+- NOR (nor0 = alt 20, nor1 = alt 26) & NAND (nand0 = alt 27)::
ditto
$> dfu-util -d 0483:5720 -a 21 -D tf-a-stm32mp157c-ev1.stm32
$> dfu-util -d 0483:5720 -a 22 -D tf-a-stm32mp157c-ev1.stm32
Why '$>' is used as prompt here? Shouldn't this be '$'?
How about telling the user what dfu-util is and where to find it?
Does it relate to http://dfu-util.sourceforge.net?
Best regards
Heinrich
