update: mention long options explicitly in description of merge.update() stable
authormuxator <a.mux@inwind.it>
Wed, 04 Oct 2017 23:22:34 +0200
branchstable
changeset 34919 1856de4d1297
parent 34918 274811627808
child 34920 6a0e1d593bdd
update: mention long options explicitly in description of merge.update() The short options "-c" and "-C" may be confusing for a novice reading the documentation. Let's try to be more explicit, also mentioning the equivalent long options ("--check" and "--clean") in the comments.
mercurial/merge.py
--- a/mercurial/merge.py	Sat Oct 21 13:42:43 2017 +0900
+++ b/mercurial/merge.py	Wed Oct 04 23:22:34 2017 +0200
@@ -1727,11 +1727,11 @@
     mergeforce = whether the merge was run with 'merge --force' (deprecated): if
       this is True, then 'force' should be True as well.
 
-    The table below shows all the behaviors of the update command
-    given the -c and -C or no options, whether the working directory
-    is dirty, whether a revision is specified, and the relationship of
-    the parent rev to the target rev (linear or not). Match from top first. The
-    -n option doesn't exist on the command line, but represents the
+    The table below shows all the behaviors of the update command given the
+    -c/--check and -C/--clean or no options, whether the working directory is
+    dirty, whether a revision is specified, and the relationship of the parent
+    rev to the target rev (linear or not). Match from top first. The -n
+    option doesn't exist on the command line, but represents the
     experimental.updatecheck=noconflict option.
 
     This logic is tested by test-update-branches.t.