feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: use \uicontrol command instead of \gui macro

Browse Source 
Change-Id: Idc898b6ac70b6d3186d353086b5f3e45830d1f83
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
This commit is contained in:
Leena Miettinen
2014-12-11 15:43:19 +01:00
committed by Leena Miettinen
parent c9696aa6f4
commit e1fbeedcd4
97 changed files with 1955 additions and 1876 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
doc/src/linux-mobile/creator-deployment-embedded-linux.qdoc
View File

@@ -33,14 +33,14 @@
You can specify settings for deploying applications to generic Linux devices
in the project .pro file.
You can view the settings in the
\gui {Run Settings}.
\uicontrol {Run Settings}.
\image qtcreator-embedded-linux-deployment-overview.png "Deploy to device"
The files to be installed are listed in the \gui {Deployment} step,
the \gui {Files to deploy} field. The \gui {Local File Path}
The files to be installed are listed in the \uicontrol {Deployment} step,
the \uicontrol {Files to deploy} field. The \uicontrol {Local File Path}
field displays the location of the file on the development PC. The
\gui {Remote Directory} field displays the folder where the file is
\uicontrol {Remote Directory} field displays the folder where the file is
installed on the device. Text in red color indicates that the information is
missing. Edit the qmake \l{Variables#installs}
{INSTALLS variable} in the project .pro file to add the missing files.
@@ -63,15 +63,15 @@
\image qtcreator-embedded-linux-deployment-details.png "Deploy to embedded Linux"
When you run the application on the \gui {Embedded Linux} device,
When you run the application on the \uicontrol {Embedded Linux} device,
\QC deploys the application as specified by the deploy steps. By default,
\QC copies the application files to the device by using the SSH file
transfer protocol (SFTP), as specified by the \gui {Upload files via SFTP}
transfer protocol (SFTP), as specified by the \uicontrol {Upload files via SFTP}
step.
If you have a lot of data to copy, select \gui Details in the
\gui {Upload Files via SFTP} step, and then select the
\gui {Incremental deployment} check box. \QC takes note of the deployment
If you have a lot of data to copy, select \uicontrol Details in the
\uicontrol {Upload Files via SFTP} step, and then select the
\uicontrol {Incremental deployment} check box. \QC takes note of the deployment
time and only copies files that have changed since the last deployment.
However, when you make major changes on the device, such as removing files
from the device manually or flashing a new disk image, or when you use
@@ -79,12 +79,12 @@
have \QC deploy all files again.
To only create a tarball and not copy the files to the device, select
\gui {Add Deploy Step > Create tarball}. Then remove all other deploy steps.
\uicontrol {Add Deploy Step > Create tarball}. Then remove all other deploy steps.
The \gui {Deploy tarball via SFTP upload} step specifies that \QC
The \uicontrol {Deploy tarball via SFTP upload} step specifies that \QC
uploads the tarball to the device and extracts it.
The \gui {Check for free disk space} step is by default the first deploy step.
The \uicontrol {Check for free disk space} step is by default the first deploy step.
Use it to find out whether the remote file system has enough space left to deploy your project.
Errors due to lack of disk space can otherwise be hard to detect.

6
doc/src/linux-mobile/creator-projects-running-generic-linux.qdocinc
View File

@@ -7,7 +7,7 @@
\li Specify a connection to the device. For more information, see
\l{Connecting Embedded Linux Devices}.
\li Click the \gui Run button.
\li Click the \uicontrol Run button.
\endlist
@@ -17,9 +17,9 @@
\QC copies the application files to the connected device and runs the
application. The application views are
displayed on the device. Command-line output is visible in the \QC
\gui {Application Output} view.
\uicontrol {Application Output} view.
Choose \gui {Projects > Embedded Linux > Run} to view the settings for deploying
Choose \uicontrol {Projects > Embedded Linux > Run} to view the settings for deploying
the application to the connected device. For more information, see
\l{Specifying Run Settings for Linux-Based Devices}.

8
doc/src/linux-mobile/creator-projects-settings-run-linux.qdocinc
View File

@@ -3,7 +3,7 @@
To run and debug an application on a Linux-based device,
you must create connections from the development
host to the device and add the device configurations to
\l{glossary-buildandrun-kit}{kits}. Click \gui {Manage Kits} to add devices
\l{glossary-buildandrun-kit}{kits}. Click \uicontrol {Manage Kits} to add devices
to kits. For more information, see
\l {Connecting Embedded Linux Devices}.
@@ -12,10 +12,10 @@
The run settings display the path to the
executable file on the development host and on the device. To specify that
another application launches your application, for example, enter the
command in the \gui {Alternate executable on device} field and select the
\gui {Use this command instead} check box.
command in the \uicontrol {Alternate executable on device} field and select the
\uicontrol {Use this command instead} check box.
\image qtcreator-run-settings-linux.png "Run settings for Linux-based devices"
You can specify command line arguments to pass to your application in the
\gui Arguments field.
\uicontrol Arguments field.

9
doc/src/linux-mobile/linuxdev-keys.qdocinc
View File

@@ -10,17 +10,18 @@
\list 1
\li Select \gui Tools > \gui Options > \gui Devices > \gui {Create New}.
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Devices
> \uicontrol {Create New}.
\image qtcreator-ssh-key-configuration.png "SSH Key Configuration dialog"
\li In the \gui {Private key file} field, select the location to save
\li In the \uicontrol {Private key file} field, select the location to save
the private key.
The \gui {Public key file} field displays the location to save the
The \uicontrol {Public key file} field displays the location to save the
corresponding public key.
\li Select \gui {Generate And Save Key Pair} to generate and save the
\li Select \uicontrol {Generate And Save Key Pair} to generate and save the
keys at the specified locations.
\endlist

9
doc/src/linux-mobile/linuxdev-processes.qdocinc
View File

@@ -1,12 +1,13 @@
\section2 Managing Device Processes
You can view processes running on devices and kill them. Select
\gui Tools > \gui Options > \gui Devices > \gui {Remote Processes}.
\uicontrol Tools > \uicontrol Options > \uicontrol Devices >
\uicontrol {Remote Processes}.
You can filter the processes by name in the \gui {List of Processes}
You can filter the processes by name in the \uicontrol {List of Processes}
dialog.
To update the process list, select \gui {Update List}.
To update the process list, select \uicontrol {Update List}.
To kill a process, select it in the list, and then select \gui {Kill
To kill a process, select it in the list, and then select \uicontrol {Kill
Process}.

36
doc/src/linux-mobile/linuxdev.qdoc
View File

@@ -31,14 +31,14 @@
If you have a tool chain for building applications for embedded Linux
devices installed on the development PC, you can add
it to \QC. You can then select a \l{glossary-buildandrun-kit}{kit}
with \gui {Embedded Linux} device type to
with \uicontrol {Embedded Linux} device type to
build and run applications on embedded Linux devices.
To be able to run and debug applications on embedded Linux devices, you must
add devices and select them in the \QC \l{glossary-buildandrun-kit}{kit}.
You use a wizard to create the connections. You can edit the settings later
in \gui Tools > \gui Options > \gui Devices.
in \uicontrol Tools > \uicontrol Options > \uicontrol Devices.
\image qtcreator-linux-device-configurations.png "Devices dialog"
@@ -53,11 +53,11 @@
\li Make sure that your device can be reached via an IP address.
\li Select \gui {Tools > Options > Build & Run > Qt Versions > Add} to
\li Select \uicontrol {Tools > Options > Build & Run > Qt Versions > Add} to
add the Qt version
for the embedded Linux.
\li Select \gui {Tools > Options > Build & Run > Compilers > Add} to
\li Select \uicontrol {Tools > Options > Build & Run > Compilers > Add} to
add the compiler
for building the applications.
@@ -66,30 +66,31 @@
\list 1
\li Select \gui Tools > \gui Options > \gui Devices > \gui Add
> \gui {Generic Linux Device} > \gui {Start Wizard}.
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Devices
> \uicontrol Add > \uicontrol {Generic Linux Device}
> \uicontrol {Start Wizard}.
\image qtcreator-screenshot-devconf-linux.png "Connection Data wizard"
\li In the \gui {The name to identify this configuration} field,
\li In the \uicontrol {The name to identify this configuration} field,
enter a name for the connection.
\li In the \gui {The device's host name or IP address} field,
\li In the \uicontrol {The device's host name or IP address} field,
enter the host name or IP address of the device.
This value will be available in the variable \c %{CurrentDevice:HostAddress}.
\li In the \gui {The username to log into the device} field,
\li In the \uicontrol {The username to log into the device} field,
enter the username to log into the device and run the
application as.
This value will be available in the variable \c %{CurrentDevice:UserName}.
\li In the \gui {The authentication type} field, select whether
to use \gui Password or \gui Key authentication, and enter
\li In the \uicontrol {The authentication type} field, select whether
to use \uicontrol Password or \uicontrol Key authentication, and enter
the user's password or the file that contains the user's
private key.
The latter will be available in the variable \c %{CurrentDevice:PrivateKeyFile}.
\li Click \gui {Next} to create the connection.
\li Click \uicontrol {Next} to create the connection.
\endlist
@@ -98,10 +99,11 @@
the SSH port number, which is available in the variable \c %{CurrentDevice:SshPort}.
\li Select \gui Tools > \gui Options > \gui {Build & Run} > \gui Kits
> \gui Add to add a kit for building for the device. Select the
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run}
> \uicontrol Kits > \uicontrol Add to add a kit for building for the device.
Select the
Qt version, compiler, and device that you added above, and choose
\gui {Generic Linux Device} for the device type.
\uicontrol {Generic Linux Device} for the device type.
\li To specify build settings:
@@ -110,12 +112,12 @@
\li Open a project for an application you want to develop for the
device.
\li Select \gui Projects > \gui {Build & Run} > \gui {Add Kit} to
\li Select \uicontrol Projects > \uicontrol {Build & Run} > \uicontrol {Add Kit} to
add the kit that you specified above.
\endlist
\li Select \gui Run to specify run settings.
\li Select \uicontrol Run to specify run settings.
\image qtcreator-run-settings-linux-devices.png "Run settings for embedded Linux devices"