Patchwork update: in the description update() in merge.py, mention the long options explicitly

login
register
mail settings
Submitter via Mercurial-devel
Date Oct. 23, 2017, 9:07 p.m.
Message ID <83a8eaeba37151821781.1508792861@cuben>
Download mbox | patch
Permalink /patch/25267/
State Accepted
Headers show

Comments

via Mercurial-devel - Oct. 23, 2017, 9:07 p.m.
# HG changeset patch
# User muxator <a.mux@inwind.it>
# Date 1507152154 -7200
#      Wed Oct 04 23:22:34 2017 +0200
# Branch stable
# Node ID 83a8eaeba37151821781becdf285501ebf065695
# Parent  780d13a58b332b3d18595af698eed1190fbe971e
update: in the description update() in merge.py, mention the long options explicitly

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.

Patch

diff --git a/mercurial/merge.py b/mercurial/merge.py
--- a/mercurial/merge.py
+++ b/mercurial/merge.py
@@ -1728,11 +1728,11 @@ 
       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
-    experimental.updatecheck=noconflict option.
+    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.