From: Heinrich Schuchardt <xypron.glpk@gmx.de>
Date: Wed, 28 Jul 2021 08:52:53 +0000 (+0200)
Subject: doc: riscv: flashing SiFive boards
X-Git-Url: http://git.dujemihanovic.xyz/img/static/git-favicon.png?a=commitdiff_plain;h=d7a974953bfa0406f6c57b39ee944067279ff151;p=u-boot.git

doc: riscv: flashing SiFive boards

We should not use /dev/sda and /dev/sdb in our examples. Users might
inadvertently mess up their workstation. Use /dev/sdX instead.

Remove console output like '# ' and '> ' which makes copying hard.

Set example language to bash for correct syntax-highlighting.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
iewed-by: Bin Meng <bmeng.cn@gmail.com>
---

diff --git a/doc/board/sifive/unleashed.rst b/doc/board/sifive/unleashed.rst
index 4e4c852ff3..c8a62068a7 100644
--- a/doc/board/sifive/unleashed.rst
+++ b/doc/board/sifive/unleashed.rst
@@ -456,21 +456,21 @@ device tree blob (hifive-unleashed-a00.dtb)
 
 Format the SD card (make sure the disk has GPT, otherwise use gdisk to switch)
 
-.. code-block:: none
+.. code-block:: bash
 
-	# sudo sgdisk --clear \
-	> --set-alignment=2 \
-	> --new=1:34:2081 --change-name=1:loader1 --typecode=1:5B193300-FC78-40CD-8002-E86C45580B47 \
-	> --new=2:2082:10273 --change-name=2:loader2 --typecode=2:2E54B353-1271-4842-806F-E436D6AF6985 \
-	> --new=3:10274: --change-name=3:rootfs --typecode=3:0FC63DAF-8483-4772-8E79-3D69D8477DE4 \
-	> /dev/sda
+	sudo sgdisk --clear \
+	  --set-alignment=2 \
+	  --new=1:34:2081 --change-name=1:loader1 --typecode=1:5B193300-FC78-40CD-8002-E86C45580B47 \
+	  --new=2:2082:10273 --change-name=2:loader2 --typecode=2:2E54B353-1271-4842-806F-E436D6AF6985 \
+	  --new=3:10274: --change-name=3:rootfs --typecode=3:0FC63DAF-8483-4772-8E79-3D69D8477DE4 \
+	  /dev/sdX
 
 Program the SD card
 
-.. code-block:: none
+.. code-block:: bash
 
-	sudo dd if=spl/u-boot-spl.bin of=/dev/sda seek=34
-	sudo dd if=u-boot.itb of=/dev/sda seek=2082
+	sudo dd if=spl/u-boot-spl.bin of=/dev/sdX seek=34
+	sudo dd if=u-boot.itb of=/dev/sdX seek=2082
 
 Booting
 ~~~~~~~
diff --git a/doc/board/sifive/unmatched.rst b/doc/board/sifive/unmatched.rst
index e65b0d3206..6b024f07f6 100644
--- a/doc/board/sifive/unmatched.rst
+++ b/doc/board/sifive/unmatched.rst
@@ -61,31 +61,31 @@ device tree blob (hifive-unmatched-a00.dtb)
 
 Format the SD card (make sure the disk has GPT, otherwise use gdisk to switch)
 
-.. code-block:: none
+.. code-block:: bash
 
-	# sudo sgdisk -g --clear -a 1 \
-	> --new=1:34:2081         --change-name=1:spl --typecode=1:5B193300-FC78-40CD-8002-E86C45580B47 \
-	> --new=2:2082:10273      --change-name=2:uboot  --typecode=2:2E54B353-1271-4842-806F-E436D6AF6985 \
-	> --new=3:16384:282623    --change-name=3:boot --typecode=3:0x0700 \
-	> --new=4:286720:13918207 --change-name=4:root --typecode=4:0x8300 \
-	> /dev/sdb
+	sudo sgdisk -g --clear -a 1 \
+	  --new=1:34:2081         --change-name=1:spl --typecode=1:5B193300-FC78-40CD-8002-E86C45580B47 \
+	  --new=2:2082:10273      --change-name=2:uboot  --typecode=2:2E54B353-1271-4842-806F-E436D6AF6985 \
+	  --new=3:16384:282623    --change-name=3:boot --typecode=3:0x0700 \
+	  --new=4:286720:13918207 --change-name=4:root --typecode=4:0x8300 \
+	  /dev/sdX
 
 Copy linux Image.gz and hifive-unmatched-a00.dtb to boot partition
 
-.. code-block:: none
+.. code-block:: bash
 
-	sudo mkfs.vfat /dev/sdb3
-	sudo mkfs.ext4 /dev/sdb4
+	sudo mkfs.vfat /dev/sdX3
+	sudo mkfs.ext4 /dev/sdX4
 
-	sudo mount /dev/sdb3 /media/sdb3
-	sudo cp Image.gz hifive-unmatched-a00.dtb /media/sdb3/
+	sudo mount /dev/sdX3 /media/sdX3
+	sudo cp Image.gz hifive-unmatched-a00.dtb /media/sdX3/
 
 Program the SD card
 
-.. code-block:: none
+.. code-block:: bash
 
-	sudo dd if=spl/u-boot-spl.bin of=/dev/sda seek=34
-	sudo dd if=u-boot.itb of=/dev/sda seek=2082
+	sudo dd if=spl/u-boot-spl.bin of=/dev/sdX seek=34
+	sudo dd if=u-boot.itb of=/dev/sdX seek=2082
 
 Booting
 -------