diff options
Diffstat (limited to 'doc/qtcreator/src/vcs/creator-vcs-git.qdoc')
| -rw-r--r-- | doc/qtcreator/src/vcs/creator-vcs-git.qdoc | 35 |
1 files changed, 25 insertions, 10 deletions
diff --git a/doc/qtcreator/src/vcs/creator-vcs-git.qdoc b/doc/qtcreator/src/vcs/creator-vcs-git.qdoc index 47682e787b..8d65462a2b 100644 --- a/doc/qtcreator/src/vcs/creator-vcs-git.qdoc +++ b/doc/qtcreator/src/vcs/creator-vcs-git.qdoc @@ -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. + + 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" + \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 |