Documentation fixes in git-config

[git.git] / Documentation / git-config.txt

diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index 8804de327fd5973ae5d36bff18cfcac3e738763d..7617d9eb2431a1dd52516b22b5e2ac4be2962f97 100644 (file)
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -50,16 +50,18 @@ The default is to assume the config file of the current repository,
 .git/config unless defined otherwise with GIT_DIR and GIT_CONFIG
 (see <<FILES>>).
 
-This command will fail if:
+This command will fail (with exit code ret) if:
 
-. The config file is invalid,
-. Can not write to the config file,
-. no section was provided,
-. the section or key is invalid,
-. you try to unset an option which does not exist,
-. you try to unset/set an option for which multiple lines match, or
-. you use '--global' option without $HOME being properly set.
+. The config file is invalid (ret=3),
+. can not write to the config file (ret=4),
+. no section or name was provided (ret=2),
+. the section or key is invalid (ret=1),
+. you try to unset an option which does not exist (ret=5),
+. you try to unset/set an option for which multiple lines match (ret=5),
+. you try to use an invalid regexp (ret=6), or
+. you use '--global' option without $HOME being properly set (ret=128).
 
+On success, the command returns the exit code 0.
 
 OPTIONS
 -------
@@ -83,8 +85,11 @@ OPTIONS
        is not exactly one.
 
 --get-regexp::
-       Like --get-all, but interprets the name as a regular expression.
-       Also outputs the key names.
+       Like --get-all, but interprets the name as a regular expression and
+       writes out the key names.  Regular expression matching is currently
+       case-sensitive and done against a canonicalized version of the key
+       in which section and variable names are lowercased, but subsection
+       names are not.
 
 --global::
        For writing options: write to global ~/.gitconfig file rather than