changeset 20:678eb575c330

tconfig: rework the documentation
author jcoomes
date Wed, 26 Feb 2014 12:21:43 -0800
parents c90ebb4991b6
children 760782dd3c80
files trees.py
diffstat 1 files changed, 20 insertions(+), 12 deletions(-) [+]
line wrap: on
line diff
--- a/trees.py	Tue Feb 25 19:02:27 2014 -0800
+++ b/trees.py	Wed Feb 26 12:21:43 2014 -0800
@@ -509,21 +509,29 @@
 def config(ui, repo, *subtrees, **opts):
     """list or change the subtrees configuration
 
-    One of five operations can be selected:  --list, --add, --del, --expand or
-    --set.  If no operation is specified, --list is assumed.
+    One of five operations can be selected:
+
+    --list:  list the configured subtrees; this is the default if no other
+      operation is selected.
 
-    If the --walk option is used with --set, the filesystem rooted at REPO is
-    scanned and the subtree configuration set to the discovered repos.
+    --add:  add the specified subtrees to the configuration.
+
+    --del:  delete the specified subtrees from the configuration.
+      Use --del --all to delete all subtrees.
 
-    In contrast to most other trees commands, tconfig does not recurse into
-    subtrees; it operates only on the current repository.  (Use the tlist
-    command to recursively list subtrees.)
+    --set:  set the subtree configuration to the specified subtrees.
+      Use --set --walk to walk the filesystem rooted at REPO and set the
+      subtree configuration to the discovered repos.
 
-    The --expand option does not list subtrees, but instead lists the values of
-    config items from the [trees] section after recursively expanding
-    them. (Items in the [trees] section can be defined recursively in terms of
-    other items in the [trees] section.)  It returns 0 if at least one config
-    item was found; otherwise it returns 1.
+    --expand:  list the value of config items from the [trees] section.
+      Items in the [trees] section can be defined in terms of other
+      items in the [trees] section; tconfig --expand shows the
+      recursively expanded value.  It returns 0 if at least one config
+      item was found; otherwise it returns 1.
+
+    Note that this command does not recurse into subtrees; it operates
+    only on the current repository.  (Use the tlist command to
+    recursively list subtrees.)
 
     """