D542: effectflag: document effect flag
lothiraldan (Boris Feld)
phabricator at mercurial-scm.org
Sun Oct 1 09:44:48 EDT 2017
lothiraldan updated this revision to Diff 2288.
REPOSITORY
rHG Mercurial
CHANGES SINCE LAST UPDATE
https://phab.mercurial-scm.org/D542?vs=2259&id=2288
REVISION DETAIL
https://phab.mercurial-scm.org/D542
AFFECTED FILES
mercurial/obsutil.py
CHANGE DETAILS
diff --git a/mercurial/obsutil.py b/mercurial/obsutil.py
--- a/mercurial/obsutil.py
+++ b/mercurial/obsutil.py
@@ -307,7 +307,21 @@
foreground = set(repo.set('%ln::', known))
return set(c.node() for c in foreground)
-# logic around storing and using effect flags
+# effectflag field
+#
+# Effect-flag is a 1-byte bit field used to store what changed between a
+# changeset and its successor(s).
+#
+# The effect flag is stored in obs-markers metadata while we iterate on the
+# information design. That's why we have the EFFECTFLAGFIELD. If we come up
+# with an incompatible design for effect flag, we can store a new design under
+# another field name so we don't break readers. We plan to extend the existing
+# obsmarkers bit-field when the effect flag design will be stabilized.
+#
+# The effect-flag is placed behind an experimental flag
+# `effect-flags` set to off by default.
+#
+
EFFECTFLAGFIELD = "ef1"
DESCCHANGED = 1 << 0 # action changed the description
To: lothiraldan, #hg-reviewers, quark
Cc: martinvonz, quark, mercurial-devel
More information about the Mercurial-devel
mailing list