changeset 30783:504ac28e4392 draft

commit: document the ui.allowemptycommit option It may be nice to document the situations in which other commands create empty commits, but I did not think it was necessary to go into that much detail.
author Jordi Gutiérrez Hermoso <jordigh@octave.org>
date Wed, 30 Dec 2015 15:14:18 -0500
parents b19c2679289c
children
files mercurial/commands.py mercurial/help/config.txt
diffstat 2 files changed, 11 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/commands.py
+++ b/mercurial/commands.py
@@ -1640,6 +1640,10 @@
     commit fails, you will find a backup of your message in
     ``.hg/last-message.txt``.
 
+    Empty commits by default are not allowed. You may enable the
+    creation of empty commits via the ``ui.allowemptycommit``
+    configuration option (see :hg:`help config`).
+
     The --close-branch flag can be used to mark the current branch
     head closed. When all heads of a branch are closed, the branch
     will be considered closed and no longer listed.
--- a/mercurial/help/config.txt
+++ b/mercurial/help/config.txt
@@ -1671,6 +1671,13 @@
 
 User interface controls.
 
+``allowemptycommit``
+    Whether to allow creation of empty commits by the ordinary ``hg
+    commit`` command. An empty commit is a commit that does not modify
+    any files and is not a merge commit. Note that some other commands
+    may still produce empty commits regardless of this setting.
+    (default: False)
+
 ``archivemeta``
     Whether to include the .hg_archival.txt file containing meta data
     (hashes for the repository base and for tip) in archives created