From 5bbd7f92e895d63439165fd0d3dfd5ee80bd6d7b Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Mon, 30 Jun 2014 11:37:43 +0200 Subject: 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 Reviewed-by: Kalle Viironen --- src/doc/src/shared/b2qt-external-pages.qdoc | 63 ++++++++++ src/doc/src/shared/b2qt-post-install-setup.qdocinc | 132 +++++++++++++++++++++ .../src/shared/detect-sd-card-device-name.qdocinc | 45 +++++++ 3 files changed, 240 insertions(+) create mode 100644 src/doc/src/shared/b2qt-external-pages.qdoc create mode 100644 src/doc/src/shared/b2qt-post-install-setup.qdocinc create mode 100644 src/doc/src/shared/detect-sd-card-device-name.qdocinc (limited to 'src/doc/src/shared') diff --git a/src/doc/src/shared/b2qt-external-pages.qdoc b/src/doc/src/shared/b2qt-external-pages.qdoc new file mode 100644 index 0000000..d642fa2 --- /dev/null +++ b/src/doc/src/shared/b2qt-external-pages.qdoc @@ -0,0 +1,63 @@ +/**************************************************************************** +** +** 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/ +** +****************************************************************************/ + +/*! + \externalpage http://qt.digia.com/Product/Qt-Enterprise-Embedded/Supported-Modules-and-Known-Issues/ + \title Known Issues +*/ + +/*! + \externalpage http://qt.digia.com/Product/Qt-Enterprise-Embedded/ + \title product page +*/ + +/*! + \externalpage https://qtcloudservices.com/products/enginio-data-storage/ + \title Enginio Data Storage +*/ + +/*! + \externalpage http://qt.digia.com/Product/Qt-Enterprise/Advanced-Data-Visualization/ + \title Qt Data Visualization +*/ + +/*! + \externalpage http://qt.digia.com/Product/Qt-Enterprise/Qt-Quick-Enterprise-Controls/ + \title Qt Quick Enterprise Controls +*/ + +/*! + \externalpage http://qt.digia.com/Product/Qt-Enterprise/Qt-Virtual-Keyboard/ + \title Qt Virtual Keyboard +*/ + +/*! + \externalpage http://qt.digia.com/Product/Qt-Enterprise/Charts/ + \title Qt Charts +*/ + +/*! + \externalpage http://qt.digia.com/Product/Qt-Enterprise/Qt-Quick-Compiler/ + \title Qt Quick Compiler +*/ + +/*! + \externalpage https://www.yoctoproject.org/ + \title Yocto Project +*/ diff --git a/src/doc/src/shared/b2qt-post-install-setup.qdocinc b/src/doc/src/shared/b2qt-post-install-setup.qdocinc new file mode 100644 index 0000000..0bd96dd --- /dev/null +++ b/src/doc/src/shared/b2qt-post-install-setup.qdocinc @@ -0,0 +1,132 @@ +/**************************************************************************** +** +** 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/ +** +****************************************************************************/ +/*! +//! [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. + + \li On \B2QA, you can confirm that the connection is working by running + the following shell command: + + \code + /Tools/b2qt/adb devices + \endcode + + The output should be a list of connected 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}. + \endlist + + The system log files \c{/var/log/udev} and \c{/var/log/syslog} may + provide relevant information in case of connection problems. +//! [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] + +//! [android steps for dev kit] + \list 1 + \li Select \b{Tools > Options > Build & Run > Kits}. + \li Select the kit with the correct Android version + (for example, \e {generic-4.2}). + \li Select the correct device in the \b{Device} field. + \li Select \b{OK}. + \endlist + + If you have more than one development device that use the same Android + version, clone the \e generic kit and rename it after the physical device: + + \list 1 + \li Select the generic Android kit and then \b Clone. + \li Select the correct device in the \b{Device} field. + \li Edit the name of the cloned kit and press \b OK. + \endlist +//! [android steps for dev 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. 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 android] + \include b2qt-post-install-setup.qdocinc common config device kit + \include b2qt-post-install-setup.qdocinc android steps for dev kit +//! [configuring device kit android] + +//! [configuring device kit android linux] + \include b2qt-post-install-setup.qdocinc common config device kit + \list + \li \b{\B2QL} + \include b2qt-post-install-setup.qdocinc steps for device kit + \li \b{\B2QA} + \include b2qt-post-install-setup.qdocinc android steps for dev kit + \endlist +//! [configuring device kit android linux] +*/ 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/ + \endcode +//! [unmount] + +*/ -- cgit v1.2.3