Skip to content

Commit

Permalink
Documentation fixes in git-config
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Libor Pechacek authored and Junio C Hamano committed Mar 1, 2012
1 parent b0fa280 commit e0a4aae
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 7 deletions.
12 changes: 7 additions & 5 deletions Documentation/config.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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, allow only alphanumeric
characters and `-`, and must start with an alphabetic character. Some
variables may appear multiple times.

Syntax
~~~~~~
Expand Down Expand Up @@ -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
'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, allow only alphanumeric characters
and `-`, and must start with an alphabetic character. There can be more
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.
Internal whitespace within a variable value is retained verbatim.
Expand Down
7 changes: 5 additions & 2 deletions Documentation/git-config.txt
Original file line number Diff line number Diff line change
Expand Up @@ -85,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
Expand Down

0 comments on commit e0a4aae

Please sign in to comment.