Author: adam-guest
Date: 2008-03-20 21:38:21 +0000 (Thu, 20 Mar 2008)
New Revision: 1175
Modified:
trunk/debian/changelog
trunk/scripts/debcommit.pl
Log:
+ Add documentation to the manpage of the current VCS-specific features
Modified: trunk/debian/changelog
===================================================================
--- trunk/debian/changelog 2008-03-20 21:10:23 UTC (rev 1174)
+++ trunk/debian/changelog 2008-03-20 21:38:21 UTC (rev 1175)
@@ -23,6 +23,7 @@
+ When creating summary lines for git and hg, ignore any subchanges
(i.e. lines indented by more than two spaces and starting with *, +
or -)
+ + Add documentation to the manpage of the current VCS-specific features
* debdiff: Escape package names when normalising path names
(Closes: #471282)
* uscan: Correctly handle an explicit upstream-version of 0
Modified: trunk/scripts/debcommit.pl
===================================================================
--- trunk/scripts/debcommit.pl 2008-03-20 21:10:23 UTC (rev 1174)
+++ trunk/scripts/debcommit.pl 2008-03-20 21:38:21 UTC (rev 1175)
@@ -92,8 +92,6 @@
If this option is set, then tags that debcommit creates will be signed
using gnupg. Currently this is only supported by git.
-=over 4
-
=back
=head1 CONFIGURATION VARIABLES
@@ -126,6 +124,37 @@
This is the key id used for signing tags. If not set, a default will be
chosen by the revision control system.
+=back
+
+=head1 VCS SPECIFIC FEATURES
+
+Each of the features described below is applicable only if the commit message
+has been automatically determined from the changelog.
+
+=over 4
+
+=item B<git>
+
+If only a single change is detected in the changelog, B<debcommit> will unfold
+it to a single line and behave as if I<--strip-message> was used.
+
+Otherwise, the first change will be unfolded and stripped to form a summary
line
+and a commit message formed using the summary line followed by a blank line and
+the changes as extracted from the changelog. B<debcommit> will then spawn an
+editor so that the message may be fine-tuned before committing.
+
+=item B<hg>
+
+The first change detected in the changelog will be unfolded to form a single
line
+summary. If multiple changes were detected then an editor will be spawned to
+allow the message to be fine-tuned.
+
+=item B<tla> / B<baz>
+
+If the commit message contains more than 72 characters, a summary will
+be created containing as many full words from the message as will fit within
+72 characters, followed by an ellipsis.
+
=cut
use warnings;
--
To unsubscribe, send mail to [EMAIL PROTECTED]
