1DEBCOMMIT(1)                                                      DEBCOMMIT(1)
2
3
4

NAME

6       debcommit - commit changes to a package
7

SYNOPSIS

9       debcommit [options] [--all | files to commit]
10

DESCRIPTION

12       debcommit generates a commit message based on new text in
13       debian/changelog, and commits the change to a package's repository. It
14       must be run in a working copy for the package. Supported version
15       control systems are: cvs, git, hg (mercurial), svk, svn (Subversion),
16       baz, bzr, tla (arch), darcs.
17

OPTIONS

19       -c, --changelog path
20           Specify an alternate location for the changelog. By default
21           debian/changelog is used.
22
23       -r, --release
24           Commit a release of the package. The version number is determined
25           from debian/changelog, and is used to tag the package in the
26           repository.
27
28           Note that svn/svk tagging conventions vary, so debcommit uses
29           svnpath(1) to determine where the tag should be placed in the
30           repository.
31
32       -R, --release-use-changelog
33           When used in conjunction with --release, if there are uncommitted
34           changes to the changelog then derive the commit message from those
35           changes rather than using the default message.
36
37       -m text, --message text
38           Specify a commit message to use. Useful if the program cannot
39           determine a commit message on its own based on debian/changelog, or
40           if you want to override the default message.
41
42       -n, --noact
43           Do not actually do anything, but do print the commands that would
44           be run.
45
46       -d, --diff
47           Instead of committing, do print the diff of what would have been
48           committed if this option were not given. A typical usage scenario
49           of this option is the generation of patches against the current
50           working copy (e.g. when you don't have commit access right).
51
52       -C, --confirm
53           Display the generated commit message and ask for confirmation
54           before committing it. It is also possible to edit the message at
55           this stage; in this case, the confirmation prompt will be re-
56           displayed after the editing has been performed.
57
58       -e, --edit
59           Edit the generated commit message in your favorite editor before
60           committing it.
61
62       -a, --all
63           Commit all files. This is the default operation when using a VCS
64           other than git.
65
66       -s, --strip-message, --no-strip-message
67           If this option is set and the commit message has been derived from
68           the changelog, the characters "* " will be stripped from the
69           beginning of the message.
70
71           This option is set by default and ignored if more than one line of
72           the message begins with "[*+-] ".
73
74       --sign-commit, --no-sign-commit
75           If this option is set, then the commits that debcommit creates will
76           be signed using gnupg. Currently this is only supported by git, hg,
77           and bzr.
78
79       --sign-tags, --no-sign-tags
80           If this option is set, then tags that debcommit creates will be
81           signed using gnupg. Currently this is only supported by git.
82
83       --changelog-info
84           If this option is set, the commit author and date will be
85           determined from the Maintainer and Date field of the first
86           paragraph in debian/changelog.  This is mainly useful when using
87           debchange(1) with the --no-mainttrailer option.
88

CONFIGURATION VARIABLES

90       The two configuration files /etc/devscripts.conf and ~/.devscripts are
91       sourced by a shell in that order to set configuration variables.
92       Command line options can be used to override configuration file
93       settings.  Environment variable settings are ignored for this purpose.
94       The currently recognised variables are:
95
96       DEBCOMMIT_STRIP_MESSAGE
97           If this is set to no, then it is the same as the --no-strip-message
98           command line parameter being used. The default is yes.
99
100       DEBCOMMIT_SIGN_TAGS
101           If this is set to yes, then it is the same as the --sign-tags
102           command line parameter being used. The default is no.
103
104       DEBCOMMIT_SIGN_COMMITS
105           If this is set to yes, then it is the same as the --sign-commit
106           command line parameter being used. The default is no.
107
108       DEBCOMMIT_RELEASE_USE_CHANGELOG
109           If this is set to yes, then it is the same as the
110           --release-use-changelog command line parameter being used. The
111           default is no.
112
113       DEBSIGN_KEYID
114           This is the key id used for signing tags. If not set, a default
115           will be chosen by the revision control system.
116

VCS SPECIFIC FEATURES

118       tla / baz
119           If the commit message contains more than 72 characters, a summary
120           will be created containing as many full words from the message as
121           will fit within 72 characters, followed by an ellipsis.
122
123       Each of the features described below is applicable only if the commit
124       message has been automatically determined from the changelog.
125
126       git If only a single change is detected in the changelog, debcommit
127           will unfold it to a single line and behave as if --strip-message
128           was used.
129
130           Otherwise, the first change will be unfolded and stripped to form a
131           summary line and a commit message formed using the summary line
132           followed by a blank line and the changes as extracted from the
133           changelog. debcommit will then spawn an editor so that the message
134           may be fine-tuned before committing.
135
136       hg / darcs
137           The first change detected in the changelog will be unfolded to form
138           a single line summary. If multiple changes were detected then an
139           editor will be spawned to allow the message to be fine-tuned.
140
141       bzr If the changelog entry used for the commit message closes any bugs
142           then --fixes options to "bzr commit" will be generated to associate
143           the revision and the bugs.
144

LICENSE

146       This code is copyright by Joey Hess <joeyh@debian.org>, all rights
147       reserved.  This program comes with ABSOLUTELY NO WARRANTY.  You are
148       free to redistribute this code under the terms of the GNU General
149       Public License, version 2 or later.
150

AUTHOR

152       Joey Hess <joeyh@debian.org>
153

SEE ALSO

155       debchange(1), svnpath(1)
156
157
158
159Debian Utilities                  2021-05-03                      DEBCOMMIT(1)
Impressum