summaryrefslogtreecommitdiffstats
path: root/src/doc/src/detect-sd-card-device-name.qdocinc
diff options
context:
space:
mode:
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]
+*/