changeset 43486:bec734015b70

censor: document that some commands simply ignore censored data I can't see a benefit for hg grep to ever error out early when it encounters censored data.
author Jordi Gutiérrez Hermoso <jordigh@octave.org>
date Tue, 22 Oct 2019 10:01:48 -0400
parents 13b8097dccbf
children 0371a8c84827
files hgext/censor.py
diffstat 1 files changed, 3 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/hgext/censor.py	Tue Oct 22 09:56:40 2019 -0400
+++ b/hgext/censor.py	Tue Oct 22 10:01:48 2019 -0400
@@ -23,6 +23,9 @@
 ``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.
+
+A few informative commands such as ``hg grep`` will unconditionally
+ignore censored data and merely report that it was encountered.
 """
 
 from __future__ import absolute_import