[PATCH 1/1] 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 --- 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

On Wed, Jul 28, 2021 at 5:03 PM Heinrich Schuchardt xypron.glpk@gmx.de wrote:
nits: missing
From: Heinrich Schuchardt heinrich.schuchardt@canonical.com
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(-)
Otherwise Reviewed-by: Bin Meng bmeng.cn@gmail.com

Hi Bin,
On Wed, Jul 28, 2021 at 05:18:59PM +0800, Bin Meng wrote:
On Wed, Jul 28, 2021 at 5:03 PM Heinrich Schuchardt xypron.glpk@gmx.de wrote:
nits: missing
Could you explain what is missing here? I did not quite catch the point, thanks!
From: Heinrich Schuchardt heinrich.schuchardt@canonical.com
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(-)
Otherwise Reviewed-by: Bin Meng bmeng.cn@gmail.com
Best regards, Leo

Hi Leo,
On Mon, Aug 2, 2021 at 4:50 PM Leo Liang ycliang@andestech.com wrote:
Hi Bin,
On Wed, Jul 28, 2021 at 05:18:59PM +0800, Bin Meng wrote:
On Wed, Jul 28, 2021 at 5:03 PM Heinrich Schuchardt xypron.glpk@gmx.de wrote:
nits: missing
Could you explain what is missing here? I did not quite catch the point, thanks!
Missing the 2nd line I mentioned in my previous email:
From: Heinrich Schuchardt heinrich.schuchardt@canonical.com
From: Heinrich Schuchardt heinrich.schuchardt@canonical.com
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(-)
Otherwise Reviewed-by: Bin Meng bmeng.cn@gmail.com
Regards, Bin

Hi Bin, On Mon, Aug 02, 2021 at 05:01:07PM +0800, Bin Meng wrote:
Hi Leo,
On Mon, Aug 2, 2021 at 4:50 PM Leo Liang ycliang@andestech.com wrote:
Hi Bin,
On Wed, Jul 28, 2021 at 05:18:59PM +0800, Bin Meng wrote:
On Wed, Jul 28, 2021 at 5:03 PM Heinrich Schuchardt xypron.glpk@gmx.de wrote:
nits: missing
Could you explain what is missing here? I did not quite catch the point, thanks!
Missing the 2nd line I mentioned in my previous email:
Do you mean that there is supposed to be a sentence but it is missing now? If so then got it, let's wait for Heinrich's comment.
From: Heinrich Schuchardt heinrich.schuchardt@canonical.com
From: Heinrich Schuchardt heinrich.schuchardt@canonical.com
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(-)
Otherwise Reviewed-by: Bin Meng bmeng.cn@gmail.com
Regards, Bin
Best regards, Leo

Hi Leo,
On Mon, Aug 2, 2021 at 5:17 PM Leo Liang ycliang@andestech.com wrote:
Hi Bin, On Mon, Aug 02, 2021 at 05:01:07PM +0800, Bin Meng wrote:
Hi Leo,
On Mon, Aug 2, 2021 at 4:50 PM Leo Liang ycliang@andestech.com wrote:
Hi Bin,
On Wed, Jul 28, 2021 at 05:18:59PM +0800, Bin Meng wrote:
On Wed, Jul 28, 2021 at 5:03 PM Heinrich Schuchardt xypron.glpk@gmx.de wrote:
nits: missing
Could you explain what is missing here? I did not quite catch the point, thanks!
Missing the 2nd line I mentioned in my previous email:
Do you mean that there is supposed to be a sentence but it is missing now? If so then got it, let's wait for Heinrich's comment.
This patch is missing the following line:
From: Heinrich Schuchardt heinrich.schuchardt@canonical.com
Which makes this commit's author does NOT match to SoB.
From: Heinrich Schuchardt heinrich.schuchardt@canonical.com
From: Heinrich Schuchardt heinrich.schuchardt@canonical.com
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(-)
Otherwise Reviewed-by: Bin Meng bmeng.cn@gmail.com
Regards, Bin

Hi Bin, On Mon, Aug 02, 2021 at 05:48:49PM +0800, Bin Meng wrote:
Hi Leo,
On Mon, Aug 2, 2021 at 5:17 PM Leo Liang ycliang@andestech.com wrote:
Hi Bin, On Mon, Aug 02, 2021 at 05:01:07PM +0800, Bin Meng wrote:
Hi Leo,
On Mon, Aug 2, 2021 at 4:50 PM Leo Liang ycliang@andestech.com wrote:
Hi Bin,
On Wed, Jul 28, 2021 at 05:18:59PM +0800, Bin Meng wrote:
On Wed, Jul 28, 2021 at 5:03 PM Heinrich Schuchardt xypron.glpk@gmx.de wrote:
nits: missing
Could you explain what is missing here? I did not quite catch the point, thanks!
Missing the 2nd line I mentioned in my previous email:
Do you mean that there is supposed to be a sentence but it is missing now? If so then got it, let's wait for Heinrich's comment.
This patch is missing the following line:
From: Heinrich Schuchardt heinrich.schuchardt@canonical.com
Which makes this commit's author does NOT match to SoB.
Got it! Thanks for the explanation! Then let's wait for Heinrich's 2nd patch. Best regards, Leo
From: Heinrich Schuchardt heinrich.schuchardt@canonical.com
From: Heinrich Schuchardt heinrich.schuchardt@canonical.com
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(-)
Otherwise Reviewed-by: Bin Meng bmeng.cn@gmail.com
Regards, Bin
participants (3)
-
Bin Meng
-
Heinrich Schuchardt
-
Leo Liang