gear-changelog-rules(5)

GEAR-CHANGELOG-RULES(5)

File Formats

GEAR-CHANGELOG-RULES(5)

NAME

gear-changelog-rules - rule file for gear-changelog

DESCRIPTION

The rule file specifies actions of gear-changelog(1) required to filter and format got commit messages. There are two types of directives: global and sectional. Global directives should be defined before any sections.

FORMAT

A rule file consists of lines of the following format:

directive: <value>

Empty lines and lines beginning with “#” are ignored. Directive arguments are delimited by whitespace characters.

GLOBAL DIRECTIVES

width: <number>: Set width of changelog messages. Default is 70 symbols.

SECTION DIRECTIVES

group: <TEXT>: This directive begins a new section. It should contain a description for this group. This description will be used as a group message in the changelog.
regexp: <PATTERN>: Specifies the <PATTERN> on which a commit message can be attributed to this group. You can specify more than one directive of this kind.
filter: <SED-COMMAND>: Specify commands for sed(1) utility to transform each commit message before it will be written into changelog. You can specify more than one directive of this kind.

FILES

.gear/changelog: The gear-changelog(1) expect to find rules, unless another name is specified by the --rules=filename option.

EXAMPLES

[localhost]$ cat .gear/changelog <<EOF
group: gear-changelog utility changes
regexp: ^gear-changelog(-rules.5.in)?: 
filter: s/^gear-changelog: //
filter: s/^gear-changelog-rules.5.in: /Documentation: /
group: gear-merge utility changes
regexp: ^gear-merge:
filter: s/^gear-merge: //
EOF
[localhost]$ gear-changelog
* Wed Jun 18 2008 Alexey Gladkov <legion@altlinux.org> 1.4.0-alt1
- gear-changelog utility changes:


  + Replace /bin/ash with /bin/sh.


  + Documentation: Fix typo.


  + Read first commit too.


  + Fix typo.
- gear-merge utility changes:


  + Fix spacing in help message.


  + Update copyrights.


  + More choices in interactive merge mode (thx Alexey I. Froloff).


  + Document --no-interactive option (thx Alexey I. Froloff).


  + Implement --stop option (thx Alexey I. Froloff).

AUTHOR

This manual page written by Alexey Gladkov <legion@altlinux.org>.

Authors and contributors of the programs included in the gear package are listed in the manual pages for these programs.