Documentation fixes in git-config

Variable names must start with an alphabetic character, regexp config key
matching has its limits, sentence grammar.

Signed-off-by: Libor Pechacek <lpechacek@suse.cz>
Acked-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Libor Pechacek 2012-03-01 11:59:45 +01:00 committed by Junio C Hamano
parent b0fa280751
commit e0a4aae865
2 changed files with 12 additions and 7 deletions

View File

@ -12,8 +12,9 @@ The configuration variables are used by both the git plumbing
and the porcelains. The variables are divided into sections, wherein and the porcelains. The variables are divided into sections, wherein
the fully qualified variable name of the variable itself is the last 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-separated segment and the section name is everything before the last
dot. The variable names are case-insensitive and only alphanumeric dot. The variable names are case-insensitive, allow only alphanumeric
characters are allowed. Some variables may appear multiple times. characters and `-`, and must start with an alphabetic character. Some
variables may appear multiple times.
Syntax Syntax
~~~~~~ ~~~~~~
@ -54,9 +55,10 @@ All the other lines (and the remainder of the line after the section
header) are recognized as setting variables, in the form header) are recognized as setting variables, in the form
'name = value'. If there is no equal sign on the line, the entire line '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". is taken as 'name' and the variable is recognized as boolean "true".
The variable names are case-insensitive and only alphanumeric The variable names are case-insensitive, allow only alphanumeric characters
characters and `-` are allowed. There can be more than one value and `-`, and must start with an alphabetic character. There can be more
for a given variable; we say then that variable is multivalued. than one value for a given variable; we say then that the variable is
multivalued.
Leading and trailing whitespace in a variable value is discarded. Leading and trailing whitespace in a variable value is discarded.
Internal whitespace within a variable value is retained verbatim. Internal whitespace within a variable value is retained verbatim.

View File

@ -85,8 +85,11 @@ OPTIONS
is not exactly one. is not exactly one.
--get-regexp:: --get-regexp::
Like --get-all, but interprets the name as a regular expression. Like --get-all, but interprets the name as a regular expression and
Also outputs the key names. 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:: --global::
For writing options: write to global ~/.gitconfig file rather than For writing options: write to global ~/.gitconfig file rather than