[PATCH] Documentation fixes in git-config
From: Libor Pechacek <hidden>
Date: 2016-06-15 22:50:26
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
Variable names must start with an alphabetic character, regexp config key matching is case sensitive. Signed-off-by: Libor Pechacek <redacted> Cc: Jeff King <redacted> --- Documentation/config.txt | 12 +++++++----- Documentation/git-config.txt | 4 +++- 2 files changed, 10 insertions(+), 6 deletions(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt
index ff7c225..0f23bc7 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt@@ -12,8 +12,9 @@ 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 dot-separated segment and the section name is everything before the last -dot. The variable names are case-insensitive and only alphanumeric -characters are allowed. Some variables may appear multiple times. +dot. The variable names are case-insensitive, only alphanumeric +characters and '-' are allowed and must start with an alphabetic character. +Some variables may appear multiple times. Syntax ~~~~~~
@@ -53,9 +54,10 @@ All the other lines (and the remainder of the line after the section header) are recognized as setting variables, in the form 'name = value'. If there is no equal sign on the line, the entire line is taken as 'name' and the variable is recognized as boolean "true". -The variable names are case-insensitive and only alphanumeric -characters and `-` are allowed. There can be more than one value -for a given variable; we say then that variable is multivalued. +The variable names are case-insensitive, only alphanumeric +characters and `-` are allowed and must start with an alphabetic character. +There can be more than one value for a given variable; we say then that +variable is multivalued. Leading and trailing whitespace in a variable value is discarded. Internal whitespace within a variable value is retained verbatim.
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index 543dd64..6966ed6 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt@@ -84,7 +84,9 @@ OPTIONS --get-regexp:: Like --get-all, but interprets the name as a regular expression. - Also outputs the key names. + Regular expression matching is case sensitive in all parts of the key, + therefore make sure your pattern matches lower case letters in section + and variable names. Also outputs the key names. --global:: For writing options: write to global ~/.gitconfig file rather than
--
1.7.4.rc2.2.gb4f4f