diff options
author | Topi Reinio <topi.reinio@theqtcompany.com> | 2016-08-30 10:52:27 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@theqtcompany.com> | 2016-09-01 08:02:31 +0000 |
commit | eebda51556daae681e9ddb878c36f79e497f5618 (patch) | |
tree | cdea68759f5ca59fee027b9ce75ad92d7825fe54 /src/doc/src/shared | |
parent | f10a492c8711d881da99554ca9a9fcd988080d3a (diff) |
Doc: Remove generic Device Creation documentation
... and replace the documentation configuration with a one specific
to Boot to Qt Utils. The removed documentation is available in a
dedicated repository, tqtc-boot2qt/doc.
The name of this module in 5.6 branch will be 'Qt for Device
Creation: Add-On Modules'.
The doc namespace and config files already reflect the name
'Qt Device Utilities', but that is not visible to the user in
5.6 (but will be in 5.7).
Change-Id: Ib5a98d57b6ff5e7c29901f42697266f396abad82
Reviewed-by: Samuli Piippo <samuli.piippo@qt.io>
Diffstat (limited to 'src/doc/src/shared')
-rw-r--r-- | src/doc/src/shared/b2qt-external-pages.qdoc | 82 | ||||
-rw-r--r-- | src/doc/src/shared/b2qt-post-install-setup.qdocinc | 109 | ||||
-rw-r--r-- | src/doc/src/shared/common.qdocinc | 44 | ||||
-rw-r--r-- | src/doc/src/shared/detect-sd-card-device-name.qdocinc | 51 |
4 files changed, 0 insertions, 286 deletions
diff --git a/src/doc/src/shared/b2qt-external-pages.qdoc b/src/doc/src/shared/b2qt-external-pages.qdoc deleted file mode 100644 index 08628c6..0000000 --- a/src/doc/src/shared/b2qt-external-pages.qdoc +++ /dev/null @@ -1,82 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2014 Digia Plc -** All rights reserved. -** For any questions to Digia, please use the contact form at -** http://www.qt.io -** -** 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://www.qt.io -** -****************************************************************************/ - -/*! - \externalpage http://doc.qt.io/ - \title Qt reference documentation -*/ -/*! - \externalpage http://doc.qt.io/qt-5/licensing.html#licenses-used-in-qt - \title Licenses Used by Qt -*/ - -/*! - \externalpage http://doc.qt.io/qt-5/android-support.html - \title Qt for Android -*/ - -/*! - \externalpage http://www.qt.io/qt-for-device-creation/ - \title product page -*/ - -/*! - \externalpage https://qtcloudservices.com/products/enginio-data-storage/ - \title Enginio Data Storage -*/ - -/*! - \externalpage http://doc.qt.io/QtDataVisualization - \title Qt Data Visualization -*/ - -/*! - \externalpage http://doc.qt.io/QtQuickEnterpriseControls - \title Qt Quick Enterprise Controls -*/ - -/*! - \externalpage http://doc.qt.io/QtVirtualKeyboard - \title Qt Virtual Keyboard -*/ - -/*! - \externalpage http://doc.qt.io/QtCharts - \title Qt Charts -*/ - -/*! - \externalpage http://doc.qt.io/QtQuickCompiler - \title Qt Quick Compiler -*/ - -/*! - \externalpage https://www.yoctoproject.org/ - \title Yocto Project -*/ - -/*! - \externalpage http://blog.qt.digia.com/blog/2014/07/04/making-an-android-device-boot-to-qt/ - \title Android Injection -*/ - -/*! - \externalpage http://doc.qt.io/QtQuick2DRenderer - \title Qt Quick 2D Renderer -*/ diff --git a/src/doc/src/shared/b2qt-post-install-setup.qdocinc b/src/doc/src/shared/b2qt-post-install-setup.qdocinc deleted file mode 100644 index 900b336..0000000 --- a/src/doc/src/shared/b2qt-post-install-setup.qdocinc +++ /dev/null @@ -1,109 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2014 Digia Plc -** All rights reserved. -** For any questions to Digia, please use the contact form at -** http://www.qt.io -** -** 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://www.qt.io -** -****************************************************************************/ -/*! -//! [setting up usb access] - On Ubuntu Linux, the development user account must have access to plugged in - devices. To allow the development user access to the device via USB, create - a new \e{udev} rule: - - \list 1 - - \li Run the following command in a shell: - - \badcode - echo 'SUBSYSTEM=="usb", ATTRS{idVendor}=="18d1", TAG+="udev-acl", TAG+="uaccess"' | sudo tee -a /etc/udev/rules.d/70-boot2qt.rules - \endcode - - \li Connect the running device to the development host with a USB - cable. If the device is already connected, disconnect and reconnect the USB - cable after running the command above. - \endlist - - The system log files \c{/var/log/udev} and \c{/var/log/syslog} may - provide relevant information in case of connection problems. - - You can confirm that the connection is working by running the following command on Linux: - - \code - <INSTALL_DIR>/Tools/b2qt/adb devices -l - \endcode - - Or the following command on Windows: - - \code - <Android-SDK-Tools-install-dir>\platform-tools\adb.exe devices -l - \endcode - - The output should be a list of connected \B2Q (and Android) devices, - identified with a serial number and a name. If your device is missing from - the list, or the serial number is \c{??????}, the connection is - not working properly. Check that the device is powered on, and disconnect - and reconnect the USB cable. - - The emulator may be listed as well. Its serial number is its IP and the port - number: \c{192.168.56.101:5555}. - -//! [setting up usb access] - -//! [configuring device kit] -//! [common config device kit] - After you have prepared the hardware, you must perform one final step - to set up the development tools in Qt Creator for your device. That is, - you must configure the correct device to be used for each build and run - \e{kit}. Connect your device to the development host via USB and launch - Qt Creator. In Qt Creator: - -//! [common config device kit] -//! [steps for device kit] - \list 1 - \li Select \b{Tools > Options > Build & Run > Kits}. - \li Select one of the predefined kits starting with \e{Boot to Qt...} - that matches the type of your device. - \li Select the correct device in the \b{Device} field. - \li Select \b{OK}. - \endlist -//! [steps for device kit] -//! [configuring device kit] - -//! [configuring network device] - After you have prepared the hardware, you must set up the development tools - in Qt Creator for your device. Connect your device to the network via an - Ethernet cable and launch Qt Creator. In Qt Creator: - - \list 1 - \li Select \b{Tools > Options > Devices > Add}. - \li Select \b{Boot2Qt Device} > \b{Start Wizard}. - \li Enter the device name and network address (IPv4). You can check the - device address in the \e{Launcher Settings} when the device is running - the \B2Q demo. - \li Select \b{Finish}. - \endlist - - You also have to configure the correct device to be used for each build and - run \e{kit}: - - \include b2qt-post-install-setup.qdocinc steps for device kit - -//! [configuring network device] - -//! [configuring device kit linux] - \include b2qt-post-install-setup.qdocinc common config device kit - \include b2qt-post-install-setup.qdocinc steps for device kit -//! [configuring device kit linux] -*/ diff --git a/src/doc/src/shared/common.qdocinc b/src/doc/src/shared/common.qdocinc deleted file mode 100644 index 6d6d18e..0000000 --- a/src/doc/src/shared/common.qdocinc +++ /dev/null @@ -1,44 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2014 Digia Plc -** All rights reserved. -** For any questions to Digia, please use the contact form at -** http://www.qt.io -** -** 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://www.qt.io -** -****************************************************************************/ -/*! -//! [overview-list] - \list - \li Qt development libraries and core tools - \li Additional embedded libraries and value-add components - \li Embedded development environment around Qt Creator IDE - \li \B2Q, a light-weight software stack for embedded systems - \li Build-Your-Own-Stack tooling for customizing the Boot to Qt stack - \li Device emulator for software development and testing without - target hardware - \endlist -//! [overview-list] - -//! [wizard] - \b {Install Using the Flashing Wizard} - - \SDK includes an easy to use application for setting up a supported - device for \B2Q. In Qt Creator, select \b Tools > \b {Flash \B2Q Device} - and follow the step-by-step instructions. - - On Linux, you can alternatively install the image from the command line using - the instructions below. - - \b {Install from the Command Line} -//! [wizard] -*/ diff --git a/src/doc/src/shared/detect-sd-card-device-name.qdocinc b/src/doc/src/shared/detect-sd-card-device-name.qdocinc deleted file mode 100644 index d934c60..0000000 --- a/src/doc/src/shared/detect-sd-card-device-name.qdocinc +++ /dev/null @@ -1,51 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2014 Digia Plc -** All rights reserved. -** For any questions to Digia, please use the contact form at -** http://www.qt.io -** -** 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://www.qt.io -** -****************************************************************************/ -/*! -//! [instructions] - Plug in the SD card or reader to the development host, - and use the following command on Linux 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. - - Typical device names for SD cards include \c {sdb} and - \c {mmcblk0}. The full device path is \c {/dev/} followed by - the name. - - On Windows, use the following command to get the SD cards device name: - \badcode - wmic logicaldisk where "drivetype=2 and access=0" get deviceid, volumename - \endcode - - \warning Make sure to select the correct device, because selecting - the wrong one can result in a wiped hard drive. - -//! [instructions] - -//! [unmount] - \badcode - umount /dev/<device_name> - \endcode -//! [unmount] - -*/ |