[PATCH 2/2] Document toplevel gitconfig file
Try to explain its security implications and how to turn it off.
Signed-off-by: Nathan W. Panike <nathan.panike@gmail.com>
---
Documentation/config.txt | 11 +++++++++++
1 files changed, 11 insertions(+), 0 deletions(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 6a6c0b5..6ec9a0b 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -8,6 +8,17 @@ is used to store the configuration for that repository, and
fallback values for the `.git/config` file. The file `/etc/gitconfig`
can be used to store a system-wide default configuration.
+One can also create a `.gitconfig` file in the toplevel of the
+repository. This config file will then be propogated to collaborators
+when they pull from your repository. Only `alias` config variables are
+allowed to be set in this `.gitconfig` file. One can turn off the
+shared `.gitconfig` by setting the environment variable
+'GIT_CONFIG_NOSHARED' to 1; it will then be propogated but will not be
+used for configuration settings. Note that this is a security issue
+because you are basically allowing someone else to dictate your
+configuration, but should be fine if you pay attention and do not use
+aliases from someone else blindly.
+
The configuration variables are used by both the git plumbing
and the porcelains. The variables are divided into sections, wherein
the fully qualified variable name of the variable itself is the last
--
1.7.3.2.347.gd33a62
Nathan W. Panike <nathan.panike@gmail.com>