aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2022-02-23 17:22:02 +0100
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2022-02-25 08:54:18 +0000
commitace0a0d9d10d3c9df23c05a4a55785bb26161879 (patch)
treeb1b6b4cfc17585a57756fce5bf99abdddae279ef /doc
parentb178e407a4da94f632fd0ebeb2d194f6012b73ba (diff)
Doc: Add CLI options
Make the wording and capitalization of existing docs more consistent. Task-number: QTCREATORBUG-26610 Change-Id: If241a951ce4df757a1b26524dee412ef44bbfa4e Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Christian Stenger <christian.stenger@qt.io> Reviewed-by: Orgad Shaneh <orgads@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/qtcreator/src/howto/creator-only/creator-cli.qdoc40
1 files changed, 33 insertions, 7 deletions
diff --git a/doc/qtcreator/src/howto/creator-only/creator-cli.qdoc b/doc/qtcreator/src/howto/creator-only/creator-cli.qdoc
index f8356b86d5..3fd118a9a5 100644
--- a/doc/qtcreator/src/howto/creator-only/creator-cli.qdoc
+++ b/doc/qtcreator/src/howto/creator-only/creator-cli.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2018 The Qt Company Ltd.
+** Copyright (C) 2022 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
@@ -114,6 +114,10 @@
command line until the first editor is closed.
\row
+ \li -nocrashcheck
+ \li Disable the startup check for a previously crashed \QC instance.
+
+ \row
\li -load <plugin>
\li Enable the specified plugin and all plugins that it depends on.
You can combine \c -load and \c -noload options and specify both
@@ -122,7 +126,7 @@
\row
\li -load all
- \li Enables all plugins.
+ \li Enable all plugins.
\row
\li -noload <plugin>
@@ -130,11 +134,11 @@
\row
\li -noload all
- \li Disables all plugins.
+ \li Disable all plugins.
\row
\li -profile
- \li Output plugin start up and shut down profiling data.
+ \li Output profiling data about plugin startup and shutdown.
\row
\li -pluginpath <path>
@@ -151,10 +155,28 @@
(for example written by the installer).
\row
- \li -temporarycleansettings
+ \li -temporarycleansettings, -tcs
\li Use clean settings for debug or testing reasons. The settings
will be deleted when \QC exits.
+ \row
+ \li -test <plugin>[,testfunction[:testdata]] ...
+ \li For \QC plugin developers: run the plugin's tests using a
+ separate settings path by default.
+
+ \row
+ \li -test all
+ \li For \QC plugin developers: run tests from all plugins.
+
+ \row
+ \li -notest <plugin>
+ \li For \QC plugin developers: exclude all of the plugin's
+ tests from the test run.
+
+ \row
+ \li -scenario <scenarioname>
+ \li For \QC plugin developers: run the specified scenario.
+
\row
\li -color <color>
\li Core plugin: override the selected UI color.
@@ -171,7 +193,7 @@
\row
\li -notour
- \li Welcome plugin: Skip the UI tour on startup.
+ \li Welcome plugin: skip the UI tour on startup.
\row
\li -debug <pid>
@@ -208,10 +230,14 @@
\row
\li -wincrashevent <event-handle:pid>
- \li Debugger plugin: Attach to crashed processes by using the
+ \li Debugger plugin: attach to crashed processes by using the
specified event handle and process ID.
\row
+ \li -git-show <git commit hash>
+ \li Git plugin: show the specified commit hash.
+
+ \row
\li -customwizard-verbose
\li ProjectExplorer plugin: display additional information when
loading custom wizards. For more information about custom