diff options
author | Owen W. Taylor <otaylor@fishsoup.net> | 2015-02-24 14:06:49 -0500 |
---|---|---|
committer | Owen W. Taylor <otaylor@fishsoup.net> | 2015-02-24 14:09:17 -0500 |
commit | 7a676905ecdac9d695843b5b5e261dc765e55b35 (patch) | |
tree | 4ba27f2e06e39c02c0b963381e6b3704ec72f1b9 /git-bz.txt | |
parent | 0f3311c316d4ae22ce369871665ba6b186b825db (diff) | |
download | git-bz-7a676905ecdac9d695843b5b5e261dc765e55b35.tar.gz |
Document bug references in commit messages
Add documentaton of recognized forms of bug references in commit messages,
and explain the way that "See" suppresses bug reference identification.
https://bugzilla.gnome.org/show_bug.cgi?id=708158
Diffstat (limited to 'git-bz.txt')
-rw-r--r-- | git-bz.txt | 25 |
1 files changed, 23 insertions, 2 deletions
@@ -291,7 +291,7 @@ per bug tracker accepted. BUG REFERENCES -------------- -Ways to refer to a bug: +On the command line, there are multiple ways to refer to a bug: <id>:: bug # on the default bug tracker @@ -299,7 +299,28 @@ Ways to refer to a bug: <alias>:<id>:: bug # on the given bug tracker alias (see below) -<url>:: An URL of the form "http://<hostname>/show_bug.cgi?id-<id>" +<url>:: An URL of the form "http://<hostname>/show_bug.cgi?id=<id>" + +git-bz will also look for bug references in the subject and body of +commit messages. In commit messages, the following forms are recognized: + +<url>:: An URL of the form "http://<hostname>/show_bug.cgi?id=<id>" + +(Bug|bug) <id>:: bug # on the default bug tracker + +In commit messages, if a bug reference in either of the above forms +is proceeded by "See" or "see" with no more than two words in-between, +then it will be ignored. This is to allow referring to other related +bugs without confusing git-bz. An example: + +------ +Fix regression in indentation + +Changes in the handling of tab characters (see Mozilla bug 2345) caused +problems with leading spaces. + +http://bugzilla.gnome.org/show_bug.cgi?id=12345 +------ [[add-url-method]] ADD URL METHOD |