doc: update effect flag documentation
authorBoris Feld <boris.feld@octobus.net>
Fri, 30 Jun 2017 16:29:26 +0200
changeset 2689 9e84b407fde5
parent 2688 b6e50897b94e
child 2690 5d839e1f0ce9
doc: update effect flag documentation
hgext3rd/evolve/__init__.py
--- a/hgext3rd/evolve/__init__.py	Mon Jun 26 17:20:08 2017 +0200
+++ b/hgext3rd/evolve/__init__.py	Fri Jun 30 16:29:26 2017 +0200
@@ -99,19 +99,45 @@
 Effect Flag Experiment
 ======================
 
-We are experimenting with a way to register what changed between a precursor
-and its successors (content, description, parent, etc...). For example, having
-this information is helpful to show what changed between an obsolete changeset
-and its tipmost successors. This experiment is active by default
-
-The following config control the experiment::
+Evolve also records what changed between two evolutions of a changeset. For
+example, having this information is helpful to understand what changed between
+an obsolete changeset and its tipmost successors.
+
+Evolve currently records:
+
+    - Meta changes, user, date
+    - Tree movement, branch and parent, did the changeset moved?
+    - Description, was the commit description edited
+    - Diff, was there apart from potential diff change due to rebase a change in the diff?
+
+These flags are lightweight and can be combined, so it's easy to see if 4
+evolutions of the same changeset has just updated the description or if the
+content changed and you need to review again the diff.
+
+The effect flag recording is enabled by default in Evolve 6.4.0 so you have
+nothing to do to enjoy it. Now every new evolution that you create will have
+the effect flag attached.
+
+The following config control the effect flag recording::
 
   [experimental]
-  # deactivate the registration of effect flags in obs markers
-  evolution.effect-flags = false
-
-The effect flags are shown in the obslog command output without particular
-configuration if you want to inspect them.
+  # uncomment to deactivate the registration of effect flags in obs markers
+  # evolution.effect-flags = false
+
+You can display the effect flags with the command obslog, so if you have a
+changeset and you update only the message, you will see:
+
+    $ hg commit -m "WIP
+    $ hg commit -m "A better commit message!"
+    $ hg obslog .
+   @  8e9045855628 (3133) A better commit message!
+   |
+   x  7863a5bb5763 (3132) WIP
+        rewritten(description) by Boris Feld <boris.feld@octobus.net> (Fri Jun 02 12:00:24 2017 +0200) as 8e9045855628
+
+Servers does not need to activate the effect flag recording. Effect flags that
+you create will not cause interference with other clients or servers without
+the effect flag recording.
 
 Templates
 =========