diff options
author | Topi Reinio <topi.reinio@digia.com> | 2013-10-11 11:56:52 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@digia.com> | 2013-10-15 14:35:10 +0300 |
commit | e7724d5a213aa0bb6c4d50a9f9fc7cab2f6cb3cd (patch) | |
tree | 7fbcb2e8d5755aeda2ae0909a80c5dcb05bb6e40 /src/doc | |
parent | 395e7ff2a25216988b43aa310261b0e4204e1b7c (diff) |
Doc: Rewrite instructions for finding out SD card device path
Rewrite the instructions and move them to a separate qdocinc
file. Also move the warning about potential HDD-wipe to this
step, as that's when you have to pay attention to it.
Change-Id: I812ceca23c26587876c9ea66049b72fcce8561c9
Reviewed-by: Eirik Aavitsland <eirik.aavitsland@digia.com>
Diffstat (limited to 'src/doc')
-rw-r--r-- | src/doc/src/b2qt.qdoc | 81 | ||||
-rw-r--r-- | src/doc/src/detect-sd-card-device-name.qdocinc | 27 |
2 files changed, 30 insertions, 78 deletions
diff --git a/src/doc/src/b2qt.qdoc b/src/doc/src/b2qt.qdoc index 059338d..978d6b9 100644 --- a/src/doc/src/b2qt.qdoc +++ b/src/doc/src/b2qt.qdoc @@ -372,27 +372,7 @@ For \B2QA, a micro-SD card of at least 2GB capacity is needed. For \B2QL, a card of at least 512MB capacity is sufficient. - Plug the micro-SD card/reader into the development host PC and use - the following command to find out its device path - (i.e. \c{/dev/XXX}, where \c{XXX} typically is \c{sdb}): - - \code - df -h - \endcode - - Alternatively, if the micro-SD card is unformatted, run the following - command immediately after inserting the card to see its device - path: - - \code - dmesg | tail - \endcode - - Now make sure the micro-SD card is not mounted: - - \code - umount /dev/XXX - \endcode + \include detect-sd-card-device-name.qdocinc instructions \section1 Installing the \B2Q Image @@ -414,9 +394,6 @@ \endcode \endlist - \warning \b{Make very sure you select the right device. Selecting the wrong - one can result in a wiped hard drive}. - After the image has been deployed, power up the device and confirm that it shows a \B2Q welcome screen and/or demo. @@ -454,27 +431,7 @@ For \B2QA, a micro-SD card of at least 4GB capacity is needed. - Plug the micro-SD card/reader into the development host PC and use - the following command to find out its device path - (i.e. \c{/dev/XXX}, where \c{XXX} typically is \c{sdb}): - - \code - df -h - \endcode - - Alternatively, if the micro-SD card is unformatted, run the following - command immediately after inserting the card to see its device - path: - - \code - dmesg | tail - \endcode - - Next, make sure the micro-SD card is not mounted: - - \code - umount /dev/XXX - \endcode + \include detect-sd-card-device-name.qdocinc instructions \section1 Installing the Android image @@ -500,12 +457,6 @@ \endcode \endlist - Make sure to replace the device path (\c{"/dev/XXX"}) with your micro-SD - card's device path that was found in the previous step. - - \warning \b{Make very sure you select the right device. Selecting the wrong - one can result in a wiped hard drive.} - \section1 Installing the \B2QA Image Make sure you have the required tools installed in your development machine: @@ -521,9 +472,6 @@ Boot2Qt-1.0/iMX6-eAndroid/images/deploy.sh /dev/XXX \endcode - \warning \b{Make very sure you select the right device. Selecting the wrong - one can result in a wiped hard drive}. - After the installation is complete, power up the device and confirm that it shows a \B2Q welcome screen and/or demo. @@ -561,27 +509,7 @@ For \B2QL, a card of at least 512MB capacity is sufficient. - Plug the micro-SD card/reader into the development host PC and use - the following command to find out its device path - (i.e. \c{/dev/XXX}, where \c{XXX} typically is \c{sdb}): - - \code - df -h - \endcode - - Alternatively, if the micro-SD card is unformatted, run the following - command immediately after inserting the card to see its device - path: - - \code - dmesg | tail - \endcode - - Now make sure the micro-SD card is not mounted: - - \code - umount /dev/XXX - \endcode + \include detect-sd-card-device-name.qdocinc instructions \section1 Installing the \B2Q Image @@ -592,9 +520,6 @@ sudo Boot2Qt-1.0/raspberrypi-eLinux/images/deploy.sh /dev/XXX \endcode - \warning \b{Make very sure you select the right device. Selecting the wrong - one can result in a wiped hard drive}. - After the image has been deployed, power up the device and confirm that it shows a \B2Q welcome screen and/or demo. diff --git a/src/doc/src/detect-sd-card-device-name.qdocinc b/src/doc/src/detect-sd-card-device-name.qdocinc new file mode 100644 index 0000000..825be80 --- /dev/null +++ b/src/doc/src/detect-sd-card-device-name.qdocinc @@ -0,0 +1,27 @@ +/*! +//! [instructions] + Plug the micro-SD card or reader into the development host PC, + and use the following command to find out its device name: + + \code + lsblk -d + \endcode + + Removable devices such as SD cards have a value '1' in + the \e RM column. + + \warning \b{Make very sure you select the right device. Selecting + the wrong one can result in a wiped hard drive}. + + Typical device names for SD cards include \c {sdb} and + \c {mmcblk0}. The full device path is \c {/dev/} followed by + the name. Replace \b XXX with the device name in below + instructions. + + Now make sure the micro-SD card is not mounted: + + \code + umount /dev/XXX + \endcode +//! [instructions] +*/ |