All of lore.kernel.org
 help / color / mirror / Atom feed
From: Heinrich Schuchardt <xypron.glpk@gmx.de>
To: u-boot@lists.denx.de
Cc: Bin Meng <bmeng.cn@gmail.com>,
	Leo Yu-Chi Liang <ycliang@andestech.com>,
	Jagan Teki <jagan@amarulasolutions.com>,
	Pragnesh Patel <pragnesh.patel@sifive.com>,
	Rick Chen <rick@andestech.com>, Green Wan <green.wan@sifive.com>,
	Heinrich Schuchardt <xypron.glpk@gmx.de>,
	Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Subject: [PATCH 1/1] doc: riscv: flashing SiFive boards
Date: Wed, 28 Jul 2021 11:03:01 +0200	[thread overview]
Message-ID: <20210728090301.79193-1-xypron.glpk@gmx.de> (raw)

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>
---
 doc/board/sifive/unleashed.rst | 20 ++++++++++----------
 doc/board/sifive/unmatched.rst | 30 +++++++++++++++---------------
 2 files changed, 25 insertions(+), 25 deletions(-)

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..4b4a1ff8f0 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
 -------
--
2.30.2


             reply	other threads:[~2021-07-28  9:03 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-07-28  9:03 Heinrich Schuchardt [this message]
2021-07-28  9:18 ` [PATCH 1/1] doc: riscv: flashing SiFive boards Bin Meng
2021-08-02  8:50   ` Leo Liang
2021-08-02  9:01     ` Bin Meng
2021-08-02  9:17       ` Leo Liang
2021-08-02  9:48         ` Bin Meng
2021-08-02 10:20           ` Leo Liang

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210728090301.79193-1-xypron.glpk@gmx.de \
    --to=xypron.glpk@gmx.de \
    --cc=bmeng.cn@gmail.com \
    --cc=green.wan@sifive.com \
    --cc=heinrich.schuchardt@canonical.com \
    --cc=jagan@amarulasolutions.com \
    --cc=pragnesh.patel@sifive.com \
    --cc=rick@andestech.com \
    --cc=u-boot@lists.denx.de \
    --cc=ycliang@andestech.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.