share: provide a more useful text for hg help stable
authorJoerg Sonnenberger <joerg@bec.de>
Tue, 23 Jun 2020 16:07:18 +0200
branchstable
changeset 44979 2fd8a8c11273
parent 44978 95c672c07116
child 45000 3fadbdc47aed
child 45003 839328c5a728
share: provide a more useful text for hg help Differential Revision: https://phab.mercurial-scm.org/D8651
hgext/share.py
--- a/hgext/share.py	Thu Jun 25 00:06:23 2020 -0700
+++ b/hgext/share.py	Tue Jun 23 16:07:18 2020 +0200
@@ -5,6 +5,15 @@
 
 '''share a common history between several working directories
 
+The share extension introduces a new command :hg:`share` to create a new
+working directory. This is similar to :hg:`clone`, but doesn't involve
+copying or linking the storage of the repository. This allows working on
+different branches or changes in parallel without the associated cost in
+terms of disk space.
+
+Note: destructive operations or extensions like :hg:`rollback` should be
+used with care as they can result in confusing problems.
+
 Automatic Pooled Storage for Clones
 -----------------------------------