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

Doc: Chop up the "Using Version Control Systems" topic

Browse Source 
Turn the topic into Reference and How-to topics.

Task-number: QTCREATORBUG-29361
Change-Id: I2fd4050f712b61b3e4140a5bf93e968c02b36d36
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
This commit is contained in:
Leena Miettinen
2023-09-07 16:56:25 +02:00
parent 097cb17af4
commit 2d9aa27b61
18 changed files with 185 additions and 107 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc
View File

@@ -53,6 +53,7 @@
\li \l {Create files}
\li \l {Create OpenGL fragment and vertex shaders}
\li \l {Create resource files}
\li \l {Create VCS repositories for new projects}
\li \l {Develop Qt for Python applications}
\li \l {Open projects}
\li \l {Specify project contents}
@@ -83,6 +84,8 @@
\li \l {Install plugins}
\li \l {Manage data collection}
\li \l {Run \QC from the command line}
\li \l {Set up version control systems}
\li \l {Use common VCS functions}
\li \l {Use external text editors}
\li \l {Use external tools}
\li \l {Use Qt Linguist}

2
doc/qtcreator/src/overview/creator-only/creator-configuring.qdoc
View File

@@ -137,7 +137,7 @@
\uicontrol General.
For more information about the supported functions, see
\l{Using Version Control Systems}.
\l{Version Control Systems}.
\section1 Managing Plugins

8
doc/qtcreator/src/overview/creator-only/creator-reference.qdoc
View File

@@ -19,11 +19,11 @@
\annotatedlist creator-reference-build-systems
\section1 Sidebar Views
\annotatedlist creator-reference-sidebar-views
\section1 Output Views
\annotatedlist creator-reference-output-views
\section1 Sidebar Views
\annotatedlist creator-reference-sidebar-views
*/

2
doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc
View File

@@ -135,7 +135,7 @@
{Nim or Nimble} applications (experimental)
\row
\li Imported project
\li Import projects from a supported \l{Using Version Control Systems}
\li Import projects from a supported \l{Version Control Systems}
{version control system}, such as Bazaar, CVS, Git, Mercurial, or
Subversion.

2
doc/qtcreator/src/projects/creator-only/creator-projects-overview.qdoc
View File

@@ -30,7 +30,7 @@
language to implement the application logic: C++, JavaScript, or
Python.
\li \l{Using Version Control Systems}
\li \l{Version Control Systems}
The recommended way to set up a project is to use a version control
system. Store and edit only project source files and configuration

27
doc/qtcreator/src/qtcreator-toc.qdoc
View File

@@ -24,18 +24,6 @@
\li \l{Managing Projects}
\list
\li \l{Creating Projects}
\li \l{Using Version Control Systems}
\list
\li \l{Using Bazaar}
\li \l{Using ClearCase}
\li \l{Using CVS}
\li \l{Using Fossil}
\li \l{Using Git}
\li \l{Using GitLab}
\li \l{Using Mercurial}
\li \l{Using Perforce}
\li \l{Using Subversion}
\endlist
\li \l{Configuring Projects}
\list
\li \l{Adding Kits}
@@ -231,6 +219,7 @@
\li \l {Create files}
\li \l {Create OpenGL fragment and vertex shaders}
\li \l {Create resource files}
\li \l {Create VCS repositories for new projects}
\li \l {Develop Qt for Python applications}
\li \l {Open projects}
\li \l {Select the build system}
@@ -257,6 +246,8 @@
\li \l {Install plugins}
\li \l {Manage data collection}
\li \l {Run \QC from the command line}
\li \l {Set up version control systems}
\li \l {Use common VCS functions}
\li \l {Use external text editors}
\li \l {Use external tools}
\li \l {Use Qt Linguist}
@@ -324,6 +315,18 @@
\li \l {Embedded Platforms}
\li \l {Mobile Platforms}
\endlist
\li \l{Version Control Systems}
\list
\li \l {Bazaar}
\li \l {ClearCase}
\li \l {CVS}
\li \l {Fossil}
\li \l {Git}
\li \l {GitLab}
\li \l {Mercurial}
\li \l {Perforce}
\li \l {Subversion}
\endlist
\endlist
\endlist
*/

2
doc/qtcreator/src/qtcreator.qdoc
View File

@@ -51,7 +51,7 @@
\li \b {\l{Managing Projects}}
\list
\li \l{Creating Projects}
\li \l{Using Version Control Systems}
\li \l{Version Control Systems}
\li \l{Configuring Projects}
\li \l{Managing Sessions}
\endlist

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

@@ -8,16 +8,19 @@
// **********************************************************************
/*!
\previouspage creator-version-control.html
\page creator-vcs-bazaar.html
\nextpage creator-vcs-clearcase.html
\previouspage creator-reference.html
\title Using Bazaar
\ingroup creator-reference-vcs
\title Bazaar
\brief Additional Bazaar functions.
Bazaar is a free version control system sponsored by Canonical.
In addition to the standard version control system functions described in
\l {Using Common Functions}, you can select \uicontrol Tools >
\l {Use common VCS Functions}, you can select \uicontrol Tools >
\uicontrol Bazaar > \uicontrol Pull to turn a branch into a mirror of
another branch. To update the mirror of the branch, select \uicontrol Push.
@@ -58,4 +61,7 @@
have.
\li \uicontrol Timeout sets a timeout for version control operations.
\endlist
\sa {Set up version control systems}, {Use common VCS functions},
{Version Control Systems}
*/

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

@@ -8,11 +8,14 @@
// **********************************************************************
/*!
\previouspage creator-vcs-bazaar.html
\page creator-vcs-clearcase.html
\nextpage creator-vcs-cvs.html
\previouspage creator-reference.html
\title Using ClearCase
\ingroup creator-reference-vcs
\title ClearCase
\brief Additional ClearCase functions.
IBM Rational ClearCase is a version control, workspace management, parallel
development support, and build automation solution developed by IBM. Use the
@@ -44,7 +47,7 @@
\section1 Checking out and Checking in
In addition to the standard version control system functions described in
\l {Using Common Functions}, you can check out and check in files.
\l {Use common VCS Functions}, you can check out and check in files.
To create a writable copy of a file, select \uicontrol Tools >
\uicontrol ClearCase > \uicontrol {Check Out}. If you check out files in a
@@ -92,4 +95,7 @@
Specify the number of event records to show in \uicontrol {History count}.
Set a timeout for version control operations in \uicontrol Timeout.
\sa {Set up version control systems}, {Use common VCS functions},
{Version Control Systems}
*/

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

@@ -8,16 +8,19 @@
// **********************************************************************
/*!
\previouspage creator-vcs-clearcase.html
\page creator-vcs-cvs.html
\nextpage creator-vcs-fossil.html
\previouspage creator-reference.html
\title Using CVS
\ingroup creator-reference-vcs
\title CVS
\brief Additional CVS functions.
CVS is an open source version control system.
In addition to the standard version control system functions described in
\l {Using Common Functions}, you can select \uicontrol Tools >
\l {Use common VCS Functions}, you can select \uicontrol Tools >
\uicontrol CVS > \uicontrol Edit to set a file as writable, notify
watchers that the file is being edited, and watch for actions performed
on the file by other users.
@@ -45,4 +48,7 @@
\li \uicontrol {Describe all files matching commit id} annotates all
files that belong to the commit.
\endlist
\sa {Set up version control systems}, {Use common VCS functions},
{Version Control Systems}
*/

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

@@ -3,10 +3,13 @@
/*!
\page creator-vcs-fossil.html
\previouspage creator-vcs-cvs.html
\nextpage creator-vcs-git.html
\previouspage creator-reference.html
\title Using Fossil
\ingroup creator-reference-vcs
\title Fossil
\brief Additional Fossil functions.
Fossil is an open source distributed version control system, designed
and developed by the creator of SQLite. A stand-alone Fossil executable
@@ -44,7 +47,7 @@
\section1 Additional Fossil Functions
In addition to the standard version control system functions described in
\l {Using Version Control Systems}, the \uicontrol Fossil submenu has
\l {Version Control Systems}, the \uicontrol Fossil submenu has
the following items:
\table
@@ -89,4 +92,7 @@
a commit or update and automatic push after a commit or tag or branch
creation.
\endlist
\sa {Set up version control systems}, {Use common VCS functions},
{Version Control Systems}
*/

16
doc/qtcreator/src/vcs/creator-only/creator-vcs-gitlab.qdoc
View File

@@ -1,15 +1,18 @@
// 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
/*!
\previouspage creator-vcs-git.html
\page creator-vcs-gitlab.html
\nextpage creator-vcs-mercurial.html
\previouspage creator-reference.html
\title Using GitLab
\ingroup creator-reference-vcs
\title GitLab
\brief Additional GitLab functions.
GitLab is a DevOps tool developed by GitLab. You can clone projects from
GitLab servers and use \l{Using Git}{Git} to manage your local and remote
GitLab servers and use \l{Git} to manage your local and remote
repositories.
To enable the experimental GitLab plugin, select \uicontrol Help >
@@ -121,4 +124,7 @@
To stop the reception of event notifications, select
\uicontrol {Unlink from GitLab}.
\sa {Set up version control systems}, {Use common VCS functions},
{Version Control Systems}, {Git}
*/

15
doc/qtcreator/src/vcs/creator-only/creator-vcs-mercurial.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
// **********************************************************************
@@ -8,16 +8,19 @@
// **********************************************************************
/*!
\previouspage creator-vcs-gitlab.html
\page creator-vcs-mercurial.html
\nextpage creator-vcs-perforce.html
\previouspage creator-reference.html
\title Using Mercurial
\ingroup creator-reference-vcs
\title Mercurial
\brief Additional Mercurial functions.
Mercurial is a free, distributed source control management tool.
In addition to the standard version control system functions described in
\l {Using Common Functions}, you can select the following functions in the
\l {Use common VCS Functions}, you can select the following functions in the
\uicontrol Tools > \uicontrol Mercurial submenu:
\table
@@ -61,4 +64,6 @@
\li \uicontrol Timeout sets a timeout for version control operations.
\endlist
\sa {Set up version control systems}, {Use common VCS functions},
{Version Control Systems}
*/

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

@@ -8,11 +8,14 @@
// **********************************************************************
/*!
\previouspage creator-vcs-mercurial.html
\page creator-vcs-perforce.html
\nextpage creator-vcs-subversion.html
\previouspage creator-reference.html
\title Using Perforce
\ingroup creator-reference-vcs
\title Perforce
\brief Additional Perforce functions.
Perforce is a fast software configuration management system developed by
Perforce Software.
@@ -49,7 +52,7 @@
\section1 Editing Files
In addition to the standard version control system functions described in
\l {Using Common Functions}, you can select \uicontrol Tools >
\l {Use common VCS Functions}, you can select \uicontrol Tools >
\uicontrol Perforce > \uicontrol {Edit File} to open a file for editing
within the client workspace. By default, files are automatically opened for
editing. To disable this feature, select \uicontrol Edit >
@@ -65,4 +68,7 @@
To view information about change lists and the files in them, select
\uicontrol Tools > \uicontrol Perforce > \uicontrol Describe.
\sa {Set up version control systems}, {Use common VCS functions},
{Version Control Systems}
*/

10
doc/qtcreator/src/vcs/creator-only/creator-vcs-options.qdocinc → doc/qtcreator/src/vcs/creator-only/creator-vcs-preferences.qdoc
View File

@@ -2,10 +2,12 @@
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page creator-how-to-set-up-vcs.html
\previouspage creator-how-tos.html
//! [vcs options]
\ingroup creator-how-to-use
\section1 Setting Up Version Control Systems
\title Set up version control systems
\QC uses the version control system's command line clients to access your
repositories. Make sure that the command line clients are in the \c{PATH}
@@ -23,7 +25,7 @@
For more information on using Git for Windows, see
\l {Using Git for Windows}.
\section1 Setting Up General Options
\section1 General VCS preferences
Select \uicontrol Edit > \uicontrol Preferences > \uicontrol {Version Control}
> \uicontrol General to specify settings for submit messages:
@@ -72,5 +74,5 @@
from the command line, for example.
\endlist
//! [vcs options]
\sa {Version Control Systems}
*/

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

@@ -8,16 +8,19 @@
// **********************************************************************
/*!
\previouspage creator-vcs-perforce.html
\page creator-vcs-subversion.html
\nextpage creator-configuring-projects.html
\previouspage creator-reference.html
\title Using Subversion
\ingroup creator-reference-vcs
\title Subversion
\brief Additional Subversion functions.
Subversion is an open source version control system.
In addition to the standard version control system functions described in
\l {Using Common Functions}, you can select \uicontrol Tools >
\l {Use common VCS Functions}, you can select \uicontrol Tools >
\uicontrol Subversion > \uicontrol Describe to display commit log messages
for a revision.
@@ -44,4 +47,7 @@
\li \uicontrol {Ignore whitespace changes in annotation} hides whitespace
changes in annotation views.
\endlist
\sa {Set up version control systems}, {Use common VCS functions},
{Version Control Systems}
*/

100
doc/qtcreator/src/vcs/creator-only/creator-vcs.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
// **********************************************************************
@@ -8,24 +8,32 @@
// **********************************************************************
/*!
\previouspage creator-project-wizards.html
\page creator-version-control.html
\nextpage creator-vcs-bazaar.html
\previouspage creator-reference.html
\title Using Version Control Systems
\ingroup creator-reference
Version control systems supported by \QC are:
\title Version Control Systems
\brief Version control systems that you can use from \QC.
The recommended way to set up a project is to use a
\e {version control system}. Store and edit only project source files and
configuration files. Do not store generated files. To use version control
systems from \QC, you need to set them up.
\QC integrates the following version control systems:
\table
\header
\li Version Control System
\li Address
\li Notes
\row
\li \l{Using Bazaar}{Bazaar}
\li \l{Bazaar}
\li \l{http://bazaar.canonical.com/}
\li
\row
\li \l{Using ClearCase}{ClearCase}
\li \l{ClearCase}
\li \l{http://www-01.ibm.com/software/awdtools/clearcase/}
\li Disabled by default. To enable the plugin, select
\uicontrol Help > \uicontrol {About Plugins} >
@@ -33,31 +41,31 @@
Then select \uicontrol {Restart Now} to restart \QC
and load the plugin.
\row
\li \l{Using CVS}{CVS}
\li \l{CVS}
\li \l{http://www.nongnu.org/cvs/}
\li
\row
\li \l{Using Fossil}{Fossil}
\li \l{Fossil}
\li \l{https://fossil-scm.org/index.html/doc/trunk/www/index.wiki}
\li Disabled by default. To enable the plugin, select
\uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Version Control} > \uicontrol Fossil.
\row
\li \l{Using Git}{Git}
\li \l{Git}
\li \l{http://git-scm.com/}
\li Git version 1.9.0, or later
Gerrit version 2.6, or later
\row
\li \l{Using GitLab}{GitLab}
\li \l{GitLab}
\li \l{http://gitlab.com/}
\li Experimental
\row
\li \l{Using Mercurial}{Mercurial}
\li \l{Mercurial}
\li \l{http://mercurial.selenic.com/}
\li
\row
\li \l{Using Perforce}{Perforce}
\li \l{Perforce}
\li \l{http://www.perforce.com}
\li Server version 2006.1 and later
@@ -65,14 +73,22 @@
\uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Version Control} > \uicontrol Perforce.
\row
\li \l{Using Subversion}{Subversion}
\li \l{Subversion}
\li \l{http://subversion.apache.org/}
\li Subversion version 1.7.0 and later
\endtable
\include creator-vcs-options.qdocinc vcs options
\sa {Create VCS repositories for new projects},
{Set up version control systems}, {Use common VCS functions}
*/
\section1 Creating VCS Repositories for New Projects
/*!
\page creator-how-to-create-vcs-repositories.html
\previouspage creator-how-tos.html
\ingroup creator-how-to-projects
\title Create VCS repositories for new projects
\QC allows you to create repositories for version control systems that
support local repository creation, such as Git, Mercurial, or Bazaar.
@@ -87,33 +103,33 @@
and select the version control system that you use. Follow the instructions
of the wizard to import the project.
\section1 Using Common Functions
\sa {Creating Projects}, {Use project wizards}, {Version Control Systems}
*/
/*!
\page creator-how-to-use-common-vcs-functions.html
\previouspage creator-how-tos.html
\ingroup creator-how-to-use
\title Use common VCS functions
The \uicontrol{Tools} menu has a submenu for each supported version
control system. This section describes using the functions that are
available for all the supported version control systems. For more
information about the additional functions and options available for a
particular version control system, see:
available for all the supported version control systems. The additional
functions and options available for a particular version control system
are described in separate topics.
\list
\li \l{Using Bazaar}
\li \l{Using ClearCase}
\li \l{Using CVS}
\li \l{Using Fossil}
\li \l{Using Git}
\li \l{Using GitLab}
\li \l{Using Mercurial}
\li \l{Using Perforce}
\li \l{Using Subversion}
\endlist
\sa {Bazaar}, {ClearCase}, {CVS}, {Fossil}, {Git}, {GitLab}, {Mercurial},
{Perforce}, {Subversion}
\uicontrol{Version Control} displays the commands that are
The \uicontrol{Version Control} view displays the commands that are
executed, a timestamp, and the relevant output. Select \uicontrol View >
\uicontrol Output > \uicontrol {Version Control} to open the view.
\image qtcreator-vcs-pane.png
\section2 Adding Files
\section1 Add files
When you create a new file or a new project, the wizard displays a page
asking whether the files should be added to a version control system.
@@ -122,7 +138,7 @@
for example, Perforce and Subversion. Alternatively, you can
add files later by using the version control tool menus.
\section2 Viewing Diff Output
\section1 View diff output
All version control systems have menu options to \e{diff} the current
file or project: to compare it with the latest version stored in the
@@ -141,13 +157,13 @@
unstage chunks or selected lines, as well as send chunks to a code pasting
service.
\section2 Viewing Versioning History and Change Details
\section1 View versioning history and change details
Display the versioning history of a file by selecting \uicontrol{Log}
or \uicontrol{Filelog}. Typically, the log output has the date, commit
message, and a change or revision identifier.
\section2 Annotating Files
\section1 Annotate files
To open annotation views, select \uicontrol {Annotate} or \uicontrol {Blame}.
They show the lines of the file and the identifier of the change the lines
@@ -163,14 +179,14 @@
The same context menu is available when right-clicking on a version
identifier in the file log view of a single file.
\section2 Committing Changes
\section1 Commit changes
Once you have finished making changes, submit them to the version control
system by choosing \uicontrol{Commit} or \uicontrol{Submit}. \QC displays a
commit page that has a text editor where you can enter your commit
message and a checkable list of modified files to include.
\section2 Reverting Changes
\section1 Revert changes
All supported version control systems support reverting your project to
known states. This functionality is generally called \e reverting.
@@ -180,18 +196,20 @@
A version control system can replace the \uicontrol Revert menu option with other
options.
\section2 Viewing Status
\section1 View status
You can select \uicontrol{Status} to view the status of the project or
repository.
\section2 Updating the Working Tree
\section1 Update the working tree
You can select \uicontrol Update to update your working tree with the latest
changes from the branch. Some version control systems allow you to choose
between updating the current project and updating all projects.
\section2 Deleting Files
\section1 Delete files
You can select \uicontrol Delete to delete obsolete files from the repository.
\sa {Set up version control systems}, {Version Control Systems}
*/

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

@@ -12,12 +12,17 @@
\if defined(qtdesignstudio)
\previouspage studio-developer-topics.html
\nextpage studio-porting-projects.html
\else
\previouspage creator-vcs-fossil.html
\nextpage creator-vcs-gitlab.html
\endif
\title Using Git
\else
\previouspage creator-reference.html
\ingroup creator-reference-vcs
\title Git
\brief Additional Git functions.
\endif
\l{http://git-scm.com/}{Git} is a fast decentralized version control system.
Git is available for Windows, Linux, and \macos.
@@ -25,10 +30,6 @@
You can use the \l{http://code.google.com/p/gerrit/}{Gerrit} code review
tool for projects that use Git.
\if defined(qtdesignstudio)
\include creator-vcs-options.qdocinc vcs options
\endif
\section1 Using Git for Windows
If you configure Git for use with \c {git bash}, only, and use SSH
@@ -613,4 +614,8 @@
To resolve merge conflicts, select \uicontrol Tools > \uicontrol Git >
\uicontrol {Git Tools} > \uicontrol {Merge Tool}. This menu item is
visible only when you have merge conflicts to resolve.
\if defined(qtcreator)
\sa {Set up version control systems}, {Version Control Systems}
\endif
*/