From ca8503d0bef294ad3057382235e8ca2899e3a74e Mon Sep 17 00:00:00 2001
From: Jay Colson <jay@karma.net>
Date: Thu, 23 Jul 2020 10:53:23 +0100
Subject: git config to request abort if --force not passed

Default to emit a warning if the git config flag is not set.

Signed-off-by: Jay Colson <jay@karma.net>
---
 README.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'README.rst')

diff --git a/README.rst b/README.rst
index 04b656d..b1f12cb 100644
--- a/README.rst
+++ b/README.rst
@@ -97,6 +97,18 @@ The following ``git-config(1)`` variables are supported:
     ``rsync://`` backend. If the flags are set to a specific remote, the
     global flags, if also set, will not be applied for that remote.
 
+``remote.<name>.gcrypt-force-required``
+    ..
+``gcrypt.force-required``
+    A known issue is that every git push effectively has a ``--force``.
+
+    By default, git-remote-gcrypt will warn the user of this known issue
+    when a push is requested without the ``--force`` flag.
+
+    If this flag is set to ``true``, git-remote-gcrypt will fail to push,
+    as a precaution, unless ``--force`` is passed to git or you prefix your
+    refspecs with a '+'.
+
 Environment variables
 =====================
 
-- 
cgit v1.2.3