Difference between revisions of "Git/Hooks"

From KitwarePublic
< Git
Jump to: navigation, search
(pre-commit: uncrustify hook description)
(update)
Line 155: Line 155:
 
* No CRLF newlines may be added in the repository (see core.autocrlf in <code>git help config</code>).
 
* No CRLF newlines may be added in the repository (see core.autocrlf in <code>git help config</code>).
 
* Submodules (if any) must be pushed before the references to them are pushed.
 
* Submodules (if any) must be pushed before the references to them are pushed.
 +
* No commit may rewind submodule references.  Merges must reference submodule versions no older than any parent.

Revision as of 10:44, 8 June 2011

Setup

The git commit command creates local commits. A separate git push step is needed to publish commits to a public.kitware.com repository. The public.kitware.com server enforces some rules on the commits it accepts and will reject non-conforming commits. In order to push rejected commits, one must edit history locally to repair them before publishing.

Since it is possible to create many commits locally and push them all at once, we provide local Git hooks to help developers keep their individual commits clean. Git provides no way to enable such hooks by default, giving developers maximum control over their local repositories. We recommend enabling our hooks manually in all clones.

Git looks for hooks in the .git/hooks directory within the work tree of a local repository. Create a new local repository in this directory to manage the hooks:

$ cd .git/hooks
$ git init
$ cd ../..

Choose one of the following methods to install or update the hooks. The hooks will then run in the outer repository to enforce some rules on commits.

Local Pull

Many public.kitware.com repositories provide a hooks branch. It will have already been fetched into your local clone. Pull it from there:

$ git fetch origin
$ cd .git/hooks
$ git pull .. remotes/origin/hooks
$ cd ../..

Direct Pull

If you did not clone from a public.kitware.com repository you may not have a hooks branch. Pull it from public.kitware.com:

$ cd .git/hooks
$ git pull git://public.kitware.com/<repo>.git hooks
$ cd ../..

where <repo>.git is the name of your project repository.

Local

The above sequences maintain the following local hooks in your repository. See Git help on githooks for more details.

pre-commit

This runs during git commit. It checks identity and content of changes:

  • Git user.name and user.email are set to something reasonable
  • Git's standard whitespace checks (see help on git diff --check)
  • The staged changes do not introduce any leading TABs in source files (we indent with spaces)
  • File modes look reasonable (no executable .cxx files, scripts with shebang lines are executable)
  • File size is not too large (don't commit big data files; prints limit and instructions on rejection)
  • Submodule updates are staged alone or explicitly allowed (prints instructions on rejection)

One of Git's standard whitespace checks is to reject trailing whitespace on lines that were added or modified. Many people consider extra space characters at the end of a line to be an unprofessional style (including Git's own developers), but some don't care. Text editors typically have a mode to highlight trailing whitespace:

Emacs
(custom-set-variables '(show-trailing-whitespace t))
Vim
:highlight ExtraWhitespace ctermbg=red guibg=red
:match ExtraWhitespace /\s\+$/
Visual Studio
To toggle viewing of white space characters, with a source
file document active, choose the menu item:

 Edit > Advanced > View White Space

(2-stroke keyboard shortcut: Ctrl+R, Ctrl+W)
Notepad++ (v5.6.7)
To eliminate trailing white space, choose the menu item:

 Edit > Trim Trailing Space

To toggle viewing of white space characters, choose from the
menu items:

 View > Show Symbol > (multiple items, choose one...)

If you really don't want to keep your code clean of trailing whitespace, you can disable this part of Git's checks locally:

$ git config core.whitespace "-blank-at-eol"
  • KWStyle style check (aborts commit on style check failure).

Disabled by default, but can be enabled to run a style check with KWStyle. To enable this hook:

 git config hooks.KWStyle true

Disabled by default, but can be enabled to propose style changes to the code. To enable this hook:

 git config hooks.uncrustify true

Proposed style changes are not added to the commit until they have been manually brought in by the developer. This is performed with the developer's favorite merge program. For more information and a list of supported merge applications, see

 git help mergetool

To configure your preferred merge program

 git config merge.tool <toolname>

commit-msg

This runs during git commit. It checks the commit message format:

  • The first line must be between 8 and 78 characters long. If you were writing an email to describe the change, this would be the Subject line.
    (Do not bother using 'ENH:' or 'BUG:' prefixes; they take space and are less valuable than a good summary on this line).
  • The first line must not have leading or trailing whitespace.
  • The second line must be blank, if present.
  • The third line and below may be free-form. Try to keep paragraph text formatted in 72 columns (this is not enforced).

GUI and text-based tools that help view history typically use the first line (Subject line) from the commit message to give a one-line summary of each commit. This allows a medium-level view of history, but works well only if developers write good Subject lines for their commits.

Examples of improper commit messages:

Fixed

This is too short and not informative at all.

I did a really complicated change and I am trying to describe the entire thing with a big message entered on the command line.

Many CVS users develop the habit of using the "-m" commit option to specify the whole message on the command line. This is probably because in CVS it is hard to abort a commit if it already brought up the message editor. In Git this is trivial. Just leave the message blank and the whole commit will be aborted. Furthermore, since commits are not published automatically it is easy to allow the commit to complete and then fix it with git commit --amend.

Server

Many public.kitware.com repositories have server-side hooks.

update

The update hook runs when someone tries to update a ref on the server by pushing. The hook checks all commits included in the push:

  • Commit author and committer must have valid email address domains (DNS lookup succeeds).
  • Commit message does not start with "WIP:". (Use the prefix locally for work-in-progress that must be rewritten before publishing.)
  • Changes to paths updated by robots (such as Utilities/kwsys) are not allowed.
  • No "large" blobs may be pushed. The limit is set on a per-repository basis and is typically 1MB or so.
  • No CRLF newlines may be added in the repository (see core.autocrlf in git help config).
  • Submodules (if any) must be pushed before the references to them are pushed.
  • No commit may rewind submodule references. Merges must reference submodule versions no older than any parent.