From 7a676905ecdac9d695843b5b5e261dc765e55b35 Mon Sep 17 00:00:00 2001 From: "Owen W. Taylor" Date: Tue, 24 Feb 2015 14:06:49 -0500 Subject: 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 --- git-bz.txt | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/git-bz.txt b/git-bz.txt index 30c80a5..4c4ac83 100644 --- a/git-bz.txt +++ b/git-bz.txt @@ -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: :: bug # on the default bug tracker @@ -299,7 +299,28 @@ Ways to refer to a bug: ::: bug # on the given bug tracker alias (see below) -:: An URL of the form "http:///show_bug.cgi?id-" +:: An URL of the form "http:///show_bug.cgi?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: + +:: An URL of the form "http:///show_bug.cgi?id=" + +(Bug|bug) :: 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 -- cgit