doc: document the evolve templates
authorPierre-Yves David <pierre-yves.david@octobus.net>
Thu, 08 Jun 2017 20:52:40 +0100
changeset 2556 d5b97b5dec5b
parent 2555 41a1d2a93223
child 2558 65cf338258d2
doc: document the evolve templates
hgext3rd/evolve/__init__.py
--- a/hgext3rd/evolve/__init__.py	Thu Jun 08 02:58:54 2017 +0100
+++ b/hgext3rd/evolve/__init__.py	Thu Jun 08 20:52:40 2017 +0100
@@ -112,6 +112,19 @@
 
 The effect flags are shown in the obglog command output without particular
 configuration of you want to inspect them.
+
+Templates
+=========
+
+Evolve ship several templates that you can use to have a better visibility
+about your obs history:
+
+  - precursors, for each obsolete changeset show the closest visible
+    precursors.
+  - successors, for each obsolete changeset show the closets visible
+    successors. It is useful when your working directory is obsolete to see
+    what are its successors. This informations can also be retrieved with the
+    obslog command and the --all option.
 """
 
 evolutionhelptext = """