censor: mention that we check the heads in the help
authorPierre-Yves David <pierre-yves.david@octobus.net>
Fri, 01 Dec 2023 22:25:52 +0100
changeset 51266 51056bedbe0d
parent 51264 47a34afda7ad
child 51267 195ab99cf791
censor: mention that we check the heads in the help And add a message to will explain the possibly long time spent doing this.
hgext/censor.py
--- a/hgext/censor.py	Thu Dec 14 09:57:25 2023 +0100
+++ b/hgext/censor.py	Fri Dec 01 22:25:52 2023 +0100
@@ -22,7 +22,9 @@
 simply fail when asked to produce censored data. Others, like ``hg verify`` and
 ``hg update``, must be capable of tolerating censored data to continue to
 function in a meaningful way. Such commands only tolerate censored file
-revisions if they are allowed by the "censor.policy=ignore" config option.
+As having a censored version in a checkout is impractical. The current head
+revisions of the repository are checked. If the revision to be censored is in
+any of them the command will abort.
 
 A few informative commands such as ``hg grep`` will unconditionally
 ignore censored data and merely report that it was encountered.