advertisement
Git Extensions Documentation
Release 2.48
Contributors
May 21, 2015
Contents
1
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
8
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
8
3
3
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
9
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
12
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
13
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
13
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
13
15
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
16
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
16
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
16
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
18
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
18
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
21
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
22
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
23
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
23
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
24
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
25
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
26
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
26
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
26
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
27
29
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
29
Search or filter the commit history
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
30
i
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
32
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
34
35
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
35
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
41
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
42
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
42
44
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
44
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
45
46
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
46
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
47
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
48
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
50
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
51
52
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
52
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
53
55
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
55
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
56
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
61
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
63
65
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
65
67
69
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
69
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
70
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
70
71
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
71
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
71
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
73
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
74
76
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
76
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
76
78
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
78
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
80
82
16.1 Git Extensions command line
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
82
ii
85
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
85
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
86
87
18.1 List of the available plugins
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
87
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
87
iii
iv
CHAPTER
1
Git Extensions
Git Extensions is a toolkit aimed at making working with Git under Windows more intuitive (note that Git Extensions is also available on Linux and Macintosh OS X using Mono). The shell extension will integrate in Windows Explorer and presents a context menu on files and directories. There is also a Visual Studio plug-in to use Git from the Visual
Studio IDE.
1.1 Features
• Windows Explorer integration for Git
• Visual Studio (2005/2008/2010/2012) plug-in for Git
• Feature rich user interface for Git
• Single installer installs Git, Git Extensions and the merge tool KDiff3
• 32bit and 64bit support
• Runs under Linux or Mac OS X using Mono
1.2 Video tutorials
There are video tutorials for some basic functions on YouTube.
1.
Clone
2.
Commit changes
3.
Push changes
4.
Pull changes
5.
Handle merge conflicts
6.
Install Git Extensions on Ubuntu 11.04
1.3 Links
See the following links for the Git Extensions download page, source code and documentation.
• Download page: https://sourceforge.net/projects/gitextensions/
1
Git Extensions Documentation, Release 2.48
• Source Code: https://github.com/gitextensions/gitextensions
• Source Code Issue tracker: https://github.com/gitextensions/gitextensions/issues
• Documentation: https://github.com/gitextensions/GitExtensionsDoc
• Documentation Issue tracker: https://github.com/gitextensions/GitExtensionsDoc/issues
• Wiki: https://github.com/gitextensions/gitextensions/wiki
Please feel free to raise any issues with Git Extensions or its documentation at the appropriate Issue tracker link as shown above.
1.3. Links 2
CHAPTER
2
Getting Started
This section is primarily written for Windows users. There are extra sections about installing Git Extensions on Linux and Mac OS X.
2.1 Installation
There is a single click installer that installs MsysGit, Kdiff3 and Git Extensions. The installer will detect if 32bit and/or 64bit versions should be installed. The installer can be found here .
3
Git Extensions Documentation, Release 2.48
Fig. 2.1: Git Extensions depends heavily on MsysGit. When MsysGit is not installed, ensure the “Install MsysGit” checkbox is checked. Kdiff3 is optional, but is advised as a merge tool.
2.1. Installation 4
Git Extensions Documentation, Release 2.48
2.1. Installation 5
Git Extensions Documentation, Release 2.48
2.1. Installation
Fig. 2.2: Choose the options to install.
6
Git Extensions Documentation, Release 2.48
Fig. 2.3: Choose the SSH client to use. PuTTY is the default because it has better Windows integration.
2.1. Installation 7
Git Extensions Documentation, Release 2.48
2.2 Installation (Linux)
You can watch this video as a starting point: Install Git Extensions on Ubuntu 11.04
For further help go to https://groups.google.com/forum/?fromgroups=#!forum/gitextensions
2.3 Installation (Mac)
This section only covers mono installation, you should have git installed in your Mac at this point. Please refer to http://git-scm.com/downloads
First, make sure you have the latest mono version on your Mac. This section will cover installation of mono 3.8.0 on a Mac.
1. Download mono latest version.
You can always check for this here: http://www.go-mono.com/monodownloads/download.html
2. After you have completed the download, you will see a .dmg file. Double click it to open the package.
3. Inside the .dmg file you will have MonoFramework-{version}.pkg. Double click to start the installation process.
4. Follow the wizard until it’s completion.
2.2. Installation (Linux) 8
Git Extensions Documentation, Release 2.48
5. If everything went okay, you should open your terminal and check mono version:
$ mono --version
Mono JIT compiler version 3.8.0 (mono-3-8/2baeee2 Wed Jan 16 16:40:16 EST 2013)
Copyright (C) 2002-2012 Novell, Inc, Xamarin, Inc and Contributors. www.mono-project.com
TLS: normal
SIGSEGV: normal
Notification: kqueue
Architecture: x86
Disabled: none
Misc:
LLVM:
GC: softdebug yes(2.9svn-mono)
Included Boehm (with typed GC)
6. Now download Git Extensions latest version from https://sourceforge.net/projects/gitextensions . Remember to select the appropriate package otherwise you could have problems.
7. Browse into the folder where you extracted the package and just run mono command, like the example below:
$ mono GitExtensions.exe
This is the minimal setup you need in order to run Git Extensions.
2.3.1 Troubleshooting Mac Installation
1. If your Git Extensions crashes with an exception that a font is missing (generic sans serif), you probably can fix this by installing Xquartz. This is a version of the X.Org X Windows System that runs on OS X. I am not sure what the side effects are. This can be installed from here: http://xquartz.macosforge.org/landing/
2. If Git Extensions still crashes because it is unable to load a plugin, empty the plugins folder.
2.4 Settings
All settings will be verified when Git Extensions is started for the first time. If Git Extensions requires any settings to be changed, the Settings dialog will be shown. All incorrect settings will be marked in red. You can ask Git Extensions to try to fix the setting for you by clicking on it. When installing Git Extensions for the first time (and you do not have
Git already installed on your system), you will normally be required to configure your username and email address.
The settings dialog can be invoked at any time by selecting Settings from the Tools menu option.
2.4. Settings 9
Git Extensions Documentation, Release 2.48
For further information see
2.5 Start Page
The start page contains the most common tasks, recently opened repositories and favourites. The left side of the start page (Common Actions and Recent Repositories) is static. The right side of the page is where favourite repositories can be added, grouped under Category headings.
2.5. Start Page 10
Git Extensions Documentation, Release 2.48
Recent Repositories can be moved to favourites using the repository context menu. Choose Move to category
/ New category to create a new category and add the repository to it, or you can add the repository to an existing category (e.g. ‘Currents’ as shown below).
A context menu is available for both the category and the repositories listed underneath it.
Entries on Category context menu
Move
Up
Move
Down
Move the category (and any repositories under it) higher on the page.
Move the category (and any repositories under it) lower on the page.
Remove Remove the category (and any repositories under it) from the page. Note: Git repositories are not physically removed either locally or remotely.
Edit Shows the Start Page settings window where both category and repository details can be modified.
See
Entries on repository context menu
2.5. Start Page 11
Git Extensions Documentation, Release 2.48
Move to category
Move up
Move down
Remove
Edit
Move the repository to a new or existing category.
Move the repository higher (within the category).
Move the repository lower (within the category).
Remove the repository from the category. Note: the repository is not physically removed either locally or remotely.
Shows the Start Page settings window where both category and repository details can be modified. See
Toggles the display of the branch name next to the repository name. This identifies the currently checked out branch for the repository.
Show current branch
To open an existing repository, simply click the link to the repository under Recent Repositories or within the Categories that you have set up, or select Open repository (from where you can select a repository to open from your local file system).
To create a new repository, one of the following options under Common Actions can be selected.
2.6 Clone repository
You can clone an existing repository using this option. It displays the following dialog.
The repository you want to clone could be on a network share or could be a repository that is accessed through an internet or intranet connection. Depending on the protocol (http or ssh) you might need to load a SSH key into PuTTY.
You also need to specify where the cloned repository will be created and the initial branch that is checked out. If the cloned repository contains submodules, then these can be initialised using their default settings if required.
There are two different types of repositories you can create when making a clone. A personal repository contains the complete history and also contains a working copy of the source tree. A central repository is used as a public repository where developers push the changes they want to share with others to. A central repository contains the complete history but does not have a working directory like personal repositories.
2.6. Clone repository 12
Git Extensions Documentation, Release 2.48
2.7 Clone SVN repository
You can clone an existing SVN repository using this option, which creates a Git repository from the SVN repository you specify. For further information refer to the Pro Git book .
2.8 Clone Github repository
This option allows you to
1. Fork a repository on GitHub so it is created in your personal space on GitHub.
2. Clone any repositories on your personal space on GitHub so that it becomes a local repository on your machine.
You can see your own personal repositories on GitHub, and also search for repositories using the Search for repositories tab.
2.9 Create new repository
When you do not want to work on an existing project, you can create your own repository using this option.
2.7. Clone SVN repository 13
Git Extensions Documentation, Release 2.48
Select a directory where the repository is to be created. You can choose to create a Personal repository or a Central repository.
A personal repository looks the same as a normal working directory but has a directory named .git at the root level containing the version history. This is the most common repository.
Central repositories only contain the version history. Because a central repository has no working directory you cannot checkout a revision in a central repository. It is also impossible to merge or pull changes in a central repository. This repository type can be used as a public repository where developers can push changes to or pull changes from.
2.9. Create new repository 14
CHAPTER
3
The settings dialog can be invoked at any time by selecting Settings from the Tools menu option.
Settings
The following buttons are always available on any page of the Settings dialog. Sometimes the Cancel button has no effect for the page - this will be noted on the page in the area next to the buttons.
Button
OK
Description
Save any entered changes made in any settings page and close the Settings dialog.
Cancel
Any entered changes in any settings page are not saved. The Settings dialog is closed.
Apply
Any entered changes in any settings page are saved.
Settings that are specific to Git Extensions and apply globally will be stored in a file called
GitExtensions.settings
either in the user’s application data path or with the program. The location is dependant on the IsPortable setting in the GitExtensions.exe.config file that is with the program. Settings
15
Git Extensions Documentation, Release 2.48
that are specific to Git Extensions but apply to only the current repository will be stored in a file of the same name,
GitExtensions.settings
, but in either the root folder of the repository or the .git folder of the repository, depending on whether or not they are distributed with that repository. The settings that are used by Git are stored in the configuration files of Git. The global settings are stored in the file called .gitconfig in the user directory. The local settings are stored in the .git\config file of the repository.
3.1 Checklist
This page is a visual overview of the minimal settings that Git Extensions requires to work properly. Any items highlighted in red should be configured by clicking on the highlighted item.
This page contains the following settings and buttons.
Setting
Check settings at startup
(disables automatically if all settings are correct)
Save and rescan button
Description
Forces Git Extensions to re-check the minimal set of required settings the next time Git Extensions is started. If all settings are ‘green’ this will be automatically unchecked.
Saves any setting changes made and re-checks the settings to see if the minimal requirements are now met.
3.2 Git
This page contains the settings needed to access git repositories. The repositories will be accessed using external tools.
For Windows usually MsysGit or cygwin are used. Git Extensions will try to configure these settings automatically.
Group Setting
Command used to run git
Git
(git.cmd or git.exe)
Description
Needed for Git Extensions to run Git commands. Set the full command used to run git (MsysGit or cygwin). Use the Browse button to find the executable on your file system.
A few linux tools are used by Git Extensions. When MsysGit is installed, these tools are located in the bin directory of MsysGit. Use the Browse button to find the directory on your file system.
This button opens a dialog where the HOME directory can be changed.
Environment
Path to Linux tools (sh).
Leave empty when it is in the path.
Change HOME button
The global configuration file used by git will be put in the HOME directory. On some systems the home directory is not set or is pointed to a network drive. Git Extensions will try to detect the optimal setting for your environment.
When there is already a global git configuration file, this location will be used. If you need to relocate the home directory for git, click the Change HOME button to change this setting. Otherwise leave this setting as the default.
3.3 Git Extensions
This page contains general settings for Git Extensions.
3.1. Checklist 16
Git Extensions Documentation, Release 2.48
Group
Performance
Behaviour
Setting
Show repository status in browse dialog (number of changes in toolbar, restart required)
Show current working dir changes in revision graph
Use FileSystemWatcher to check if index is changed
Show stash count on status bar in browse window
Check for uncommitted changes in checkout branch dialog
Limit number of commits that will be loaded in list at start-up
Close Process dialog when process succeeds
Show console window when executing git process
Description
When enabled, the number of pending commits are shown on the toolbar as a figure in parentheses next to the Commit button. Git Extensions must be stopped and restarted to activate changes to this option.
When enabled, two extra revisions are added to the revision graph. The first shows the current working directory status.
The second shows the staged files. This option can cause slowdowns when browsing large repositories.
Using the FileSystemWatcher to check index state improves the performance in some cases. Turn this off if you experience refresh problems in commit log.
When you use the stash a lot, it can be useful to show the number of stashed items on the toolbar. This option causes serious slowdowns in large repositories and is turned off by default.
Git Extensions will not allow you to checkout a branch if you have uncommitted changes on the current branch. If you select this option, Git Extensions will display a dialog where you can decide what to do with uncommitted changes before swapping branches.
This number specifies the maximum number of commits that
Git Extensions will load when it is started. These commits are shown in the Commit Log window. To see more commits than are loaded, then this setting will need to be adjusted and Git
Extensions restarted.
When a process is finished, close the process dialog automatically. Leave this option off if you want to see the result of processes. When a process has failed, the dialog will automatically remain open.
Git Extensions uses command line tools to access the git repository. In some environments it might be useful to see the command line dialog when a process is executed. An option on the command line dialog window displayed allows this
Use patience diff algorithm
Include untracked files in stash setting to be turned off.
Use the Git ‘patience diff’ algorithm instead of the default.
This algorithm is useful in situations where two files have diverged significantly and the default algorithm may become
‘misaligned’, resulting in a totally unusable conflict file.
If checked, when a stash is performed as a result of any action except a manual stash request, e.g. checking out a new branch and requesting a stash then any files not tracked by git will
Follow renames in file history
(experimental)
Play Special Startup Sound also be saved to the stash.
Try to follow file renames in the file history.
Open last working dir on startup When starting Git Extensions, open the last used repository
(bypassing the Start Page).
Play a sound when starting Git Extensions. It will put you in a good moooooood!
Default clone destination
Revision grid quick search timeout [ms]
Git Extensions will pre-fill destination directory input with value of this setting on any form used to perform repository clone.
The timeout (milliseconds) used for the quick search feature
SMTP server name
Use SSL/TLS in the revision graph. The quick search will be enabled when you start typing and the revision graph has the focus.
SMTP server to use for sending patches.
SMTP port number to use.
Check this box if the SMTP server uses SSL or TLS.
17
Git Extensions Documentation, Release 2.48
3.4 Commit dialog
This page contains settings for the Git Extensions Commit dialog.
Group Setting
Show errors when staging files
Behaviour
Compose commit messages in Commit dialog (otherwise the message will be requested during commit)
Number of previous messages in commit dialog
Show additional buttons in commit button area
Description
If an error occurs when files are staged (in the Commit dialog), then the process dialog showing the results of the git command is shown if this setting is checked.
If this is unchecked, then commit messages cannot be entered in the commit dialog. When the Commit button is clicked, a new editor window is opened where the commit message can be entered.
The number of commit messages, from the top of the current branch, that will be made available from the Commit message combo box on the Commit dialog.
Tick the boxes in this sub-group for any of the additional buttons that you wish to have available below the commit button. These buttons are considered additional to basic functionality and have consequences if you should click them accidentally, including resetting unrecorded work.
3.5 Appearance
This page contains settings that affect the appearance of the application.
3.4. Commit dialog 18
Group
General
Author images
Fonts
Language
3.5. Appearance
Git Extensions Documentation, Release 2.48
Setting Description
Show relative date instead of full date Show relative date, e.g. 2 weeks ago, instead of full date.
Displayed on the commit tab on the main Commit
Log window.
Show current branch in Visual Studio Determines whether or not the currently checked out branch is dis-
Auto scale user interface when high
DPI is used
Truncate long filenames played on the Git Extensions toolbar within Visual Studio.
Automatically resize controls and their contents according to the current system resolution of the display, measured in dots per inch (DPI).
This setting affects the display of filenames in a component of a window e.g. in the Diff tab of the Commit Log window. The options that can be selected are:
None
: no truncation occurs; a horizontal scroll bar is used to see the whole filename.
Compact
: no horizontal scroll bar.
Filenames are truncated at both start and end to fit into the width of the display component.
Trimstart
: no horizontal scroll bar. Filenames are truncated at the start only.
FileNameOnly
: the path is always removed, leaving only the name of the file, even if there is space for the path.
Get author image from gravatar.com
If checked, gravatar will be accessed to retrieve an image for the author of commits. This image is displayed on the commit tab on the main Commit
Image size
Cache images
No image service
Clear image cache button
Log window.
The display size of the user image.
The number of days to elapse before gravatar is checked for any changes to an authors image.
If the author has not set up their own image, then gravatar can return an image based on one of these services.
Clear the cached avatars.
Code font
Application font
Commit font
Language (restart required)
Dictionary for spelling checker
Change the font used for the display of file contents.
Change the font used on Git Extensions windows and dialogs.
Change the font used for entering a commit message in the Commit dialog.
Choose the language for the Git Extensions interface.
19
Choose the dictionary to use for the spelling checker in the Commit dialog.
Git Extensions Documentation, Release 2.48
3.6 Revision Links
You can configure here how to convert parts of a revision into clickable links. These links will be located under the commit message on the Commit tab in the Related links section.
Setting
Categories
Name
Enabled
Search in
Search pattern/Nested pattern
Links:
Caption/URI
Description
Lists all the currently defined Categories. Click the Add button to add a new empty Category.
The default name is ‘new’. To remove a Category select it and click the Remove button.
This is the Category name used to match the same categories defined on different levels of the
Settings.
Indicates whether the Category is enabled or not. Disabled categories are skipped while creating links.
List of revision parts that will be checked when searching for matching text to be converted into links. Only the checked parts will be searched for matches.
Regular expression used for matching text in chosen revision parts. Each matched fragment will be used to create a new link. More than one fragment can be used in a single link by using a capturing group. A capturing group value can be passed to a link by using zero-based indexed placeholders in a link format definition e.g. {0}. Nested pattern can be used when only part of the text matched by the Search pattern should be used to format the link. When the Nested pattern is empty, matches found by the Search pattern are used to create links.
List of links to be created from a single match. Each link consists of the Caption to be displayed and the URI to be opened when the link is clicked on. In addition to the standard zero-based indexed placeholders, the %COMMIT_HASH% placeholder can be used to put the commit’s hash into the link. For example: https://github.com/gitextensions/gitextensions/commit/%COMMIT_HASH%
3.7 Colors
This page contains settings to define the colors used in the application.
3.6. Revision Links 20
Git Extensions Documentation, Release 2.48
Group Setting
Multicolor branches
Striped branch change borders
Draw non relatives graph gray
Draw non relatives text gray
Color tag
Color branch
Color remote branch
Color other label
Icon style
Application Icon
Icon color
Color removed line
Color removed line highlighting
Color added line highlighting
Color section
Description
Displays branch commits in different colors if checked. If unchecked, all branches are shown in the same color. This color can be selected.
When a new branch is created from an existing branch, the common part of the history is shown in a ‘hatch’ pattern.
Outlines branch commits in a black border if checked.
Show commit history in gray for branches not related to the current branch.
Show commit text in gray for branches not related to the current branch.
Color to show tags in.
Color to show branch names in.
Color to show remote branch names in.
Color to show other labels in.
Change icons. Useful for recognising various open instances.
Changes color of the selected icons.
Highlight color for lines that have been removed.
Highlight color for lines that have been added.
Highlight color for characters that have been removed in lines.
Highlight color for characters that have been added in lines.
Highlight color for a section.
3.8 Start Page
This page allows you to add/remove or modify the Categories and repositories that will appear on the Start Page when
Git Extensions is launched. Per Category you can either configure an RSS feed or add repositories. The order of both
Categories, and repositories within Categories, can be changed using the context menus in the Start Page. See
for further details.
Setting
Categories
Caption
Type
RSS Feed
Description
Lists all the currently defined Categories. Click the Add button to add a new empty Category. The default name is ‘new’. To remove a Category select it and click Remove. This will delete the
Category and any repositories belonging to that Category.
This is the Category name displayed on the Start Page.
Specify the type: an RSS feed or a repository.
Enter the URL of the RSS feed.
repository, click on a blank line and type the appropriate information. The contents of the Path field are shown on the Start Page as a link to your repository if the Title field is blank. If the Title field is non-blank, then this text is shown as the link to your repository. Any text in the
Description field is shown underneath the repository link on the Start Page.
An RSS Feed can be useful to follow repositories on GitHub for example.
See this page on GitHub: https://help.github.com/articles/viewing-your-feeds . You can also follow commits on public GitHub repositories by
1. In your browser, navigate to the public repository on GitHub.
2. Select the branch you are interested in.
3.8. Start Page 21
Git Extensions Documentation, Release 2.48
3. Click on the Commits tab.
4. You will find a RSS icon next to the words “Commit History”.
5. Copy the link
6. Paste the link into the RSS Feed field in the Settings - Start Page as shown above.
Your Start Page will then show each commit - clicking on a link will open your browser and take you to the commit on GitHub.
3.9 Git Config
This page contains some of the settings of Git that are used by and therefore can be changed from within Git Extensions.
If you change a Git setting from the Git command line using git config then the same change in setting can be seen inside Git Extensions. If you change a Git setting from inside Git Extensions then that change can be seen using git config --get
.
Git configuration can be global or local configuration. Global configuration applies to all repositories. Local configuration overrides the global configuration for the current repository.
Group
Line endings
Setting
User name
User email
Editor
Mergetool
Description
User name shown in commits and patches.
User email shown in commits and patches.
Editor that git.exe opens (e.g. for editing commit message). This is not used by Git
Extensions, only when you call git.exe from the command line. By default Git will use the built in editor.
Merge tool used to solve merge conflicts. Git Extensions will search for common merge tools on your system.
Path to mergetool
Mergetool command
Path to merge tool. Git Extensions will search for common merge tools on your system.
Command that Git uses to start the merge tool. Git Extensions will try to set this
Keep backup
(.orig) after merge
Difftool automatically when a merge tool is chosen. This setting can be left empty when Git supports the mergetool (e.g. kdiff3).
Check to save the state of the original file before modifying to solve merge conflicts.
Refer to Git configuration setting ‘mergetool.keepBackup‘.
Diff tool that is used to show differences between source files. Git Extensions will search for common diff tools on your system.
Path to difftool The path to the diff tool. Git Extensions will search for common diff tools on your system.
DiffTool command
Path to commit template
Command that Git uses to start the diff tool. This setting should only be filled in when Git doesn’t support the diff tool.
A path to a file whose contents are used to pre-populate the commit message in the commit dialog.
Checkout/commit radio buttons
Choose how git should handle line endings when checking out and checking in files.
Refer to https://help.github.com/articles/dealing-with-line-endings#platform-all
Files content encoding
The default encoding for file contents.
3.9. Git Config 22
Git Extensions Documentation, Release 2.48
3.10 Build server integration
This page allows you to configure the integration with build servers. This allows the build status of each commit to be displayed directly in the revision log, as well as providing a tab for direct access to the Build Server build report for the selected commit.
Group
General
Jenkins
Setting
Enable build server integration
Show build status summary in revision log
Build server type
Jenkins server URL
Project name
Description
Check to globally enable/disable the integration functionality.
Check to show a summary of the build results with the commits in the main revision log.
Select an integration target.
Enter the URL of the server (and port, if applicable).
Enter the name of the project which tracks this repository in Jenkins.
TeamCity
TeamCity server URL Enter the URL of the server (and port, if applicable).
Project name Enter the name of the project which tracks this repository in TeamCity.
Build Id Filter
Multiple project names can be entered separated by the | character.
Enter a regexp filter for which build results you want to retrieve in the case that your build project creates multiple builds. For example, if your project includes both devBuild and docBuild you may wish to apply a filter of
“devBuild” to retrieve the results from only the program build.
Enter the URL of the server (and port, if applicable).
Tfs server (Name or
URL)
Team Foundation
Team collection name
Project name
Build definition name
(use first found if left empty)
Enter the name of the project which tracks this repository in Tfs.
3.11 SSH
This page allows you to configure the SSH client you want Git to use. Git Extensions is optimized for PuTTY. Git
Extensions will show command line dialogs if you do not use PuTTY and user input is required (unless you have configured SSH to use authentication with key instead of password). Git Extensions can load SSH keys for PuTTY when needed.
3.10. Build server integration 23
Git Extensions Documentation, Release 2.48
Group Setting
PuTTY radio
Description
Use PuTTY as SSH client.
OpenSSH radio button
Other ssh client radio button
Use OpenSSH as SSH client.
Use another SSH client. Enter the path to the SSH client you wish to use.
Path to Enter the path to the plink.exe executable.
plink.exe
Configure PuTTY
Path to puttygen Enter the path to the puttygen.exe executable.
Path to pageant Enter the path to the pageant.exe executable.
Automatically start authentication
If an SSH key has been configured, then when accessing a remote repository the key will automatically be used by the SSH client if this is checked.
Command
Configure Git credential helper
Suggest button
Enter the helper string for the Git “Credential Helper”. This setting is the global Git configuration credential.helper, see http://git-scm.com/docs/gitcredentials . By way of example, the setting for git-credential-winstore , when installed from the full installation package for
Git Extensions, is:
!"C:/Program Files
(x86)/GitExtensions/GitCredentialWinStore/git-credential-winstore.exe"
.
The setting begins with ”!” so the setting is considered as a shell snippet and everything after the ”!” becomes the command. Use the Browse button to find the executable in your file system.
Suggest an appropriate setting for the Git credential helper. This works only if the program git-credential-winstore.exe is installed in the
“GitCredentialWinStore” folder under your Git Extensions installation.
Note: If you get errors relating to git-credential-winstore, ensure that your setting for the Git credential helper command in Git Extensions has " at the start and end and not \". When viewed in the global Git configuration file,
.gitconfig
in your user directory, you should find the setting does show the escaped quotation marks \" (but not
\\\" ). Also ensure that you do indeed have the program file git-credential-winstore.exe in the specified directory as you may have a setting retained from a previous installation of the credential helper program.
3.12 Scripts
This page allows you to configure specific commands to run before/after Git actions or to add a new command to the
User Menu. The top half of the page summarises all of the scripts currently defined. If a script is selected from the summary, the bottom half of the page will allow modifications to the script definition.
A hotkey can also be assigned to execute a specific script. See
3.12. Scripts 24
Git Extensions Documentation, Release 2.48
Setting
Add button
Remove button
Description
Adds a new script. Complete the details in the bottom half of the screen.
Removes a script.
Up/Down Arrows Changes order of scripts.
Name The name of the script.
Enabled
Ask for confirmation
If checked, the script is active and will be performed at the appropriate time (as determined by the On Event setting).
If checked, then a popup window is displayed just before the script is run to confirm whether or not the script is to be run. Note that this popup is not displayed when the script is added as a command to the User Menu (On Event setting is ShowInUserMenuBar).
Run in background
Add to revision grid context menu
Command
Arguments
On Event
If checked, the script will run in the background and Git Extensions will return to your control without waiting for the script to finish.
If checked, the script is added to the context menu that is displayed when right-clicking on a line in the Commit Log page.
Enter the command to be run. This can be any command that your system can run e.g. an executable program, a .bat script, a Python command, etc. Use the Browse button to find the command to run.
Enter any arguments to be passed to the command that is run. The Help button displays items that will be resolved by Git Extensions before executing the command e.g. {cBranch} will resolve to the currently checked out branch, {UserInput} will display a popup where you can enter data to be passed to the command when it is run.
Select when this command will be executed, either before/after certain Git commands, or displayed on the User Menu bar.
3.13 Hotkeys
This page allows you to define keyboard shortcuts to actions when specific pages of Git Extensions are displayed. The
HotKeyable Items identifies a page within Git Extensions. Selecting a Hotkeyable Item displays the list of commands on that page that can have a hotkey associated with them.
The Hotkeyable Items consist of the following pages
1. Commit: the page displayed when a Commit is requested via the Commit User Menu button or the
Commands/Commit menu option.
2. Browse: the Commit Log page (the page displayed after a repository is selected from the Start Page).
3. RevisionGrid: the list of commits on the Commit Log page.
4. FileViewer: the page displayed when viewing the contents of a file.
5. FormMergeConflicts: the page displayed when merge conflicts are detected that need correcting.
6. Scripts: shows scripts defined in Git Extensions and allows shortcuts to be assigned. Refer
Setting
Hotkey
Apply
Clear button button
Reset all Hotkeys to defaults button
Description
After selecting a Hotkeyable Item and the Command, the current keyboard shortcut associated with the command is displayed here. To alter this shortcut, click in the box where the current hotkey is shown and press the new keyboard combination.
Click to apply the new keyboard combination to the currently selected Command.
Sets the keyboard shortcut for the currently selected Command to ‘None’.
Resets all keyboard shortcuts to the defaults (i.e. the values when Git Extensions was first installed).
3.13. Hotkeys 25
Git Extensions Documentation, Release 2.48
3.14 Shell Extension
When installed, Git Extensions adds items to the context menu when a file/folder is right-clicked within Windows
Explorer. One of these items is Git Extensions from which a further (cascaded) menu can be opened. This settings page determines which items will appear on that cascaded menu and which will appear in the main context menu. Items that are checked will appear in the cascaded menu.
To the right side of the list of check boxes is a preview that shows you how the Git Extensions menu items will be arranged with your current choices.
By default, what is displayed in the context menu also depends on what item is right-clicked in Windows Explorer; a file or a folder (and whether the folder is a Git repository or not). If you want Git Extensions to always include all of its context menu items, check the box Always show all commands.
3.15 Advanced
This page allows advanced settings to be modified. Clicking on the ‘+’ symbol on the tree of settings will display further settings. Refer
Group Setting
Always show checkout
Checkout dialog
General
Use last chosen “local changes” action as default action.
Don’t show help images
Always show advanced options
Description
Always show the Checkout Branch dialog when swapping branches. This dialog is normally only shown when uncommitted changes exist on the current branch
This setting works in conjunction with the ‘Git Extensions/Check for uncommitted changes in checkout branch dialog’ setting. If the ‘Check for uncommitted changes’ setting is checked, then the Checkout Branch dialog is shown only if this setting is unchecked. If this setting is checked, then no dialog is shown and the last chosen action is used.
In the Pull, Merge and Rebase dialogs, images are displayed by default to explain what happens with the branches and their commits and the meaning of LOCAL, BASE and REMOTE (for resolving merge conflicts) in different merge or rebase scenarios. If checked, these Help images will not be displayed.
In the Push, Merge and Rebase dialogs, advanced options are hidden by default and shown only after you click a link or checkbox. If this setting is checked then these options are always shown on those dialogs.
3.16 Confirmations
This page allows you to turn off certain confirmation popup windows.
3.14. Shell Extension 26
Git Extensions Documentation, Release 2.48
Group Setting
Amend last commit
Apply stashed
Don’t ask to confirm to changes after successful pull
Apply stashed changes after successful checkout
Add a tracking reference for newly pushed branch
Push a new branch for the remote
Update submodules on checkout
Description
If checked, do not display the popup warning about the rewriting of history when you have elected to amend the last committed change.
In the Pull dialog, if Auto stash is checked, then any changes will be stashed before the pull is performed. Any stashed changes are then re-applied after the pull is complete. If this setting is checked, the stashed changes are applied with no confirmation popup.
In the Checkout Branch dialog, if Stash is checked, then any changes will be stashed before the branch is checked out. If this setting is checked, then the stashed changes will be automatically re-applied after successful checkout of the branch with no confirmation popup.
When you push a local branch to a remote and it doesn’t have a tracking reference, you are asked to confirm whether you want to add such a reference. If this setting is checked, a tracking reference will always be added if it does not exist.
When pushing a new branch that does not exist on the remote repository, a confirmation popup will normally be displayed. If this setting is checked, then the new branch will be pushed with no confirmation popup.
When you check out a branch from a repository that has submodules, you will be asked to update the submodules. If this setting is checked, the submodules will be updated without asking.
3.17 Plugins
Plugins provide extra functionality for Git Extensions.
Plugin
Auto compile SubModules
Periodic background fetch
Setting Description
This plugin proposes (confirmation required) that you automatically build submodules after they are updated via the GitExtensions Update submodules command.
Enabled (true/false)
Path to msbuild.exe
msbuild.exe arguments
Enter true to enable the plugin, or false to disable.
Enter the path to the msbuild.exe executable.
Enter any arguments to msbuild.
This plugin keeps your remote tracking branches up-to-date automatically by fetching periodically.
Arguments of git command to run Enter the git command and its arguments into the edit box. The default command is fetch --all, which will fetch all branches from all remotes. You can modify the command if you would prefer, for example, to fetch only a specific remote, e.g. fetch upstream.
Fetch every (seconds)
Refresh view after fetch
Fetch all submodules
Enter the number of seconds to wait between each fetch. Enter 0 to disable this plugin.
If checked, the commit log and branch labels will be refreshed after the fetch. If you are browsing the commit log and comparing revisions you may wish to disable the refresh to avoid unexpected changes to the commit log.
If checked, also perform “git fetch –all” recursively on all configured submodules as part of the periodic background fetch.
Create local tracking branches This plugin will create local tracking branches for all branches on a remote repository. The remote repository is specified when the plugin is run.
This plugin allows you to delete obsolete branches i.e. those branches that are fully merged to another branch. It will display a list of obsolete branches for review before deletion.
Delete obsolete branches Delete obsolete branches older than (days) Select branches created greater than the specified number of days ago.
Branch where all branches should be merged The name of the branch where a branch must have been merged into to be considered obsolete.
Find large files
Gerrit Code Review
GitFlow
Github
Impact Graph
Statistics
Finds large files in the repository and allows you to delete them.
Find large files bigger than (Mb) Specify what size is considered a ‘large’ file.
The Gerrit plugin provides integration with Gerrit for GitExtensions. This plugin has been based on the git-review tool. For more information see: http://code.google.com/p/gerrit/
The GitFlow plugin provides high-level repository operations for Vincent Driessen’s branching model For more information see: https://github.com/nvie/gitflow
This plugin will create an OAuth token so that some common GitHub actions can be integrated with Git Extensions. For more information see: https://github.com/
OAuth Token The token generated and retrieved from GitHub.
This plugin shows in a graphical format the number of commits and counts of changed lines in the repository performed by each person who has committed a change.
This plugin provides various statistics (and a pie chart) about the current Git repository. For example, number of commits by author, lines of code per language.
Code files
Directories to ignore (EndsWith)
Ignore submodules (true/false)
Specifies extensions of files that are considered code files.
Ignore these directories when calculating statistics.
Ignore submodules when calculating statistics.
Continued on next page
3.17. Plugins 27
Git Extensions Documentation, Release 2.48
Plugin gource
Proxy Switcher
Release Notes Generator
Create Stash Pull Request
Setting Description
Gource is a software version control visualization tool. For more information see: https://code.google.com/p/gource/
Path to “gource” Enter the path to the gource software.
Arguments Enter any arguments to gource.
Table 3.1 – continued from previous page
This plugin can set/unset the value for the http.proxy git config file key as per the settings entered here.
Username The user name needed to access the proxy.
Password
HttpProxy
The password attached to the username.
Proxy Server URL.
HttpProxyPort Proxy Server port number.
This plugin will generate ‘release notes’. This involves summarising all commits between the specified from and to commit expressions when the plugin is started. This output can be copied to the clipboard in various formats.
If your repository is hosted on Atlassian Stash then this plugin will enable you to create a pull request for Stash from Git Extensions For more information see: https://www.atlassian.com/software/stash
Stash Username The username required to access Stash.
Stash Password
Specify the base URL to Stash
Disable SSL verification
The password required to access Stash.
The URL from which you will access Stash.
Check this option if you do not require SSL verification to access Stash.
3.17. Plugins 28
CHAPTER
4
Browse Repository
You can browse a repository by starting Git Extensions and select the repository to open. The main window contains the commit log. You could also open the ‘Browse’ window from the shell extensions and from the Visual Studio IDE.
4.1 View commit log
The full commit history can be browsed. There is a graph that shows branches and merges. You can show the difference between any two revisions by selecting them using ctrl-click.
In the context menu of the commit log you can enable or disable the revision graph. You can also choose to only show the current branch instead of showing all branches. The other options will be discussed later.
29
Git Extensions Documentation, Release 2.48
4.2 Search or filter the commit history
You can find text in the commit messages or jump to a specific commit in the current commit history shown in Git
Extensions. You can also filter the commit history so that fewer commits are shown.
4.2.1 Quick search in history
You can find a commit in the commit history that is shown in Git Extensions by searching for text in the commit message, branch label or tag. This is a quick search function. Simply click into the commit history to give that pane focus and start typing. Git Extensions will show your search term in the top left corner and will immediately jump to the next commit with matching text. You can search for the next or previous commit with matching text using
Alt-Down Arrow or Alt-Up Arrow.
In Settings, Git Extensions you can change the timeout for typing the text for the quick search.
4.2. Search or filter the commit history 30
Git Extensions Documentation, Release 2.48
4.2.2 Go to a specific commit
You can jump to a particular commit in the commit history if you know the SHA, tag or branch. In fact you can use any expression valid for git-rev-parse. Select Navigate, Go to commit or press Ctrl-Shift-G to open the
Go to commit window. Enter an SHA or other term to be passed to git-rev-parse into the box at the top and click
Go
, or select a branch or tag from one of the two combo boxes below.
4.2.3 Filter history
The history can be filtered using regular expressions and basic filter terms. Filtering will reduce the number of commits that are shown in the Git Extensions commit history. The quick filter in the toolbar filters by the commit message, the author and/or the committer.
In the context menu of the commit log you can open the advanced filter dialog. The advanced filter dialog allows you to filter for more specific commits. To remove the filter either remove the filter in the toolbar and press enter or remove the filter in the advanced filter dialog.
4.2. Search or filter the commit history 31
Git Extensions Documentation, Release 2.48
4.3 Singe file history
To display the single file history, right click on a file name in the File tree or in the Diff tab and select File history
.
The single file history viewer shows all revisions of a single file. You can view the content of the file in after each commit in the View tab.
4.3. Singe file history 32
Git Extensions Documentation, Release 2.48
You can view the difference report from the commit in the Diff tab.
Note: Added lines are marked with a +, removed lines are marked with a -.
4.3. Singe file history 33
Git Extensions Documentation, Release 2.48
4.4 Blame
There is a blame function in the file history browser. It shows the last person editing a single line.
Double clicking on a code line shows the full commit introducing the change.
4.4. Blame 34
CHAPTER
5
Commit
A commit is a set of changes with some extra information. Every commit contains the follow information:
• Changes
• Committer name and email
• Commit date
• Commit message
• Cryptographically strong SHA1 hash
Each commit creates a new revision of the source. Revisions are not tracked per file; each change creates a new revision of the complete source. Unlike most traditional source control management systems, revisions are not named using a revision number. Each revision is named using a SHA1, a 41 long characters cryptographically strong hash.
5.1 Commit changes
Changes can be committed to the local repository. Unlike most other source control management systems you do not need to checkout files before you start editing. You can just start editing files, and review all the changes you made in the commit dialog later. When you open the commit dialog, all changes are listed in the top-left.
35
Git Extensions Documentation, Release 2.48
There are three kinds of changes:
Untracked
This file is not yet tracked by Git. This is probably a new file, or a file that has not been committed to
Git before.
Modified This file is modified since the last commit.
Deleted This file has been deleted.
When you rename or move a file Git will notice that this file has been moved, but currently Git Extensions does not show this in the commit dialog.
During your initial commit there are probably lots of files you do not want to be tracked. You can ignore these files by not staging them, but they will show every time. You can instead add them to the .gitignore file of your repository.
Files that are in the .gitignore file will not show up in the commit dialog again. You can open the .gitignore
editor from the menu Working dir changes by selecting Edit ignored files.
5.1. Commit changes 36
Git Extensions Documentation, Release 2.48
Making a commit is a two step procedure:
• Staging the changes to be committed, which saves a snapshot of the changes into the Git “index”.
• Committing those staged changes, which records the staged changes and other information into the repository.
You do not have to commit immediately after staging changes. You can close the commit dialog, make further changes to the files in the working dir, then re-open the commit dialog to stage further changes and commit. Changes that you have staged previously will still be staged when you re-open the dialog.
5.1.1 Staging changes
The changes that you have made to your working directory are not automatically included in a commit. You must choose which of the changed files, or individual changes from within those files, will be included in the commit by
“staging” the changes in Git Extensions. Staging changes in Git Extensions is the same as using git add on the Git command line.
You can stage the changes you want to commit by selecting the files in the top-left or “Unstaged changes” pane and pressing the Stage button or pressing the [S] key. The file entries will move to the lower left or “Staged changes” pane. You need to stage deleted files because you stage the change and not the file. If you have staged changes from a file and you wish to exclude those changes from the commit, select the entry in the staged changes pane and press the
Unstage button or press the [U] key.
If the file that is selected in either the unstaged or staged changes pane is text format, Git Extensions will show a Git
“diff” view in the right side pane of the window.
5.1.2 Staging selected lines
You do not have to commit all of the changes in a text format file in one commit. You can select and stage individual lines from within a file such that only the chosen lines will be included in your next commit; the remaining changes in the file will appear as unstaged changes for the next commit.
In the diff view on the right, select the line or lines that you want to stage then right-click and choose Stage selected line(s) or press the [S] key. The file will now appear in both the staged changes and unstaged changes panes on the left since now there are both staged and unstaged changes in the same file. The change that was selected will disappear from the diff view on the right because the diff view is showing only the unstaged changes.
To see the line changes that have been staged select the entry for the file in the staged changes pane. To unstage selected changed lines from a file, select that file in the staged changes pane, then select the line or lines in the diff view, right -click, and choose Unstage selected line(s) or press the [U] key.
Note: If you select an entire line including the end-of-line character then staging or unstaging that line will include both the selected line and the next line. To select a single line to stage or unstage you may simply click onto the line without selecting any particular characters.
Note: Staging and unstaging individual lines from a file does not change the file itself. It is simply choosing which changes from within that file will be included in the next commit.
5.1.3 Undoing or resetting changes
You can undo or reset changes to files from the commit dialog. You can only do this from the top-left or “Unstaged changes” pane. If you have already staged the changes then you must first unstage them as described above. To reset the changes in a file, select the file in the unstaged changes pane, right-click and choose Reset file or directory changes or press the [R] key.
5.1. Commit changes 37
Git Extensions Documentation, Release 2.48
You can reset individual changed lines in a similar way to staging and unstaging individual lines, which are described above. To reset an individual line, select the line or lines in the diff view on the right then right-click and choose
Reset selected lines or press the [R] key.
Warning: Resetting changes modifies the file, discarding either all of the changes or the changes on the selected lines.
5.1.4 Making the commit
When all the changes you want to commit are staged, enter a commit message into the lower-right pane and press the commit button.
5.1. Commit changes 38
Git Extensions Documentation, Release 2.48
It is also possible to add changes to your last commit by checking the Amend Commit checkbox. This can be very useful when you forgot some changes. This function rewrites history; it deletes the last commit and commits it again including the added changes. Make sure you only use Amend Commit when the commit is not yet published to a remote repository.
There is a built-in spelling checker that checks the commit message. Incorrectly spelled words are underlined with a wavey red line. Right-click on the misspelled word to choose the correct spelling or choose one of the other options.
5.1. Commit changes 39
Git Extensions Documentation, Release 2.48
Git Extensions installs a number of dictionaries by default. You can choose another language in the context menu of the spelling checker or in the settings dialog. To add a new spelling dictionary add the dictionary file to the
Dictionaries folder inside the Git Extensions installation folder.
5.1. Commit changes 40
Git Extensions Documentation, Release 2.48
5.2 Cherry pick commit
A commit can be recommitted by using the cherry pick function. This can be very useful when you want to make the same change on multiple branches.
5.2. Cherry pick commit 41
Git Extensions Documentation, Release 2.48
5.3 Revert commit
A commit cannot be deleted once it is published. If you need to undo the changes made in a commit, you need to create a new commit that undoes the changes. This is called a revert commit.
5.4 Stash changes
If there are local changes that you do not want to commit yet and not want to throw away either, you can temporarily stash them. This is useful when working on a feature and you need to start working on something else for a few hours.
You can stash changes away and then reapply them to your working dir again later. Stashes are typically used for very short periods.
5.3. Revert commit 42
Git Extensions Documentation, Release 2.48
You can create multiple stashes if needed. Stashes are shown in the commit log with the text [stash].
The stash is especially useful when pulling remote changes into a dirty working directory. If you want a more permanent stash, you should create a branch.
5.4. Stash changes 43
CHAPTER
6
Tag
Tags are used to mark a specific version. Usually a tag will not be moved anymore. The image below shows the commit log of Git Extensions with two tags indicating version [1.08] and [1.06].
6.1 Create tag
In Git Extensions you can tag a revision by choosing Create new tag in the commit log context menu. A dialog will prompt for the name of the tag. You can also choose Create tag from the Commands menu, which will show a dialog to choose the revision and enter the tag name.
Once a tag is created, it cannot be moved again. You need to delete the tag and create it again to move it.
44
Git Extensions Documentation, Release 2.48
6.2 Delete tag
For some operation it is very useful to create tags for temporary usage. Git uses SHA1 hashes to name each commit.
When you want to merge with an unnamed branch it is good practise to tag the unnamed branch, merge with the tag and then delete the tag again.
6.2.1 Re-Tag?
Read about “What should you do when you tag a wrong commit and you would want to re-tag?” here: https://www.kernel.org/pub/software/scm/git/docs/git-tag.html#_on_re_tagging
6.2. Delete tag 45
CHAPTER
7
Branches
Branches are used to commit changes separate from other commits. It is very common to create a new branch when you start working on a feature to keep the work done on that feature separate from other work. When the feature is complete the branch can be merged or rebased as you choose such that the commits for the feature either remain as a parallel branch or appear as a continuous single line of development as if the branch had never existed in the first place. The image on the right illustrates a branch created on top of commit B.
You can see the name of your current branch in a combo box in the toolbar. You can switch to another branch by choosing from the combo box list. In the commit log the current branch has an arrow head to the left of its name. If you are not currently on a branch because you have checked out a specific commit but not any particular branch then
Git Extensions will show (no branch) in place of a branch name in the toolbar. This is called “Detached HEAD mode”. In Git you can refer to your current branch or commit by the special reference HEAD in place of the branch name or commit reference.
7.1 Create branch
In Git Extensions there are multiple ways to create a new branch. In the image below I create a new branch from the context menu in the commit log. This will create a new branch on the revision that is selected.
46
Git Extensions Documentation, Release 2.48
I will create a new branch called Refactor. In this branch I can do whatever I want without affecting others. The default in Git Extensions is to check out a new branch after it is created. If you want to create a new branch but remain on your current branch, uncheck the Checkout after create checkbox in the Create branch dialog.
When the branch is created you will see the new branch Refactor in the commit log. If you chose to checkout this branch the next commit will be committed to the new branch.
Creating branches in Git requires only 41 bytes of space in the repository. Creating a new branch is very easy and fast.
The complete work flow of Git is optimized for branching and merging.
7.1.1 Orphan branches
In special cases it is helpful to have orphan branches (see for example https://www.google.com/search?q=why+use+orphan+branches+in+git ).
Check the “Create orphan” checkbox to create an orphan branch (--orphan option in git).
The newly created branch will have no parent commits.
The option “Clear working dir and index” (git rm -rf) is active by default. So the working dir and index will be cleared. If you uncheck the last option then the working dir and index will not be touched.
7.2 Checkout branch
You can switch from the current branch to another branch using the checkout command. Checking out a branch sets the current branch and updates all of the source files in the working directory. Uncommitted changes in the working directory can be overwritten so it is best practice to make sure your working directory is clean by either committing or stashing any current changes before checking out a branch. If you do not clean your working directory then, in the
Checkout branch dialog, you can choose between four options for your local uncommitted changes:
7.2. Checkout branch 47
Git Extensions Documentation, Release 2.48
Don’t change
Merge
Stash
Reset
Local changes will be retained if there are not conflicting changes from the branch you are checking out.
Performs a three-way merge between your current branch, your local changes and the branch you are checking out.
Your local changes are stashed and the new branch is checked out. You can retrieve your changes on the new branch with stash-pop.
Your local changes are discarded and the new branch is checked out. Use caution with this option as
Git has no record of uncommitted changes so they cannot be retrieved.
7.3 Merge branches
In the image below there are two branches, [Refactor] and [master]. We can merge the commits from the master branch into the Refactor branch. If we do this, the Refactor branch will be up to date with the master branch, but not the other way around. As long as we are working on the Refactor branch we cannot touch the master branch itself. We can merge the sources of master into our branch, but cannot make any change to the master branch.
To merge the Refactor branch into the master branch, we first need to switch to the master branch.
7.3. Merge branches 48
Git Extensions Documentation, Release 2.48
Once we are on the master branch we can choose merge by choosing Merge branches from the Commands menu.
In the merge dialog you can verify which branch you are working on. Select the branch to merge with then click the
Merge button.
After the merge the commit log will show the new commit containing the merge. Notice that the Refactor branch is not changed by this merge. If you want to continue working on the Refactor branch you can merge the Refactor branch with master. You can instead delete the Refactor branch if it is not used anymore.
Note: When you need to merge with an unnamed branch you can use a tag to give it a temporary name.
7.3. Merge branches 49
Git Extensions Documentation, Release 2.48
7.4 Rebase branch
The rebase command is the most complex command in Git. The rebase command is very similar to the merge command. Both rebase and merge are used to get a branch up-to-date. The main difference is that rebase can be used to keep the history linear contrary to merges.
A rebase of Refactor on top of master will perform the following actions:
• All commits specific to the Refactor branch will be stashed in a temporary location
• The branch Refactor will be removed
• The branch Refactor will be recreated on the master branch
• All commits will be recommitted in the new Refactor branch
During a rebase merge conflicts can occur. You need to solve the merge conflicts for each commit that is rebased. The rebase function in Git Extensions will guide you through all steps needed for a successful rebase.
The image below shows the commit log after the rebase. Notice that the history is changed and it seems like the commits on the Refactor branch are created after the commits on the master branch.
7.4. Rebase branch 50
Git Extensions Documentation, Release 2.48
Warning: Because this function rewrites history you should only use this on branches that are not published to other repositories yet. When you rebase a branch that is already pushed it will be harder to pull or push to that remote. If you want to get a branch up-to-date that is already published you should merge.
7.5 Delete branch
Since it is common to create many branches, it is often necessary to delete branches. Most commonly you will need to delete branches on which work has finished and their contents are merged into master or your main branch. You can also delete unmerged branches when they are not needed anymore and you do not want to keep the work done in that branch.
When you delete a branch that is not yet merged, all of the commits that are in only the deleted branch will be lost.
When you delete a branch that is already merged with another branch, the merged commits will not be lost because they are also part of another branch.
You can delete a branch using Delete branch from the Commands menu. If you want to delete a branch that is not merged into your current branch (HEAD in Git), you need to check the Force delete checkbox.
7.5. Delete branch 51
CHAPTER
8
Patches
Every commit contains a change-set, a commit date, the committer name, the commit message and a cryptograph
SHA1 hash. Local commits can be published by pushing it to a remote repository. To be able to push you need to have sufficient rights and you need to have access to the remote repository. When you cannot push directly you can create patches. Patches can be e-mailed to someone with access to the repository. Each patch contains an entire commit including the commit message and the SHA1.
8.1 Create patch
Format a single patch or patch series using the format patch dialog. You need to select the newest commit first and then select the oldest commit using ctrl-click. You can also select an interrupted patch series, but this is not recommended because the files will not be numbered.
52
Git Extensions Documentation, Release 2.48
When the patches are created successfully the following dialog will appear.
8.2 Apply patches
It is possible to apply a single patch file or all patches in a directory. When there are merge conflicts applying the patch you need to resolve them before you can continue. Git Extensions will help you applying all patches by marking the next recommended step.
8.2. Apply patches 53
Git Extensions Documentation, Release 2.48
8.2. Apply patches 54
CHAPTER
9
Remote feature
Git is a distributed source control management system. This means that all changes you make are local. When you commit changes, you only commit them to your local repository. To publish your local changes you need to push. In order to get changes committed by others, you need to pull.
9.1 Manage remote repositories
You can manage the remote repositories in the Remotes menu.
When you cloned your repository from a public repository, this remote is already configured. You can rename each remote for easy recognition. The default name after cloning a remote is origin. If you use PuTTY as SSH client you can also enter the private key file for each remote. Git Extensions will load the key when needed. How to create a private key file is described in the next paragraph.
In the Default pull behaviour tab you can configure the branches that need to be pulled and merged by default. If you configure this correctly you will not need to choose a branch when you pull or push. There are two buttons on this dialog:
55
Git Extensions Documentation, Release 2.48
Prune remote branches Throw away remote branches that do not exist on the remote anymore.
Update all remote branch info Fetch all remote branch information.
After cloning a repository you do not need to configure all remote branches manually. Instead you can checkout the remote branch and choose to create a local tracking branch.
9.2 Create SSH key
Git uses SSH for accessing private repositories. SSH uses a public/private key pair for authentication. This means you need to generate a private key and a public key. The private key is stored on your computer locally and the public key can be given to anyone. SSH will encrypt whatever you send using your secret private key. The receiver will then use the public key you send to decrypt the data.
This encryption will not protect the data itself but it protects the authenticity. Because the private key is only available to the sender, the receiver can be sure about the origin of the data. In practise the key pair is only used for the authentication process. The data itself will be encrypted using a key that is exchanged during this initial phase.
9.2.1 PuTTY and github
PuTTY is SSH client that for Windows that is a bit more user friendly then OpenSSH. Unfortunately PuTTY does not work with all servers. In this paragraph I will show how to generate a key for github using putty.
First make sure GitExtensions is configured to use PuTTY and all paths are correct.
9.2. Create SSH key 56
Git Extensions Documentation, Release 2.48
can choose Generate or import key to start the key generator.
9.2. Create SSH key 57
Git Extensions Documentation, Release 2.48
PuTTY will ask you to move the mouse around to generate a more random key. When the key is generated you can save the public and the private key in a file. You can choose to protect the private key with a password but this is not necessary.
Now you have a key pair you need to give github the public key. This can be done in Account Settings in the tab SSH Public Keys. You can add multiple keys here, but you only need one key for all repositories.
9.2. Create SSH key 58
Git Extensions Documentation, Release 2.48
After telling github what public key to use to decrypt, you need to tell GitExtensions what private key to use to encrypt.
In the clone dialog there is a Load SSH key button to load the private key into the PuTTY authentication agent.
This can also be done manually by starting the PuTTY authentication agent and choose add key in the context menu in the system tray.
GitExtensions can load the private keys automatically for you when communicating with a remote. You need to configure the private key for the remote.
This is done in the Manage remote repositories dialog.
9.2.2 OpenSSH and github
When you choose to use OpenSSH you need to configure GitExtensions as shown in the screenshot below.
9.2. Create SSH key 59
Git Extensions Documentation, Release 2.48
OpenSSH is the best SSH client there is but it lacks Windows support. Therefore it is slightly more complex to use.
Another drawback is that GitExtensions cannot control OpenSSH and needs to show the command line dialogs when
OpenSSH might be used. GitExtensions will show the command line window for every command that might require a SSH connection. For this reason PuTTY is the prefered SSH client in GitExtensions.
To generate a key pair in OpenSSH you need to go to the command line. I recommend to use the git bash because the path to OpenSSH is already set.
Type the following command: ssh-keygen -C "[email protected]" -t rsa Use the same email address as the email address used in git. You will be asked where if you want to protect the private key with a password.
This is not necessary.
By default the public and private keys are stored in c:\Documents and
Settings\[User]\.ssh\ or c:\Users\[user]\.ssh\.
9.2. Create SSH key 60
Git Extensions Documentation, Release 2.48
You do not need to tell GitExtensions about the private key because OpenSSH will load it for you. Now open the public key using notepad and copy the key to github. This can be done in Account Settings in the tab SSH
Public Keys on GitHub .
9.3 Pull changes
You can get remote changes using the pull function. Before you can pull remote changes you need to make sure there are no uncommitted changes in your local repository. If you have uncommitted changes you should commit them or stash them during the pull. You can read about how to use the stash in the Stash chapter.
In order to get your personal repository up-to-date, you need to fetch changes from a remote repository. You can do this using the Pull dialog. When the dialog starts the default remote for the current branch is set. You can choose
9.3. Pull changes 61
Git Extensions Documentation, Release 2.48
another remote or enter a custom url if you like. When the remote branches configured correctly, you do not need to choose a remote branch.
If you just fetch the commits from the remote repository and you already committed some changes to your local repository, the commits will be in a different branch. In the pull dialog this is illustrated in the image on the left. This can be useful when you want to review the changes before you want to merge them with your own changes.
When you choose to merge the remote branch after fetching the changes a branch will be created, and will be merged you’re your commit. Doing this creates a lot of branches and merges, making the history harder to read.
Instead of merging the fetched commits with your local commits, you can also choose to rebase your commits on top of the fetched commits. This is illustrated on the left in the image below. A rebase will first undo your local commits
(c and d), then fetch the remote commits (e) and finally recommit your local commits. When there is a merge conflict during the rebase, the rebase dialog will show.
9.3. Pull changes 62
Git Extensions Documentation, Release 2.48
Next to the pull button there are some buttons that can be useful:
Solve conflicts
Stash changes
Auto stash
Load
SSH key
When there are merge conflicts, you can solve them by pressing this button.
When the working dir contains uncommitted changes, you need to stash them before pulling.
Check this checkbox if you want to stash before pulling. The stash will be reapplied after pulling.
This button is only available when you use PuTTY as SSH client. You can press this button to load the key configured for the remote. If no key is set, a dialog will prompt for the key.
9.4 Push changes
In the browse window you can check if there are local commits that are not pushed to a remote repository yet. In the image below the green labels mark the position of the master branch on the remote repository. The red label marks the position of the master branch on the local repository. The local repository is ahead three commits.
To push the changes press Push in the toolbar.
The push dialog allows you to choose the remote repository to push to. The remote repository is set to the remote of the current branch. You can choose another remote or choose a url to push to. You can also specify a branch to push.
9.4. Push changes 63
Git Extensions Documentation, Release 2.48
Tags are not pushed to the remote repository. If you want to push a tag you need to open the Tags tab in the dialog.
You can choose to push a singe tag or all tags. No commits will be pushed when the Tags tab is selected, only tags.
You can not merge your changes in the remote repository. Merging must be done locally. This means that you cannot push your changes before the commits are merged locally. In practice you need to pull before you can push most of the times.
9.4. Push changes 64
CHAPTER
10
Merge Conflicts
When merging branches or commits you can get merge conflicts. Git will try to resolve these, but some conflicts need to be resolved manually. Git Extensions will show warnings when there is a merge conflict.
10.1 Handle merge conflicts
To solve merge conflicts just click on a warning or open the merge conflict dialog from the menu. A dialog will prompt showing all conflicts. You can solve a conflict by double-click on a filename.
There are three kinds of conflicts:
File deleted and changed Use modified or deleted file?
File deleted and created Use created or deleted file?
File changed both locally and remotely Start merge tool.
If the file is deleted in one commit and changed in another commit, a dialog will ask to keep the modified file or delete the file. When there is a conflicting change the merge tool will be started. You can configure the tool you want to use
65
Git Extensions Documentation, Release 2.48
for merge conflicts. The image below shows Perforce P4Merge a free to use merge tool. Git Extensions is packaged with KDiff3, an open source merge tool.
In the merge tool you will see four versions of the same file:
Base
Local
The latest version of the file that exist in both repositories
The latest local version of the file
Remote The latest remote version of the file
Merged The result of the merge
Caution: When you are in the middle of a merge the file named local represents your file. When you are in the middle of a rebase the file named remote represents your file. This can be confusing, so double check if you are in doubt.
10.1. Handle merge conflicts 66
CHAPTER
11
Notes
Notes can be added to a commit. Notes will be stored separately and will not be pushed. To add a new note choose add notes in the context menu of the commit information box.
The editor that has been configured in the settings dialog will be used to enter or edit the notes. The Git Extensions editor is advised.
67
Git Extensions Documentation, Release 2.48
68
CHAPTER
12
Submodules
Large projects can be split into smaller parts using submodules. A submodule contains the name, url and revision of another repository. To create a submodule in an existing git repository you need to add a link to another repository containing the files of the submodule.
12.1 Manage submodules
The current state of the submodules can be viewed with the Manage submodules function. All submodules are shown in the list on the left.
69
Git Extensions Documentation, Release 2.48
Add submodule
Synchronize
Add a new submodule to the repository
Synchronizes the remote URL configuration setting to the value specified in .gitmodules for the selected submodule.
Initialize Initialize the selected submodules, i.e. register each submodule name and url found in
.gitmodules
into .git/config. The submodule will also be updated.
Update Update the registered submodules, i.e. clone missing submodules and checkout the commit specified in the index of the containing repository.
12.2 Add submodule
To add a new submodule choose Add submodule in the Manage submodules dialog.
Path to submodule Path to the remote repository to use as submodule.
Local path
Branch
Local path to this submodule, relative to the root of the current repository.
Branch to track.
12.3 Remove submodule
It is currently not possible to remove a submodule using the Git Extensions user interface. To remove a submodule you need to manually:
• Delete the relevant line from the .gitmodules file.
• Delete the relevant section from .git/config.
• Run git rm --cached path_to_submodule (no trailing slash).
• Commit and delete the now untracked submodule files.
12.2. Add submodule 70
CHAPTER
13
Maintenance
In this chapter some of the functions to maintain a repository are discussed.
13.1 Compress Git database
Git will create a lot of files. You can run the Compress git database to pack all small files building up a repository into one big file. Git will also garbage collect all unused objects that are older then 15 days. When a database is fragmented into a many small files compressing the database can increase performance.
13.2 Recover lost objects
If you accidently deleted a commit you can try to recover it using the Recover lost objects function. A dialog will show you all dangling objects and will allow you to review and recover them.
71
Git Extensions Documentation, Release 2.48
Normally Git will not delete files right away when you remove something from your repository. The reason for this is that you can restore deleted items if you need to. Git will delete removed items when they are older then 15 days and you run Compress git database.
There are several functions to help you find the lost items. By default Git Extensions will only show commits. To show all items, just uncheck the Show only commits option. The other options can be checked/unchecked to get more/less results. Double-click on on item to view the content. When you located the item you want to recover you can tag it using the Tag selected object button.
Git Extensions also is able to tag all lost objects. Doing this will make all lost objects visible again making it very easy to locate the commit(s) you would like to recover. After recovering a commit using the Tag all lost commits button, you can remove all tags using the Delete all LOST_AND_FOUND tags button.
13.2. Recover lost objects 72
Git Extensions Documentation, Release 2.48
13.3 Fix user names
When someone accidentally committed using a wrong username this can be fixed using the Edit .mailmap function. Git will use the username for an email address when it is set in the .mailmap file.
Fix user name using commit email:
Proper Name <[email protected]>
Fix email address using commit email:
13.3. Fix user names 73
Git Extensions Documentation, Release 2.48
<[email protected]> <[email protected]>
Fix email address and name using commit email:
Proper Name <[email protected]> <[email protected]>
Fix email address and name using commit name and email:
Proper Name <[email protected]> Commit Name <[email protected]>
13.4 Ignore files
Git will track all files that are in the working directory. Normally you do not want to exclude all files that are created by the compiler. You can add files that should be ignored to the .gitignore file. You can use wildcards and regular expressions. All entries are case sensitive. The button Add default ignores will add files that should be ignored when using Visual Studio.
A short overview of the syntax:
13.4. Ignore files 74
Git Extensions Documentation, Release 2.48
/
/
*
# Lines started with # are handled as comments
!
Lines started with ! are exclude patterns
[Dd] Characters inside [..] means that 1 of the characters must match
Wildcard
A leading slash matches the beginning of the pathname; for example, /*.c matches cat-file.c but not mozilla-sha1/sha1.c
If the pattern ends with a slash, it is removed for the purpose of the following description, but it would only find a match with a directory. In other words, foo/ will match a directory foo and paths underneath it, but will not match a regular file or a symbolic link foo (this is consistent with the way how pathspec works in general in git).
For more detailed information .
13.4. Ignore files 75
CHAPTER
14
Translations
14.1 Change language
In the settings dialog a translation can be chosen. The translation files are located in a directory located in the Git
Extensions installation directory. The files are readable xml files.
14.2 Translate Git Extensions
The application has a built-in translation tool to help create and edit translations. To open the translation tool choose
Translate in the Help menu.
76
Git Extensions Documentation, Release 2.48
The functions of the translation tool are described in the image below. To contribute any translations you can either e-mail a patch or send a pull request using github.
14.2. Translate Git Extensions 77
During installation you can choose to install the Visual Studio plug-in and shell extensions.
15.1 Visual Studio
There are two options in the context menu on files:
• View the file history by choosing the ‘File history’ option.
• Reset the file changes to the last committed revision.
CHAPTER
15
Integration
78
Git Extensions Documentation, Release 2.48
A Git Extensions toolbar allows you to perform the most common actions.
Commit (branch)
Browse
Pull
Push
Stash changes
Settings
Almost all function can be started from the Git menu in Visual Studio.
15.1. Visual Studio 79
Git Extensions Documentation, Release 2.48
15.2 Windows Explorer
The common commands can be started from Windows Explorer using the shell extensions. This option is only available when Shell Extensions are installed.
15.2. Windows Explorer 80
Git Extensions Documentation, Release 2.48
You can even create or clone a repository in any non git folder.
15.2. Windows Explorer 81
CHAPTER
16
Command line
16.1 Git Extensions command line
Most features can be started from the command line. It is recommended to add gitex.cmd to the path when using from the command line. It is typically stored in the C:\Program Files (x86)\GitExtensions folder.
82
Git Extensions Documentation, Release 2.48
16.1. Git Extensions command line 83
Git Extensions Documentation, Release 2.48
16.1. Git Extensions command line 84
CHAPTER
17
Appendix
17.1 Git Cheat Sheet
Action
Create new repository
Create shared repository
Clone repository
Checkout branch
Create branch
Delete branch
Merge branch (from the branch to merge into):
Solve conflicts (add –tool=kdiff3 if no mergetool is specified)
Command
$ git init
$ git init —bare —shared=all
$ git clone c:/demo1 c:/demo2
$ git checkout <name>
$ git branch <name>
$ git branch -d <name>
$ git merge PDC
$ git mergetool $ git commit
Create tag
Add files/changes (. for all files)
$ git tag <name>
$ git add .
$ git commit –m “Enter commit message” Commit added files/changes (–amend to amend to last commit)
Discard changes $ git reset –hard
Create patch (-M = detect renames –C = detect copies) $ git format-patch –M –C origin
Apply patch without merging $ git apply c:/patch/01-emp.patch
$ git am -–3way —signoff c:/patch/01-emp.patch
Merge patch
Solve conflicts (add –tool=kdiff3 if no mergetool is specified)
$ git mergetool
$ git am —3way -–resolved
Stash changes
Apply stashed changes
Pull changes (add –rebase to rebase instead of merge)
Solve conflicts (add –tool=kdiff3 if no mergetool is specified)
$ git stash
$ git stash apply
$ git pull c:/demo1 master
$ git mergetool
$ git commit
Push changes (in branch $ git push c:/demo1 master master:<new>)
Blame
Help
$ git push c:/demo1
$ git blame –M –w <filename>
$ git <command> –help
85
Git Extensions Documentation, Release 2.48
Here are some default names used by Git.
Default names master default branch origin
HEAD default upstream repository current branch
HEAD^ parent of HEAD
HEAD~4 the great-great grandparent of HEAD
17.2 Menu map
The following image shows GitExtensions’ menu structure at one glance (v2.43):
17.2. Menu map 86
CHAPTER
18
Plugins
18.1 List of the available plugins
• Auto Compile Submodules
• Background Fetch
• Create Local Tracking Branches
• Delete Unused Branches
• Find Large Files
• Gerrit Code Review
• GitFlow
• GitUIPluginInterfaces
• Github
• Gource
• Proxy Switcher
• Release Notes Generator
• Statistics
18.2 GitFlow
This plugin permit to manage your _branching model: http://nvie.com/posts/a-successful-git-branching-model/ with
_GitFlow: https://github.com/nvie/gitflow in GitExtension
You should have GitFlow installed to use this plugin.
The GitFlow plugin permit to : - init gitflow in your git repository - create your feature, hotfix, release or support branch - manage (pull, publish or finish) your existing gitflow branches
87
advertisement
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project
advertisement
Table of contents
- 6 Git Extensions
- 6 Features
- 6 Video tutorials
- 6 Links
- 8 Getting Started
- 8 Installation
- 13 Installation (Linux)
- 13 Installation (Mac)
- 14 Settings
- 15 Start Page
- 17 Clone repository
- 18 Clone SVN repository
- 18 Clone Github repository
- 18 Create new repository
- 20 Settings
- 21 Checklist
- 21 Git
- 21 Git Extensions
- 23 Commit dialog
- 23 Appearance
- 25 Revision Links
- 25 Colors
- 26 Start Page
- 27 Git Config
- 28 Build server integration
- 28 SSH
- 29 Scripts
- 30 Hotkeys
- 31 Shell Extension
- 31 Advanced
- 31 Confirmations
- 32 Plugins
- 34 Browse Repository
- 34 View commit log
- 35 Search or filter the commit history
- 37 Singe file history
- 39 Blame
- 40 Commit
- 40 Commit changes
- 46 Cherry pick commit
- 47 Revert commit
- 47 Stash changes
- 49 Tag
- 49 Create tag
- 50 Delete tag
- 51 Branches
- 51 Create branch
- 52 Checkout branch
- 53 Merge branches
- 55 Rebase branch
- 56 Delete branch
- 57 Patches
- 57 Create patch
- 58 Apply patches
- 60 Remote feature
- 60 Manage remote repositories
- 61 Create SSH key
- 66 Pull changes
- 68 Push changes
- 70 Merge Conflicts
- 70 Handle merge conflicts
- 72 Notes
- 74 Submodules
- 74 Manage submodules
- 75 Add submodule
- 75 Remove submodule
- 76 Maintenance
- 76 Compress Git database
- 76 Recover lost objects
- 78 Fix user names
- 79 Ignore files
- 81 Translations
- 81 Change language
- 81 Translate Git Extensions
- 83 Integration
- 83 Visual Studio
- 85 Windows Explorer
- 87 Command line
- 87 Git Extensions command line
- 90 Appendix
- 90 Git Cheat Sheet
- 91 Menu map
- 92 Plugins
- 92 List of the available plugins
- 92 GitFlow