summaryrefslogtreecommitdiffstats
path: root/src/doc/src/detect-sd-card-device-name.qdocinc
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2013-10-11 11:56:52 +0200
committerTopi Reiniƶ <topi.reinio@digia.com>2013-10-15 14:35:10 +0300
commite7724d5a213aa0bb6c4d50a9f9fc7cab2f6cb3cd (patch)
tree7fbcb2e8d5755aeda2ae0909a80c5dcb05bb6e40 /src/doc/src/detect-sd-card-device-name.qdocinc
parent395e7ff2a25216988b43aa310261b0e4204e1b7c (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/src/detect-sd-card-device-name.qdocinc')
-rw-r--r--src/doc/src/detect-sd-card-device-name.qdocinc27
1 files changed, 27 insertions, 0 deletions
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]
+*/