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

Doc: Describe version control system preferences

Browse Source 
Task-number: QTCREATORBUG-28721
Change-Id: Ib4d1899885012af5eac176fd53e5536f69a2689b
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
This commit is contained in:
Leena Miettinen
2023-03-13 17:47:43 +01:00
parent d612581667
commit 81bc007ddd
20 changed files with 165 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
doc/qtcreator/src/vcs/creator-only/creator-vcs-bazaar.qdoc
View File

@@ -1,4 +1,4 @@
// Copyright (C) 2018 The Qt Company Ltd.
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
// **********************************************************************
@@ -40,4 +40,22 @@
\uicontrol Uncommit leaves the working tree ready for a new commit. The only
change it might make is restoring pending merges that were present before
the commit.
\section1 Bazaar Preferences
To set Bazaar preferences, select \uicontrol Edit > \uicontrol Preferences >
\uicontrol {Version Control} > \uicontrol Bazaar:
\image qtcreator-preferences-vcs-bazaar.webp {Bazaar preferences}
\list
\li \uicontrol Command specifies the path to the command line client
executable.
\li \uicontrol {Default username} and \uicontrol {Default email}
specify the username and email address to use by default when
committing changes.
\li \uicontrol {Log count} sets the maximum number of lines the log can
have.
\li \uicontrol Timeout sets a timeout for version control operations.
\endlist
*/

27
doc/qtcreator/src/vcs/creator-only/creator-vcs-clearcase.qdoc
View File

@@ -1,4 +1,4 @@
// Copyright (C) 2018 The Qt Company Ltd.
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
// **********************************************************************
@@ -15,9 +15,8 @@
\title Using ClearCase
IBM Rational ClearCase is a version control, workspace management, parallel
development support, and build automation solution developed by IBM. The
ClearCase client plugin is available on Linux and Windows for accessing a
ClearCase server.
development support, and build automation solution developed by IBM. Use the
ClearCase client plugin on Linux and Windows to access a ClearCase server.
\section1 Using GNU Diffutils with ClearCase
@@ -32,8 +31,10 @@
\li Select \uicontrol Edit > \uicontrol Preferences >
\uicontrol {Version Control} > \uicontrol ClearCase.
\image qtcreator-preferences-vcs-clearcase.webp {ClearCase preferences}
\li Select the \uicontrol External radio button. The radio button is
disabled if \c diff is not found in the PATH.
disabled if \c diff is not in the PATH.
\li In the \uicontrol Arguments field, specify arguments for running
\c diff.
@@ -51,12 +52,10 @@
a UCM activity. By default, the activities are automatically assigned names.
To disable this functionality, select \uicontrol Edit > \uicontrol Preferences
> \uicontrol {Version Control} > \uicontrol ClearCase, and then deselect the
\uicontrol {Automatically assign activity names} check box.
\uicontrol {Auto assign activity names} check box.
To automatically check out files when you edit them, select \uicontrol Edit
> \uicontrol Preferences > \uicontrol {Version Control} > \uicontrol ClearCase,
and then select the \uicontrol {Automatically check out files on edit}
check box.
To automatically check out files when you edit them, select the
\uicontrol {Automatically check out files on edit} check box.
To cancel the checkout for a file and delete the checked-out version,
select \uicontrol Tools > \uicontrol ClearCase >
@@ -68,12 +67,12 @@
To create a permanent new version of the current file or all files in the
versioned object base (VOB), select \uicontrol Tools >
\uicontrol {ClearCase} > \uicontrol {Check In}. To be asked to confirm
\uicontrol {ClearCase} > \uicontrol {Check In}. To confirm
that you want to check in the files, select \uicontrol Edit >
\uicontrol Preferences > \uicontrol {Version Control} > \uicontrol ClearCase,
and then select the \uicontrol {Prompt on check-in} check box.
By default, you are asked to enter a comment when checking files out or in.
By default, you have to enter a comment when checking files out or in.
To suppress this prompt, select \uicontrol Edit > \uicontrol Preferences >
\uicontrol {Version Control} > \uicontrol ClearCase, and then select the
\uicontrol {Do not prompt for comment during checkout or check-in} check
@@ -89,4 +88,8 @@
> \uicontrol {Version Control} > \uicontrol ClearCase, and then select the
\uicontrol {Disable indexer} check box. To only have some VOBs indexed,
specify them in the \uicontrol {Index only VOBs} field.
Specify the number of event records to show in \uicontrol {History count}.
Set a timeout for version control operations in \uicontrol Timeout.
*/

26
doc/qtcreator/src/vcs/creator-only/creator-vcs-cvs.qdoc
View File

@@ -1,4 +1,4 @@
// Copyright (C) 2019 The Qt Company Ltd.
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
// **********************************************************************
@@ -29,18 +29,20 @@
To unedit files in the local directory, as well as recursively in all
subdirectories, select \uicontrol {Unedit Repository}.
To specify the CVS root directory, select \uicontrol Edit >
\uicontrol Preferences > \uicontrol {Version Control} > \uicontrol CVS, and then
specify the path to the directory in the \uicontrol {CVS root} field.
\section1 CVS Preferences
You can specify settings for viewing diff output in the
\uicontrol {Diff options} field.
To set CVS preferences, select \uicontrol Edit > \uicontrol Preferences >
\uicontrol {Version Control} > \uicontrol CVS:
By default, you are prompted to confirm that you want to submit changes.
To suppress the prompt, deselect the \uicontrol {Prompt on submit} check
box.
\image qtcreator-preferences-vcs-cvs.webp {CVS preferences}
By default, all files that belong to the commit are annotated. To disable
this feature, deselect the \uicontrol {Describe all files matching commit
id} check box.
\list
\li \uicontrol {CVS Command} specifies the path to the command line
client executable.
\li \uicontrol {CVS root} specifies the CVS root.
\li \uicontrol Timeout sets a timeout for version control operations.
\li \uicontrol {Diff options} sets preferences for viewing diff output.
\li \uicontrol {Describe all files matching commit id} annotates all
files that belong to the commit.
\endlist
*/

27
doc/qtcreator/src/vcs/creator-only/creator-vcs-fossil.qdoc
View File

@@ -29,6 +29,9 @@
\li Select \uicontrol Edit > \uicontrol Preferences >
\uicontrol {Version Control} > \uicontrol Fossil, and set the
designated directory in the \uicontrol {Default path} field.
\image qtcreator-preferences-vcs-fossil.webp {Fossil preferences}
\endlist
To create a local Fossil repository, select \uicontrol Tools >
@@ -62,4 +65,28 @@
\li \uicontrol Settings
\li Configure the settings of the local repository.
\endtable
\section1 Fossil Preferences
To set Fossil preferences, select \uicontrol Edit > \uicontrol Preferences >
\uicontrol {Version Control} > \uicontrol Fossil:
\list
\li \uicontrol Command specifies the path to the command line client
executable.
\li \uicontrol {Default path} sets the path to the directory to store
local repositories by default.
\li \uicontrol {Default user} specifies an existing user who becomes the
author of changes made to the repository.
\li \uicontrol {SSL/TLS identity} sets the SSL/TLS client identity key
to use for authentication if the server requests it.
\li \uicontrol {Log count} sets the maximum number of lines the log can
have.
\li \uicontrol {Log width} sets the width of log entry lines to 20 or
above. The value 0 shows a single line per entry.
\li \uicontrol {Timeout} sets a timeout for version control operations.
\li \uicontrol {Disable auto sync} disables automatic pull before
a commit or update and automatic push after a commit or tag or branch
creation.
\endlist
*/

19
doc/qtcreator/src/vcs/creator-only/creator-vcs-mercurial.qdoc
View File

@@ -42,4 +42,23 @@
\li \uicontrol{Push}
\li Push changes to the remote repository.
\endtable
\section1 Mercurial Preferences
To set preferences for Mercurial, select \uicontrol Edit >
\uicontrol Preferences > \uicontrol {Version Control} > \uicontrol Mercurial:
\image qtcreator-preferences-vcs-mercurial.webp {Mercurial preferences}
\list
\li \uicontrol Command specifies the path to the command line client
executable.
\li \uicontrol {Default username} and \uicontrol {Default email}
specify the username and email address to use by default when
committing changes.
\li \uicontrol {Log count} sets the maximum number of lines the log can
have.
\li \uicontrol Timeout sets a timeout for version control operations.
\endlist
*/

27
doc/qtcreator/src/vcs/creator-only/creator-vcs-options.qdocinc
View File

@@ -1,4 +1,4 @@
// Copyright (C) 2018 The Qt Company Ltd.
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -8,21 +8,14 @@
\section1 Setting Up Version Control Systems
\QC uses the version control system's command line clients to access your
repositories. To allow access, make sure that the command line clients can
be located using the \c{PATH} environment variable. Alternatively, specify
the path to the command line client executable in the \uicontrol Command
field in the version control system specific tab in \uicontrol Edit >
repositories. Make sure that the command line clients are in the \c{PATH}
environment variable, or specify the path to the command line client
executable in the version control system specific tab in \uicontrol Edit >
\uicontrol Preferences > \uicontrol {Version Control}.
If authentication is required to access the repository, enter the user
credentials in the \uicontrol Username and \uicontrol Password fields.
Enter a timeout for version control operations in the \uicontrol Timeout
field.
For some version control systems, you can specify the maximum number of
lines the log can have in the \uicontrol {Log count} field.
\image qtcreator-preferences-vcs-bazaar.webp {Bazaar preferences}
The other configuration options depend on the version control system.
After you set up the version control system, use the command line to check
that everything works (for example, use the status command). If no issues
arise, you should be ready to use the system also from \QC.
@@ -35,12 +28,14 @@
Select \uicontrol Edit > \uicontrol Preferences > \uicontrol {Version Control}
> \uicontrol General to specify settings for submit messages:
\image qtcreator-preferences-vcs-general.webp {General tab in Version Control preferences}
\list
\li \uicontrol{Wrap submit messages at} limits the line length of a
submit message to the specified number of characters.
\li \uicontrol{Submit message check script} is a script or program that
can be used to perform checks on the submit message before
submitting. The submit message is passed in as the script's first
performs checks on the submit message before
submitting. The submit message is the script's first
parameter. If there is an error, the script should output a
message on standard error and return a non-zero exit code.
\li \uicontrol{User/alias configuration file} is a text file that lists
@@ -73,7 +68,7 @@
For example, \c ssh-askpass or \c x11-ssh-askpass, depending on the
ssh-askpass implementation that you use.
\li \uicontrol {Reset VCS Cache} resets the version control system
configuration to a state known to \QC after it has been changed
configuration to a state known to \QC after you change it
from the command line, for example.
\endlist

22
doc/qtcreator/src/vcs/creator-only/creator-vcs-perforce.qdoc
View File

@@ -1,4 +1,4 @@
// Copyright (C) 2020 The Qt Company Ltd.
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
// **********************************************************************
@@ -29,9 +29,18 @@
\section1 Configuring Perforce
In the Perforce preferences, you can specify workspace details:
\uicontrol {P4 user}, \uicontrol {P4 client}, and \uicontrol {P4 port}. To
specify the details individually for several projects, use configuration
To set Perforce preferences, select \uicontrol Edit > \uicontrol Preferences
> \uicontrol {Version Control} > \uicontrol Perforce:
\image qtcreator-preferences-vcs-perforce.webp {Perforce preferences}
In \uicontrol {P4 command}, set the path to the command line client
executable.
Set workspace details in \uicontrol {P4 user}, \uicontrol {P4 client}, and
\uicontrol {P4 port}.
To specify the details individually for several projects, use configuration
files instead. Create a \c {p4config.txt} configuration file for each
project in the top level project directory, and run
\c{p4 set P4CONFIG=p4config.txt} once. You must deselect the
@@ -56,9 +65,4 @@
To view information about change lists and the files in them, select
\uicontrol Tools > \uicontrol Perforce > \uicontrol Describe.
By default, you must confirm that you want to submit changes. To suppress
the confirmation prompt, select \uicontrol Edit > \uicontrol Preferences >
\uicontrol {Version Control} > \uicontrol Perforce, and then deselect the
\uicontrol {Prompt on submit} check box.
*/

31
doc/qtcreator/src/vcs/creator-only/creator-vcs-subversion.qdoc
View File

@@ -1,4 +1,4 @@
// Copyright (C) 2019 The Qt Company Ltd.
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
// **********************************************************************
@@ -21,14 +21,27 @@
\uicontrol Subversion > \uicontrol Describe to display commit log messages
for a revision.
By default, you must confirm that you want to submit changes. To suppress the
confirmation prompt, select \uicontrol Edit > \uicontrol Preferences >
\uicontrol {Version Control} > \uicontrol Subversion, and then deselect the
\uicontrol {Prompt on submit} check box.
To show whitespace changes in annotation views, deselect the
\uicontrol {Ignore whitespace changes in annotation} check box.
You can use Git as a client for a Subversion server. For more information,
see \l{Using Git with Subversion}.
\section1 Subversion Preferences
To set Subversion preferences, select \uicontrol Edit >
\uicontrol Preferences > \uicontrol {Version Control} >
\uicontrol Subversion:
\image qtcreator-preferences-vcs-subversion.webp {Subversion preferences}
\list
\li \uicontrol {Subversion command} specifies the path to the command
line client executable.
\li \uicontrol {Username} and \uicontrol {Password} specify the user
credentials to access the repository if the server requires
\uicontrol Authentication.
\li \uicontrol {Log count} sets the maximum number of lines the log can
have.
\li \uicontrol Timeout sets a timeout for version control operations.
\li \uicontrol {Ignore whitespace changes in annotation} hides whitespace
changes in annotation views.
\endlist
*/

35
doc/qtcreator/src/vcs/creator-vcs-git.qdoc
View File

@@ -1,4 +1,4 @@
// Copyright (C) 2022 The Qt Company Ltd.
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
// **********************************************************************
@@ -46,6 +46,8 @@
set to \c %HOMEDRIVE%%HOMEPATH% when the Git executable is run and
authorization works as it would with \c {git bash}.
\image qtcreator-preferences-vcs-git.webp {Git preferences}
\section1 Working with the Current File
To work with the current file, select the commands in \uicontrol Tools >
@@ -73,9 +75,15 @@
To display the versioning history of a file, select \uicontrol{Log of}.
The log output has the date, the commit message, and a commit
identifier. Click on the commit identifier to view commit details.
identifier.
\image qtcreator-git-log.png "Commit details in Git log"
You can set the maximum number of log entries to show in \uicontrol Edit >
\uicontrol Preferences > \uicontrol {Version Control} > \uicontrol Git >
\uicontrol {Log count}.
Click on the commit identifier to view commit details.
\image qtcreator-git-log.png {Commit details in Git log}
Right-clicking on a commit identifier brings up a context menu that lets
you apply actions on the commit, such as view annotations or cherry-pick
@@ -109,7 +117,7 @@
\uicontrol {Git Show} view, select \uicontrol {Describe Change} in the
context menu.
\image qtcreator-vcs-show.png "Commit description in Git show"
\image qtcreator-vcs-show.png {Commit description in Git show}
\section2 Viewing Annotations
@@ -117,7 +125,14 @@
view displays the lines of the file prepended by the commit identifier they
originate from.
\image qtcreator-git-blame.webp "Git Blame view"
\image qtcreator-git-blame.webp {Git Blame view}
By default, each line is annotated in the editor when you scroll through
the file. To disable this feature, select \uicontrol Edit >
\uicontrol Preferences > \uicontrol {Version Control} > \uicontrol Git, and
deselect \uicontrol {Add instant blame annotations to editor}. To view
annotations for the current line, select \uicontrol Tools > \uicontrol Git >
\uicontrol {Current File} > \uicontrol {Instant Blame}.
Click the commit identifier to show a detailed description of the change.
@@ -197,7 +212,7 @@
commit page containing a text editor where you can enter your commit
message and a checkable list of modified files to include.
\image qtcreator-vcs-commit.png "Committing changes with Git"
\image qtcreator-vcs-commit.png {Committing changes with Git}
\uicontrol {General Information} displays the names of the
repository and branch for the commit.
@@ -234,7 +249,7 @@
\uicontrol Git > \uicontrol {Local Repository} >
\uicontrol {Amend Last Commit}.
\image qtcreator-git-amend.png "Amending a Git commit"
\image qtcreator-git-amend.png {Amending a Git commit}
To view the commit in its current form, before amending, select
\uicontrol {Show HEAD}.
@@ -279,7 +294,7 @@
\uicontrol {Git Branches} sidebar view shows the checked out
branch in bold and underlined in the list of branches.
\image qtcreator-vcs-gitbranch.png "Git Branches sidebar view"
\image qtcreator-vcs-gitbranch.png {Git Branches sidebar view}
Old entries and tags are filtered out of the list of branches
by default. To include them, select \inlineimage icons/filtericon.png
@@ -424,7 +439,7 @@
commits, select \uicontrol Tools > \uicontrol Git >
\uicontrol {Actions on Commits}.
\image creator-git-commit-actions.png "Select a Git Commit dialog"
\image creator-git-commit-actions.png {Select a Git Commit dialog}
You can apply the following actions on commits:
@@ -565,7 +580,7 @@
Select the \uicontrol HTTPS check box to prepend \c https to the Gerrit URL
if Gerrit does not add it.
\image qtcreator-gerrit-options.png "Gerrit preferences"
\image qtcreator-preferences-vcs-gerrit.webp {Gerrit preferences}
\section1 Working with Git Tools