7.1 Customizing Git - Git Configuration
As you briefly saw in the Chapter 1, you can specify Git configuration settings with the
git config command. One of the first things you did was set up your name and e-mail address:
$ git config --global user.name "John Doe" $ git config --global user.email email@example.com
Now you’ll learn a few of the more interesting options that you can set in this manner to customize your Git usage.
You saw some simple Git configuration details in the first chapter, but I’ll go over them again quickly here. Git uses a series of configuration files to determine non-default behavior that you may want. The first place Git looks for these values is in an
/etc/gitconfig file, which contains values for every user on the system and all of their repositories. If you pass the option
git config, it reads and writes from this file specifically.
The next place Git looks is the
~/.gitconfig file, which is specific to each user. You can make Git read and write to this file by passing the
Finally, Git looks for configuration values in the config file in the Git directory (
.git/config) of whatever repository you’re currently using. These values are specific to that single repository. Each level overwrites values in the previous level, so values in
.git/config trump those in
/etc/gitconfig, for instance. You can also set these values by manually editing the file and inserting the correct syntax, but it’s generally easier to run the
git config command.
The configuration options recognized by Git fall into two categories: client side and server side. The majority of the options are client side—configuring your personal working preferences. Although tons of options are available, I’ll only cover the few that either are commonly used or can significantly affect your workflow. Many options are useful only in edge cases that I won’t go over here. If you want to see a list of all the options your version of Git recognizes, you can run
$ git config --help
The manual page for
git config lists all the available options in quite a bit of detail.
By default, Git uses whatever you’ve set as your default text editor or else falls back to the Vi editor to create and edit your commit and tag messages. To change that default to something else, you can use the
$ git config --global core.editor emacs
Now, no matter what is set as your default shell editor variable, Git will fire up Emacs to edit messages.
If you set this to the path of a file on your system, Git will use that file as the default message when you commit. For instance, suppose you create a template file at
$HOME/.gitmessage.txt that looks like this:
subject line what happened [ticket: X]
To tell Git to use it as the default message that appears in your editor when you run
git commit, set the
commit.template configuration value:
$ git config --global commit.template $HOME/.gitmessage.txt $ git commit
Then, your editor will open to something like this for your placeholder commit message when you commit:
subject line what happened [ticket: X] # Please enter the commit message for your changes. Lines starting # with '#' will be ignored, and an empty message aborts the commit. # On branch master # Changes to be committed: # (use "git reset HEAD <file>..." to unstage) # # modified: lib/test.rb # ~ ~ ".git/COMMIT_EDITMSG" 14L, 297C
If you have a commit-message policy in place, then putting a template for that policy on your system and configuring Git to use it by default can help increase the chance of that policy being followed regularly.
The core.pager setting determines what pager is used when Git pages output such as
diff. You can set it to
more or to your favorite pager (by default, it’s
less), or you can turn it off by setting it to a blank string:
$ git config --global core.pager ''
If you run that, Git will page the entire output of all commands, no matter how long they are.
If you’re making signed annotated tags (as discussed in Chapter 2), setting your GPG signing key as a configuration setting makes things easier. Set your key ID like so:
$ git config --global user.signingkey <gpg-key-id>
Now, you can sign tags without having to specify your key every time with the
git tag command:
$ git tag -s <tag-name>
You can put patterns in your project’s
.gitignore file to have Git not see them as untracked files or try to stage them when you run
git add on them, as discussed in Chapter 2. However, if you want another file outside of your project to hold those values or have extra values, you can tell Git where that file is with the
core.excludesfile setting. Simply set it to the path of a file that has content similar to what a
.gitignore file would have.
This option is available only in Git 1.6.1 and later. If you mistype a command in Git 1.6, it shows you something like this:
$ git com git: 'com' is not a git-command. See 'git --help'. Did you mean this? commit
If you set
help.autocorrect to 1, Git will automatically run the command if it has only one match under this scenario.
Git can color its output to your terminal, which can help you visually parse the output quickly and easily. A number of options can help you set the coloring to your preference.
Git automatically colors most of its output if you ask it to. You can get very specific about what you want colored and how; but to turn on all the default terminal coloring, set
color.ui to true:
$ git config --global color.ui true
When that value is set, Git colors its output if the output goes to a terminal. Other possible settings are false, which never colors the output, and always, which sets colors all the time, even if you’re redirecting Git commands to a file or piping them to another command. This setting was added in Git version 1.5.5; if you have an older version, you’ll have to specify all the color settings individually.
You’ll rarely want
color.ui = always. In most scenarios, if you want color codes in your redirected output, you can instead pass a
--color flag to the Git command to force it to use color codes. The
color.ui = true setting is almost always what you’ll want to use.
If you want to be more specific about which commands are colored and how, or you have an older version, Git provides verb-specific coloring settings. Each of these can be set to
color.branch color.diff color.interactive color.status
In addition, each of these has subsettings you can use to set specific colors for parts of the output, if you want to override each color. For example, to set the meta information in your diff output to blue foreground, black background, and bold text, you can run
$ git config --global color.diff.meta “blue black bold”
You can set the color to any of the following values: normal, black, red, green, yellow, blue, magenta, cyan, or white. If you want an attribute like bold in the previous example, you can choose from bold, dim, ul, blink, and reverse.
git config manpage for all the subsettings you can configure, if you want to do that.
Although Git has an internal implementation of diff, which is what you’ve been using, you can set up an external tool instead. You can also set up a graphical merge conflict-resolution tool instead of having to resolve conflicts manually. I’ll demonstrate setting up the Perforce Visual Merge Tool (P4Merge) to do your diffs and merge resolutions, because it’s a nice graphical tool and it’s free.
If you want to try this out, P4Merge works on all major platforms, so you should be able to do so. I’ll use path names in the examples that work on Mac and Linux systems; for Windows, you’ll have to change
/usr/local/bin to an executable path in your environment.
You can download P4Merge here:
To begin, you’ll set up external wrapper scripts to run your commands. I’ll use the Mac path for the executable; in other systems, it will be where your
p4merge binary is installed. Set up a merge wrapper script named
extMerge that calls your binary with all the arguments provided:
$ cat /usr/local/bin/extMerge #!/bin/sh /Applications/p4merge.app/Contents/MacOS/p4merge $*
The diff wrapper checks to make sure seven arguments are provided and passes two of them to your merge script. By default, Git passes the following arguments to the diff program:
path old-file old-hex old-mode new-file new-hex new-mode
Because you only want the
new-file arguments, you use the wrapper script to pass the ones you need.
$ cat /usr/local/bin/extDiff #!/bin/sh [ $# -eq 7 ] && /usr/local/bin/extMerge "$2" "$5"
You also need to make sure these tools are executable:
$ sudo chmod +x /usr/local/bin/extMerge $ sudo chmod +x /usr/local/bin/extDiff
Now you can set up your config file to use your custom merge resolution and diff tools. This takes a number of custom settings:
merge.tool to tell Git what strategy to use,
mergetool.*.cmd to specify how to run the command,
mergetool.trustExitCode to tell Git if the exit code of that program indicates a successful merge resolution or not, and
diff.external to tell Git what command to run for diffs. So, you can either run four config commands
$ git config --global merge.tool extMerge $ git config --global mergetool.extMerge.cmd \ 'extMerge "$BASE" "$LOCAL" "$REMOTE" "$MERGED"' $ git config --global mergetool.trustExitCode false $ git config --global diff.external extDiff
or you can edit your
~/.gitconfig file to add these lines:
[merge] tool = extMerge [mergetool "extMerge"] cmd = extMerge \"$BASE\" \"$LOCAL\" \"$REMOTE\" \"$MERGED\" trustExitCode = false [diff] external = extDiff
After all this is set, if you run diff commands such as this:
$ git diff 32d1776b1^ 32d1776b1
Instead of getting the diff output on the command line, Git fires up P4Merge, which looks something like Figure 7-1.
Figure 7-1. P4Merge.
If you try to merge two branches and subsequently have merge conflicts, you can run the command
git mergetool; it starts P4Merge to let you resolve the conflicts through that GUI tool.
The nice thing about this wrapper setup is that you can change your diff and merge tools easily. For example, to change your
extMerge tools to run the KDiff3 tool instead, all you have to do is edit your
$ cat /usr/local/bin/extMerge #!/bin/sh /Applications/kdiff3.app/Contents/MacOS/kdiff3 $*
Now, Git will use the KDiff3 tool for diff viewing and merge conflict resolution.
Git comes preset to use a number of other merge-resolution tools without your having to set up the cmd configuration. You can set your merge tool to kdiff3, opendiff, tkdiff, meld, xxdiff, emerge, vimdiff, or gvimdiff. If you’re not interested in using KDiff3 for diff but rather want to use it just for merge resolution, and the kdiff3 command is in your path, then you can run
$ git config --global merge.tool kdiff3
If you run this instead of setting up the
extDiff files, Git will use KDiff3 for merge resolution and the normal Git diff tool for diffs.
Formatting and whitespace issues are some of the more frustrating and subtle problems that many developers encounter when collaborating, especially cross-platform. It’s very easy for patches or other collaborated work to introduce subtle whitespace changes because editors silently introduce them or Windows programmers add carriage returns at the end of lines they touch in cross-platform projects. Git has a few configuration options to help with these issues.
If you’re programming on Windows or using another system but working with people who are programming on Windows, you’ll probably run into line-ending issues at some point. This is because Windows uses both a carriage-return character and a linefeed character for newlines in its files, whereas Mac and Linux systems use only the linefeed character. This is a subtle but incredibly annoying fact of cross-platform work.
Git can handle this by auto-converting CRLF line endings into LF when you commit, and vice versa when it checks out code onto your filesystem. You can turn on this functionality with the
core.autocrlf setting. If you’re on a Windows machine, set it to
true — this converts LF endings into CRLF when you check out code:
$ git config --global core.autocrlf true
If you’re on a Linux or Mac system that uses LF line endings, then you don’t want Git to automatically convert them when you check out files; however, if a file with CRLF endings accidentally gets introduced, then you may want Git to fix it. You can tell Git to convert CRLF to LF on commit but not the other way around by setting
core.autocrlf to input:
$ git config --global core.autocrlf input
This setup should leave you with CRLF endings in Windows checkouts but LF endings on Mac and Linux systems and in the repository.
If you’re a Windows programmer doing a Windows-only project, then you can turn off this functionality, recording the carriage returns in the repository by setting the config value to
$ git config --global core.autocrlf false
Git comes preset to detect and fix some whitespace issues. It can look for four primary whitespace issues — two are enabled by default and can be turned off, and two aren’t enabled by default but can be activated.
The two that are turned on by default are
trailing-space, which looks for spaces at the end of a line, and
space-before-tab, which looks for spaces before tabs at the beginning of a line.
The two that are disabled by default but can be turned on are
indent-with-non-tab, which looks for lines that begin with eight or more spaces instead of tabs, and
cr-at-eol, which tells Git that carriage returns at the end of lines are OK.
You can tell Git which of these you want enabled by setting
core.whitespace to the values you want on or off, separated by commas. You can disable settings by either leaving them out of the setting string or prepending a
- in front of the value. For example, if you want all but
cr-at-eol to be set, you can do this:
$ git config --global core.whitespace \ trailing-space,space-before-tab,indent-with-non-tab
Git will detect these issues when you run a
git diff command and try to color them so you can possibly fix them before you commit. It will also use these values to help you when you apply patches with
git apply. When you’re applying patches, you can ask Git to warn you if it’s applying patches with the specified whitespace issues:
$ git apply --whitespace=warn <patch>
Or you can have Git try to automatically fix the issue before applying the patch:
$ git apply --whitespace=fix <patch>
These options apply to the git rebase option as well. If you’ve committed whitespace issues but haven’t yet pushed upstream, you can run a
rebase with the
--whitespace=fix option to have Git automatically fix whitespace issues as it’s rewriting the patches.
Not nearly as many configuration options are available for the server side of Git, but there are a few interesting ones you may want to take note of.
By default, Git doesn’t check for consistency all the objects it receives during a push. Although Git can check to make sure each object still matches its SHA-1 checksum and points to valid objects, it doesn’t do that by default on every push. This is a relatively expensive operation and may add a lot of time to each push, depending on the size of the repository or the push. If you want Git to check object consistency on every push, you can force it to do so by setting
receive.fsckObjects to true:
$ git config --system receive.fsckObjects true
Now, Git will check the integrity of your repository before each push is accepted to make sure faulty clients aren’t introducing corrupt data.
If you rebase commits that you’ve already pushed and then try to push again, or otherwise try to push a commit to a remote branch that doesn’t contain the commit that the remote branch currently points to, you’ll be denied. This is generally good policy; but in the case of the rebase, you may determine that you know what you’re doing and can force-update the remote branch with a
-f flag to your push command.
To disable the ability to force-update remote branches to non-fast-forward references, set
$ git config --system receive.denyNonFastForwards true
The other way you can do this is via server-side receive hooks, which I’ll cover in a bit. That approach lets you do more complex things like deny non-fast-forwards to a certain subset of users.
One of the workarounds to the
denyNonFastForwards policy is for the user to delete the branch and then push it back up with the new reference. In newer versions of Git (beginning with version 1.6.1), you can set
receive.denyDeletes to true:
$ git config --system receive.denyDeletes true
This denies branch and tag deletion over a push across the board — no user can do it. To remove remote branches, you must remove the ref files from the server manually. There are also more interesting ways to do this on a per-user basis via ACLs, as you’ll learn at the end of this chapter.