From patchwork Tue Oct 22 14:02:43 2019
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Subject: [2, of, 2,
 V2] censor: document that some commands simply ignore censored data
From: =?utf-8?q?Jordi_Guti=C3=A9rrez_Hermoso?= <jordigh@octave.org>
X-Patchwork-Id: 42528
Message-Id: <2bf40680a6362c44c183.1571752963@chloe>
To: mercurial-devel@mercurial-scm.org
Date: Tue, 22 Oct 2019 10:02:43 -0400

# HG changeset patch
# User Jordi Gutiérrez Hermoso <jordigh@octave.org>
# Date 1571752908 14400
#      Tue Oct 22 10:01:48 2019 -0400
# Node ID 2bf40680a6362c44c183f17572f24d6ec086a3c6
# Parent  386e0a956ae57a95d62330c95497d7460761f3fd
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.

diff --git a/hgext/censor.py b/hgext/censor.py
--- a/hgext/censor.py
+++ b/hgext/censor.py
@@ -23,6 +23,10 @@ simply fail when asked to produce censor
 ``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