summaryrefslogtreecommitdiffstats
path: root/src/doc/src/shared/detect-sd-card-device-name.qdocinc
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2014-06-30 11:37:43 +0200
committerTopi Reiniƶ <topi.reinio@digia.com>2014-08-29 10:52:44 +0300
commit5bbd7f92e895d63439165fd0d3dfd5ee80bd6d7b (patch)
tree8ae9a2bf9f20cd353245a40e37fe6801fe0cff14 /src/doc/src/shared/detect-sd-card-device-name.qdocinc
parent5a3e8d73b675a90cd6c48b94c0b226148857fa9f (diff)
Doc: split up the docs into multiple files
Split up the monolithic b2qt.qdoc into separate documentation files, making future edits and maintenance easier. Device-specific instructions are created in devices/ subdirectory, and shared documentation (referenced in multiple places) are moved to shared/. Change-Id: I9425297781a1dda9c08a149b0870a0389c575560 Reviewed-by: Samuli Piippo <samuli.piippo@digia.com> Reviewed-by: Kalle Viironen <kalle.viironen@digia.com>
Diffstat (limited to 'src/doc/src/shared/detect-sd-card-device-name.qdocinc')
-rw-r--r--src/doc/src/shared/detect-sd-card-device-name.qdocinc45
1 files changed, 45 insertions, 0 deletions
diff --git a/src/doc/src/shared/detect-sd-card-device-name.qdocinc b/src/doc/src/shared/detect-sd-card-device-name.qdocinc
new file mode 100644
index 0000000..b74947d
--- /dev/null
+++ b/src/doc/src/shared/detect-sd-card-device-name.qdocinc
@@ -0,0 +1,45 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc
+** All rights reserved.
+** For any questions to Digia, please use the contact form at
+** http://qt.digia.com/
+**
+** This file is part of Qt Enterprise Embedded.
+**
+** Licensees holding valid Qt Enterprise licenses may use this file in
+** accordance with the Qt Enterprise License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.
+**
+** If you have questions regarding the use of this file, please use
+** the contact form at http://qt.digia.com/
+**
+****************************************************************************/
+/*!
+//! [instructions]
+ Plug in the SD card or reader to the development host,
+ and use the following command to find out its device name:
+
+ \badcode
+ lsblk -d
+ \endcode
+
+ Removable devices such as SD cards have the value '1' in
+ the \e RM column.
+
+ \warning Make sure to select the correct device, because 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.
+//! [instructions]
+
+//! [unmount]
+ \badcode
+ umount /dev/<device_name>
+ \endcode
+//! [unmount]
+
+*/