summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2019-10-29 11:41:15 +0100
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2019-10-29 12:06:54 +0000
commit49c905b941b22954aa94c80894869d3287e6656a (patch)
treeba3b0e7b1203768d725bef2b08e54499710f1263 /doc
parentd3e6fa0f2eff6398bb742029e405f384ce2e987c (diff)
downloadqt-creator-49c905b941b22954aa94c80894869d3287e6656a.tar.gz
Doc: Update information about Git
Describe viewing tags and old information in the Git Branches sidebar view and the Archive action in the Actions in Commits dialog. Change-Id: I3c4c5b3ccc91657875d7ec9d14432d4ac88edd19 Reviewed-by: Orgad Shaneh <orgads@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/images/qtcreator-git-commit-actions.pngbin0 -> 13722 bytes
-rw-r--r--doc/images/qtcreator-vcs-gitbranch.pngbin3991 -> 6812 bytes
-rw-r--r--doc/src/vcs/creator-vcs-git.qdoc44
3 files changed, 36 insertions, 8 deletions
diff --git a/doc/images/qtcreator-git-commit-actions.png b/doc/images/qtcreator-git-commit-actions.png
new file mode 100644
index 0000000000..37295e48fc
--- /dev/null
+++ b/doc/images/qtcreator-git-commit-actions.png
Binary files differ
diff --git a/doc/images/qtcreator-vcs-gitbranch.png b/doc/images/qtcreator-vcs-gitbranch.png
index aae80201bc..f6a5586eac 100644
--- a/doc/images/qtcreator-vcs-gitbranch.png
+++ b/doc/images/qtcreator-vcs-gitbranch.png
Binary files differ
diff --git a/doc/src/vcs/creator-vcs-git.qdoc b/doc/src/vcs/creator-vcs-git.qdoc
index 8705df4939..ec6b1a2ebe 100644
--- a/doc/src/vcs/creator-vcs-git.qdoc
+++ b/doc/src/vcs/creator-vcs-git.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2018 The Qt Company Ltd.
+** Copyright (C) 2019 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
@@ -224,6 +224,13 @@
branch is shown in bold and underlined in the list of branches in the
\uicontrol {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 filtericon.png
+ (\uicontrol {Filter Tree}), and then select
+ \uicontrol {Include Old Entries} and \uicontrol {Include Tags}.
+
If you checked out a specific commit, the list of branches displays a
\e {Detached HEAD} entry.
@@ -233,8 +240,6 @@
To refresh the list of branches, click \inlineimage reload_gray.png
(\uicontrol Refresh).
- \image qtcreator-vcs-gitbranch.png "Git Branches sidebar view"
-
The following operations are supported in the context-menu for a branch:
\table
@@ -249,7 +254,8 @@
\li Remove a local branch. You cannot delete remote branches.
\row
\li \uicontrol Rename
- \li Rename a local branch. You cannot rename remote branches.
+ \li Rename a local branch or a tag. You cannot rename remote
+ branches.
\row
\li \uicontrol{Checkout}
\li Check out the selected branch and make it current. You can stash
@@ -302,12 +308,12 @@
\li Description
\row
\li \uicontrol{Fetch}
- \li Fetches all the branches and changes information from a
+ \li Fetch all the branches and changes information from a
specific remote repository, or from all remotes if applied
to \uicontrol {Remote Branches}.
\row
\li \uicontrol{Manage Remotes}
- \li Opens the \uicontrol Remotes dialog.
+ \li Open the \uicontrol Remotes dialog.
\endtable
\section3 Configuring Merge Tools
@@ -357,11 +363,33 @@
To browse a directory or the commit history and to apply actions on the
commits, select \uicontrol Tools > \uicontrol Git >
- \uicontrol {Actions on Commits}. You can checkout, revert, or cherry-pick
- commits or view them in the diff editor.
+ \uicontrol {Actions on Commits}.
\image creator-git-commit-actions.png "Select a Git Commit dialog"
+ You can apply the following actions on commits:
+
+ \table
+ \header
+ \li Menu Item
+ \li Description
+ \row
+ \li \uicontrol Archive
+ \li Package the commit as a ZIP or tarball.
+ \row
+ \li \uicontrol Checkout
+ \li Check out the change in a headless state.
+ \row
+ \li \uicontrol {Cherry Pick}
+ \li Cherry-pick the selected change to the local repository.
+ \row
+ \li \uicontrol Revert
+ \li Revert back to the state of the last commit.
+ \row
+ \li \uicontrol Show
+ \li Show the commit in the diff editor.
+ \endtable
+
\section1 Initializing Git Repositories
To start controlling a project directory that is currently not under