Page History

...

Formatting Git Commit Comments

Comments should be wrapped to about 72 columns. This allows for the first line to be used a subject in emails, and also for the entire body to be displayed using tools like "git log" in an 80 column window.

The first line of the comment is the subject or summary of the change, and should include the Lustra Jira ID at the beginning of the line. A Lustre Jira ticket is one that begins with LU and is therefore part of the Lustre project within Jira. If the patch is submitted for the fs/lustre-release repository without a Lustre Jira ID in the first line, then it will automatically receive a -2 review which will prevent the patch from being submitted to a release branch. The component: field is the Lustre subsystem that the commit is related to, for example llite, lov, ldlm, socklnd, lnet, etc.

Please make sure the Change-Id: line are on the bottom of the comment. This is also both required (as is the Signed-off-by line) by the fs/lustre-release project (at least) in order for the patch to be approved.  If your comments are excluding the Change-Id See Submitting Changes for a detailed description of the commit comment style.  If your comments are do not include the Change-Id line as described below, the patch will be rejected at submission time. The Change-Id field should be added using the commit-msg hook, see below.

Sample Commit message

LU-999 component: short description of change under 64 columns

A more detailed explanation.  This can be as detailed as you'd like.
Please explain both what problem was solved and a good high-level
description of how it was solved.  Wrap lines at 72 columns or less.

Signed-off-by: Random J Developer <random@developer.example.org>
Change-Id: Ica9ed1612eab0c4673dee088f8b441d806c64932

...

$ scp -p -P 29418 review.whamcloud.com:hooks/commit-msg .git/hooks/

$ curl -o .git/hooks/commit-msg http://review.whamcloud.com/tools/hooks/commit-msg

Alternatively, you can use the In newer versions of Lustre the preferred commit-msg hook and prepare-commit-msg that's hook are included in the attachments section of this page to get all of an empty Issue: line, a Signed-off-by: line with your git configured name and e-mail address and a Change-Idbuild/ subdirectory of the Lustre tree.

Note that you might have to add the required execute permissions to the hook once you have fetched it:

...