From ace0a0d9d10d3c9df23c05a4a55785bb26161879 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Wed, 23 Feb 2022 17:22:02 +0100 Subject: [PATCH] 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 Reviewed-by: Christian Stenger Reviewed-by: Orgad Shaneh --- .../src/howto/creator-only/creator-cli.qdoc | 40 +++++++++++++++---- 1 file 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 f8356b86d5b..3fd118a9a5b 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. @@ -113,6 +113,10 @@ \li Open files in editors in a running \QC instance and block the 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 \li Enable the specified plugin and all plugins that it depends on. @@ -122,7 +126,7 @@ \row \li -load all - \li Enables all plugins. + \li Enable all plugins. \row \li -noload @@ -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 @@ -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 [,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 + \li For \QC plugin developers: exclude all of the plugin's + tests from the test run. + + \row + \li -scenario + \li For \QC plugin developers: run the specified scenario. + \row \li -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 @@ -208,9 +230,13 @@ \row \li -wincrashevent - \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 + \li Git plugin: show the specified commit hash. + \row \li -customwizard-verbose \li ProjectExplorer plugin: display additional information when