From 999727135b5d2cc382a1103f1651c716c8d95179 Mon Sep 17 00:00:00 2001
From: Roman Gorshunov <34521622+gorshunovr@users.noreply.github.com>
Date: Wed, 15 May 2019 17:09:45 +0200
Subject: [PATCH] Update flags documentation

Update flags documentation with information on when DONT_SHALLOW_CLONE
could be useful.
---
 docs/guides/feature-flags.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/docs/guides/feature-flags.rst b/docs/guides/feature-flags.rst
index 4e257ab46b5..b3b3abe3124 100644
--- a/docs/guides/feature-flags.rst
+++ b/docs/guides/feature-flags.rst
@@ -27,3 +27,7 @@ Available Flags
 ``MKDOCS_THEME_RTD``: :featureflags:`MKDOCS_THEME_RTD`
 
 ``DONT_SHALLOW_CLONE``: :featureflags:`DONT_SHALLOW_CLONE`
+
+The ``DONT_SHALLOW_CLONE`` flag is useful if your code accesses old commits during docs build,
+e.g. python-reno release notes manager is known to do that
+(error message line would probably include one of old Git commit id's).