DistroKit Mailinglist
 help / color / mirror / Atom feed
From: Roland Hieber <rhi@pengutronix.de>
To: distrokit@pengutronix.de
Subject: Re: [DistroKit] [PATCH] doc: replace "copy onto" by "write to" to prevent confusion
Date: Wed, 10 May 2023 15:40:01 +0200	[thread overview]
Message-ID: <20230510134001.mrwku75fmj6bewi2@pengutronix.de> (raw)
In-Reply-To: <20230331085152.2037767-1-rhi@pengutronix.de>

Ping?

On Fri, Mar 31, 2023 at 10:51:52AM +0200, Roland Hieber wrote:
> "Copy" could be misunderstood as "use cp (on the file system level)",
> which will not lead to the intended results, i.e. writing to the device
> directly (e.g. using dd).
> 
> Furthermore, using "write onto" [1] instead of "write to" [2] feels
> unnatural here – as if writing something on top of another. Use "to"
> instead.
> 
> [1]: about 460.000 Google results
> [2]: about 146.000.000 Google results
> 
> Signed-off-by: Roland Hieber <rhi@pengutronix.de>
> ---
>  doc/hardware_v7a_beaglebone_black.rst | 2 +-
>  doc/hardware_v7a_beaglebone_white.rst | 2 +-
>  doc/hardware_v7a_noneon_sama5d3.rst   | 2 +-
>  doc/hardware_v7a_raspi23.rst          | 6 +++---
>  doc/hardware_v7a_riot.rst             | 2 +-
>  doc/hardware_v7a_sama5d2.rst          | 2 +-
>  doc/hardware_v7a_udoo_neo.rst         | 2 +-
>  doc/hardware_v8a_espressobin.rst      | 2 +-
>  doc/hardware_v8a_rock3a.rst           | 6 +++---
>  9 files changed, 13 insertions(+), 13 deletions(-)
> 
> diff --git a/doc/hardware_v7a_beaglebone_black.rst b/doc/hardware_v7a_beaglebone_black.rst
> index bb523b6a4b5c..f0adfb926cfd 100644
> --- a/doc/hardware_v7a_beaglebone_black.rst
> +++ b/doc/hardware_v7a_beaglebone_black.rst
> @@ -3,7 +3,7 @@ Beaglebone Black
>  
>  Boot Media
>  ----------
> -Use the image ``platform-v7a/images/beaglebone.hdimg`` and copy it onto your MicroSD-Card.
> +Use the image ``platform-v7a/images/beaglebone.hdimg`` and write it to your MicroSD-Card.
>  Press the user-button ``S2`` when powering up the Beaglebone Black to boot from MicroSD-Card. ``S2`` is the button above the MicroSD-Card.
>  
>  Serial Console
> diff --git a/doc/hardware_v7a_beaglebone_white.rst b/doc/hardware_v7a_beaglebone_white.rst
> index 540066bc0c4f..2ed669b9ea46 100644
> --- a/doc/hardware_v7a_beaglebone_white.rst
> +++ b/doc/hardware_v7a_beaglebone_white.rst
> @@ -3,7 +3,7 @@ Beaglebone White
>  
>  Boot Media
>  ----------
> -Use the image ``platform-v7a/images/beaglebone.hdimg`` and copy it onto your MicroSD-Card.
> +Use the image ``platform-v7a/images/beaglebone.hdimg`` and write it to your MicroSD-Card.
>  
>  Serial Console
>  --------------
> diff --git a/doc/hardware_v7a_noneon_sama5d3.rst b/doc/hardware_v7a_noneon_sama5d3.rst
> index db784e3e45b7..aaeed3e0c81a 100644
> --- a/doc/hardware_v7a_noneon_sama5d3.rst
> +++ b/doc/hardware_v7a_noneon_sama5d3.rst
> @@ -10,7 +10,7 @@ Boot Media
>  ----------
>  
>  DistroKit generates ``platform-v7a_noneon/images/*.hdimg``.
> -Use the respective image for your board and copy it onto your SD card.
> +Use the respective image for your board and write it to your SD card.
>  
>  The EVB-KSZ9477 board has only 1 SD slot. To boot from SD, J13 (NAND Enable)
>  jumper should be removed.
> diff --git a/doc/hardware_v7a_raspi23.rst b/doc/hardware_v7a_raspi23.rst
> index 0f6eee65acef..f1d20412b2af 100644
> --- a/doc/hardware_v7a_raspi23.rst
> +++ b/doc/hardware_v7a_raspi23.rst
> @@ -3,7 +3,7 @@ Raspberry Pi 2
>  
>  Boot Media
>  ----------
> -Use the same ``platform-v7a/images/rpi.hdimg`` image and copy it onto your MicroSD-Card.
> +Use the same ``platform-v7a/images/rpi.hdimg`` image and write it to your MicroSD-Card.
>  
>  Serial Console
>  --------------
> @@ -18,7 +18,7 @@ Raspberry Pi 3
>  
>  Boot Media
>  ----------
> -Use the same ``platform-v7a/images/rpi.hdimg`` image and copy it onto your MicroSD-Card.
> +Use the same ``platform-v7a/images/rpi.hdimg`` image and write it to your MicroSD-Card.
>  
>  Serial Console
>  --------------
> @@ -33,7 +33,7 @@ Raspberry Pi Compute Module 3+
>  
>  Boot Media
>  ----------
> -Use the same ``platform-v7a/images/rpi.hdimg`` image and copy it onto your MicroSD-Card.
> +Use the same ``platform-v7a/images/rpi.hdimg`` image and write it to your MicroSD-Card.
>  
>  If you have a hardware with eMMC the uSD slot is not functional, in this case
>  you have to use `usbboot <https://github.com/raspberrypi/usbboot>`_ to switch
> diff --git a/doc/hardware_v7a_riot.rst b/doc/hardware_v7a_riot.rst
> index 0ea4ce7846e4..77b48cb8b647 100644
> --- a/doc/hardware_v7a_riot.rst
> +++ b/doc/hardware_v7a_riot.rst
> @@ -3,7 +3,7 @@ RIoT-Board
>  
>  Boot Media
>  ----------
> -Use the image ``platform-v7a/images/riotboard.hdimg`` and copy it onto your SD card.
> +Use the image ``platform-v7a/images/riotboard.hdimg`` and write it to your SD card.
>  
>  Set the DIP switches (SW1) accordingly to boot from a full-size SD card (J6
>  on the bottom) or a Micro SD card (J7 on top):
> diff --git a/doc/hardware_v7a_sama5d2.rst b/doc/hardware_v7a_sama5d2.rst
> index ae39cdf3b3ed..083a46dedbaa 100644
> --- a/doc/hardware_v7a_sama5d2.rst
> +++ b/doc/hardware_v7a_sama5d2.rst
> @@ -10,7 +10,7 @@ Boot Media
>  ----------
>  
>  DistroKit generates ``platform-v7a/images/sama5d27-*.hdimg``.
> -Use the respective image for your board and copy it onto your SD card.
> +Use the respective image for your board and write it to your SD card.
>  The Giant board has only 1 microSD slot, the EK has additionally
>  1 normal SD-sized slot. Both can be used.
>  
> diff --git a/doc/hardware_v7a_udoo_neo.rst b/doc/hardware_v7a_udoo_neo.rst
> index b84fde7701ef..674bdfe12b68 100644
> --- a/doc/hardware_v7a_udoo_neo.rst
> +++ b/doc/hardware_v7a_udoo_neo.rst
> @@ -4,7 +4,7 @@ Udoo Neo
>  Boot Media
>  ----------
>  
> -Use the image ``platform-v7a/images/udoo-neo.hdimg`` and copy it onto your MicroSD-Card. 
> +Use the image ``platform-v7a/images/udoo-neo.hdimg`` and write it to your MicroSD-Card. 
>  
>  
>  Serial Console
> diff --git a/doc/hardware_v8a_espressobin.rst b/doc/hardware_v8a_espressobin.rst
> index 63d3e89e9820..dc4fc77d4c6b 100644
> --- a/doc/hardware_v8a_espressobin.rst
> +++ b/doc/hardware_v8a_espressobin.rst
> @@ -3,7 +3,7 @@ Marvell espressobin
>  
>  Boot Media
>  ----------
> -Use the image ``platform-v8a/images/espressobin.hdimg`` and copy it onto your MicroSD-Card, e.g:
> +Use the image ``platform-v8a/images/espressobin.hdimg`` and write it to your MicroSD-Card, e.g:
>  
>  .. code-block:: shell
>  
> diff --git a/doc/hardware_v8a_rock3a.rst b/doc/hardware_v8a_rock3a.rst
> index 3aa5a62ea8bd..da614a46a081 100644
> --- a/doc/hardware_v8a_rock3a.rst
> +++ b/doc/hardware_v8a_rock3a.rst
> @@ -4,12 +4,12 @@ Radxa Rock 3 Model A
>  Boot Media
>  ----------
>  
> -Copy the image ``platform-v8a/images/rock3a.img`` onto a microSD card. Put the
> +Write the image ``platform-v8a/images/rock3a.img`` to a microSD card. Put the
>  microSD card into the Rock 3A and boot it, the system will autoboot to linux.
>  
>  If you just want to boot to barebox instead of a full linux image from microSD card
>  (e.g. for chainloading or tftpboot),
> -copy the image ``platform-v8a/images/barebox-rock3a.norimg`` onto a microSD card instead.
> +write the image ``platform-v8a/images/barebox-rock3a.norimg`` to a microSD card instead.
>  
>  Alternatively, you may put the Rock 3A into MASKROM mode following the `Rock 3
>  Hardware User Manual <https://wiki.radxa.com/Rock3/hardware/3a>`_ and boot
> @@ -19,7 +19,7 @@ Barebox via USB:
>  
>      platform-v8a/sysroot-host/bin/rk-usb-loader platform-v8a/images/barebox-rock3a.img-rockchip
>  
> -Once Barebox is booted, copy the image ``platform-v8a/images/rock3a.img`` via
> +Once Barebox is booted, write the image ``platform-v8a/images/rock3a.img`` via
>  tftp or NFS to the eMMC to persist it. Disable MASKROM mode and reboot the
>  board to start from eMMC.
>  
> -- 
> 2.39.2
> 
> 
> 

-- 
Roland Hieber, Pengutronix e.K.          | r.hieber@pengutronix.de     |
Steuerwalder Str. 21                     | https://www.pengutronix.de/ |
31137 Hildesheim, Germany                | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686         | Fax:   +49-5121-206917-5555 |



  reply	other threads:[~2023-05-10 13:40 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-31  8:51 Roland Hieber
2023-05-10 13:40 ` Roland Hieber [this message]
2023-06-20 13:15 ` Robert Schwebel

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=20230510134001.mrwku75fmj6bewi2@pengutronix.de \
    --to=rhi@pengutronix.de \
    --cc=distrokit@pengutronix.de \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox