forked from qt-creator/qt-creator
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>
This commit is contained in:
BIN
doc/images/qtcreator-git-commit-actions.png
Normal file
BIN
doc/images/qtcreator-git-commit-actions.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 13 KiB |
Binary file not shown.
Before Width: | Height: | Size: 3.9 KiB After Width: | Height: | Size: 6.7 KiB |
@@ -1,6 +1,6 @@
|
|||||||
/****************************************************************************
|
/****************************************************************************
|
||||||
**
|
**
|
||||||
** Copyright (C) 2018 The Qt Company Ltd.
|
** Copyright (C) 2019 The Qt Company Ltd.
|
||||||
** Contact: https://www.qt.io/licensing/
|
** Contact: https://www.qt.io/licensing/
|
||||||
**
|
**
|
||||||
** This file is part of the Qt Creator documentation.
|
** 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
|
branch is shown in bold and underlined in the list of branches in the
|
||||||
\uicontrol {Git Branches} sidebar view.
|
\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
|
If you checked out a specific commit, the list of branches displays a
|
||||||
\e {Detached HEAD} entry.
|
\e {Detached HEAD} entry.
|
||||||
|
|
||||||
@@ -233,8 +240,6 @@
|
|||||||
To refresh the list of branches, click \inlineimage reload_gray.png
|
To refresh the list of branches, click \inlineimage reload_gray.png
|
||||||
(\uicontrol Refresh).
|
(\uicontrol Refresh).
|
||||||
|
|
||||||
\image qtcreator-vcs-gitbranch.png "Git Branches sidebar view"
|
|
||||||
|
|
||||||
The following operations are supported in the context-menu for a branch:
|
The following operations are supported in the context-menu for a branch:
|
||||||
|
|
||||||
\table
|
\table
|
||||||
@@ -249,7 +254,8 @@
|
|||||||
\li Remove a local branch. You cannot delete remote branches.
|
\li Remove a local branch. You cannot delete remote branches.
|
||||||
\row
|
\row
|
||||||
\li \uicontrol Rename
|
\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
|
\row
|
||||||
\li \uicontrol{Checkout}
|
\li \uicontrol{Checkout}
|
||||||
\li Check out the selected branch and make it current. You can stash
|
\li Check out the selected branch and make it current. You can stash
|
||||||
@@ -302,12 +308,12 @@
|
|||||||
\li Description
|
\li Description
|
||||||
\row
|
\row
|
||||||
\li \uicontrol{Fetch}
|
\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
|
specific remote repository, or from all remotes if applied
|
||||||
to \uicontrol {Remote Branches}.
|
to \uicontrol {Remote Branches}.
|
||||||
\row
|
\row
|
||||||
\li \uicontrol{Manage Remotes}
|
\li \uicontrol{Manage Remotes}
|
||||||
\li Opens the \uicontrol Remotes dialog.
|
\li Open the \uicontrol Remotes dialog.
|
||||||
\endtable
|
\endtable
|
||||||
|
|
||||||
\section3 Configuring Merge Tools
|
\section3 Configuring Merge Tools
|
||||||
@@ -357,11 +363,33 @@
|
|||||||
|
|
||||||
To browse a directory or the commit history and to apply actions on the
|
To browse a directory or the commit history and to apply actions on the
|
||||||
commits, select \uicontrol Tools > \uicontrol Git >
|
commits, select \uicontrol Tools > \uicontrol Git >
|
||||||
\uicontrol {Actions on Commits}. You can checkout, revert, or cherry-pick
|
\uicontrol {Actions on Commits}.
|
||||||
commits or view them in the diff editor.
|
|
||||||
|
|
||||||
\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:
|
||||||
|
|
||||||
|
\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
|
\section1 Initializing Git Repositories
|
||||||
|
|
||||||
To start controlling a project directory that is currently not under
|
To start controlling a project directory that is currently not under
|
||||||
|
Reference in New Issue
Block a user