{link: http://github.com/willb/gliss Gliss} is a tool for extracting specially-formatted tagged comments from git histories. It is designed to provide a sane workflow around extracting version history, ticket, and backwards-incompatibility information from a stream of commits. -This page is intended to get you started with gliss as quickly as possible; you may want to see {link: http://chapeau.freevariable.com/2011/01/grepping-for-git-glosses-with-gliss.html this short article} for more details. +This page is intended to get you started with gliss as quickly as possible; you may want to see {link: http://chapeau.freevariable.com/2011/01/grepping-for-git-glosses-with-gliss.html this short article} and {link: http://chapeau.freevariable.com/2011/07/gliss-020-release-and-a-gliss-example.html this example} for more details. {section: Annotating your commits} -A _gliss gloss_ is a simple tagged annotation in a commit message. The basic format of a gliss gloss is three identical characters on a line by themselves, followed by a tag name, followed by the same three identical characters that opened the line, and then the tag text; for example: +A _gliss gloss_ is a simple tagged annotation in a commit message. The basic format of a gliss gloss is three identical characters at the beginning of a line, followed by a tag name, followed by the same three identical characters that opened the line, and then the tag text; for example: ===FOO=== This is a gloss tagged FOO @@ -24,7 +24,11 @@ 1: =GT=, followed by a ticket number (starting with a pound so gittrac will recognize it), which indicates that this commit is related to a particular ticket. 1: =GT:Fixed=, followed by a ticket number (again, starting with a pound); this implies =GT= and indicates that this commit resolves a particular ticket. 1: =UpgradeNote= includes a description of a backwards-compatibility issue introduced by this commit (e.g. "This commit changes the wire protocol for the pony server.") -1: =VersionHistory= includes a version history entry related to this commit. +1: =VersionHistory= includes a plain-text version history entry related to this commit. +1: =VersionHistory:MD= includes a Markdown-formatted version history entry related to this commit. +1: =VersionHistory:None= indicates that this commit has no associated version history +1: =VersionHistory:Formatted= includes a LaTeX version history entry for this commit + {section: Installing a commit message template}