Doc: Move vcs-system specific sections to separate topics

This is done in preparation for moving some Qt Creator
plugins and their documentation into their own repositories.

All the changes have to do with the structure of the documentation.
There are no content changes, except removing headings or changing
them to better fit the new structure and adding some leading
sentences or links.

Change-Id: I1499187121a1a1cc3c6b635801fb540ac439fd0b
Reviewed-by: default avatarJarek Kobus <jaroslaw.kobus@qt.io>
Reviewed-by: Orgad Shaneh's avatarOrgad Shaneh <orgads@gmail.com>
Reviewed-by: default avatarHugues Delorme <delorme.hugues@fougue.pro>
parent 0e12c51d
......@@ -164,6 +164,15 @@
\endlist
\endlist
\li \l{Using Version Control Systems}
\list
\li \l{Using Bazaar}
\li \l{Using ClearCase}
\li \l{Using CVS}
\li \l{Using Git}
\li \l{Using Mercurial}
\li \l{Using Perforce}
\li \l{Using Subversion}
\endlist
\li \l{Configuring Projects}
\list
\li \l{Adding Kits}
......
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage {Qt Creator Manual}
\previouspage creator-version-control.html
\page creator-vcs-bazaar.html
\nextpage creator-vcs-clearcase.html
\title Using Bazaar
Bazaar is a free version control system sponsored by Canonical.
The \uicontrol Bazaar submenu contains the following additional items:
\table
\header
\li Menu Item
\li Description
\row
\li \uicontrol Pull
\li Turn the branch into a mirror of another branch.
\row
\li \uicontrol Push
\li Update a mirror of the branch.
\row
\li \uicontrol Uncommit
\li Remove the last committed revision.
\endtable
\section1 Uncommitting Revisions
In Bazaar, committing changes to a branch creates a new revision that holds
a snapshot of the state of the working tree. To remove the last committed
revision, select \uicontrol Tools > \uicontrol Bazaar > \uicontrol Uncommit.
In the \uicontrol Uncommit dialog, select options to keep tags that point to
removed revisions and to only remove the commits from the local branch when
in a checkout.
To remove all commits up to an entry in the revision log, specify the
revision in the \uicontrol Revision field.
To test the outcome of the \uicontrol Uncommit command without actually
removing anything, select \uicontrol {Dry Run}.
\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.
*/
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage {Qt Creator Manual}
\previouspage creator-vcs-bazaar.html
\page creator-vcs-clearcase.html
\nextpage creator-vcs-cvs.html
\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.
\section1 Using GNU Diffutils with ClearCase
You can use the GNU Diffutils tool With ClearCase to compare files and
activities:
\list 1
\li Download \l{http://gnuwin32.sourceforge.net/packages/diffutils.htm}
{Diffutils} and extract it to a directory in your PATH.
\li Select \uicontrol Tools > \uicontrol Options >
\uicontrol {Version Control} > \uicontrol ClearCase.
\li Select the \uicontrol External radio button. The radio button is
disabled if \c diff is not found in the PATH.
\li In the \uicontrol Arguments field, specify arguments for running
\c diff.
\endlist
\section1 Using Additional ClearCase Functions
The \uicontrol ClearCase submenu contains the following additional items:
\table
\header
\li Menu Item
\li Description
\row
\li \uicontrol{Check In}
\li Create a permanent new version of the current file or all files
in the versioned object base (VOB).
\row
\li \uicontrol{Check In Activity}
\li Check in checked-out versions in the change set of the current
Unified Change Management (UCM) activity.
\row
\li \uicontrol{Check Out}
\li Create a writable copy of a branch. If you check out files in a
UCM view, they are added to the change set of the UCM activity.
\row
\li \uicontrol{Undo Check Out}
\li Cancel the checkout for a file and delete the checked-out
version.
\row
\li \uicontrol{Undo Hijack}
\li Resolve hijacked files. If you change the read-only attribute of
a file that is loaded into a snapshot view and modify the file
without checking it out, you \e hijack the file.
\endtable
*/
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage {Qt Creator Manual}
\previouspage creator-vcs-clearcase.html
\page creator-vcs-cvs.html
\nextpage creator-vcs-git.html
\title Using CVS
CVS is an open source version control system.
In addition to the standard version control system functions, you can
select \uicontrol Tools > \uicontrol CVS > \uicontrol Edit to open a file
for editing.
To discard the changes that you made in a file, select \uicontrol Unedit.
*/
This diff is collapsed.
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage {Qt Creator Manual}
\previouspage creator-vcs-git.html
\page creator-vcs-mercurial.html
\nextpage creator-vcs-perforce.html
\title Using Mercurial
Mercurial is a free, distributed source control management tool.
The \uicontrol Mercurial submenu contains the following additional items:
\table
\header
\li Menu Item
\li Description
\row
\li \uicontrol{Import}
\li Apply changes from a patch file.
\row
\li \uicontrol{Incoming}
\li Monitor the status of a remote repository by listing
the changes that will be pulled.
\row
\li \uicontrol{Outgoing}
\li Monitor the status of a remote repository by listing
the changes that will be pushed.
\row
\li \uicontrol{Pull}
\li Pull changes from the remote repository.
\row
\li \uicontrol{Push}
\li Push changes to the remote repository.
\endtable
*/
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage {Qt Creator Manual}
\previouspage creator-vcs-mercurial.html
\page creator-vcs-perforce.html
\nextpage creator-vcs-subversion.html
\title Using Perforce
Perforce is a fast software configuration management system developed by
Perforce Software.
When you start \QC, it looks for the executable specified
in the \uicontrol{P4 command} field in \uicontrol{Tools > Options > Version
Control > Perforce}. If the file is not found, the following error
message is displayed in the \uicontrol {Version Control} output pane:
\uicontrol {Perforce: Unable to determine the repository: "p4.exe"
terminated with exit code 1}. If you use Perforce, check that the
path to the executable is specified correctly in the \uicontrol{P4 command}
field.
If you do not use Perforce, you can disable the Perforce plugin to
get rid of the error message. Choose \uicontrol {Help > About Plugins} and
deselect the \uicontrol Load check box for the \uicontrol Perforce plugin in
the \uicontrol {Version Control} group.
\section1 Using Additional Perforce Functions
In the Perforce options, 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
files instead. Create a \c {p4config.txt} configuration file for each
project in the top level project directory.
The \uicontrol Perforce submenu contains the following additional items:
\table
\header
\li Menu Item
\li Description
\row
\li \uicontrol{Describe}
\li View information about changelists and the files in them.
\row
\li \uicontrol{Edit File}
\li Open a file for editing.
\row
\li \uicontrol{Opened}
\li List files that are open for editing.
\row
\li \uicontrol{Pending Changes}
\li Group files for commit.
\endtable
*/
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage {Qt Creator Manual}
\previouspage creator-vcs-perforce.html
\page creator-vcs-subversion.html
\nextpage creator-configuring-projects.html
\title Using Subversion
Subversion is an open source version control system.
In addition to the standard version control system functions, you can
select \uicontrol Tools > \uicontrol Subversion > \uicontrol Describe
to display commit log messages for a revision.
*/
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment