Skip to content

Commit

Permalink
config.txt: add missing 'the's and make words plural
Browse files Browse the repository at this point in the history
Signed-off-by: Stephen Boyd <bebarino@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Stephen Boyd authored and Junio C Hamano committed Apr 23, 2009
1 parent 50710ce commit 773002a
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions Documentation/config.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ CONFIGURATION FILE
------------------

The git configuration file contains a number of variables that affect
the git command's behavior. `.git/config` file for each repository
the git command's behavior. The `.git/config` file in each repository
is used to store the information for that repository, and
`$HOME/.gitconfig` is used to store per user information to give
fallback values for `.git/config` file. The file `/etc/gitconfig`
`$HOME/.gitconfig` is used to store per user information as
fallback values for the `.git/config` file. The file `/etc/gitconfig`
can be used to store system-wide defaults.

They can be used by both the git plumbing
Expand All @@ -26,28 +26,28 @@ The file consists of sections and variables. A section begins with
the name of the section in square brackets and continues until the next
section begins. Section names are not case sensitive. Only alphanumeric
characters, `-` and `.` are allowed in section names. Each variable
must belong to some section, which means that there must be section
header before first setting of a variable.
must belong to some section, which means that there must be a section
header before the first setting of a variable.

Sections can be further divided into subsections. To begin a subsection
put its name in double quotes, separated by space from the section name,
in the section header, like in example below:
in the section header, like in the example below:

--------
[section "subsection"]

--------

Subsection names can contain any characters except newline (doublequote
Subsection names can contain any character except newline (doublequote
`"` and backslash have to be escaped as `\"` and `\\`,
respectively) and are case sensitive. Section header cannot span multiple
respectively) and are case sensitive. Section headers cannot span multiple
lines. Variables may belong directly to a section or to a given subsection.
You can have `[section]` if you have `[section "subsection"]`, but you
don't need to.

There is also (case insensitive) alternative `[section.subsection]` syntax.
In this syntax subsection names follow the same restrictions as for section
name.
There is also a case insensitive alternative `[section.subsection]` syntax.
In this syntax, subsection names follow the same restrictions as for section
names.

All the other lines are recognized as setting variables, in the form
'name = value'. If there is no equal sign on the line, the entire line
Expand All @@ -66,21 +66,21 @@ converting value to the canonical form using '--bool' type specifier;
'git-config' will ensure that the output is "true" or "false".

String values may be entirely or partially enclosed in double quotes.
You need to enclose variable value in double quotes if you want to
preserve leading or trailing whitespace, or if variable value contains
beginning of comment characters (if it contains '#' or ';').
Double quote `"` and backslash `\` characters in variable value must
You need to enclose variable values in double quotes if you want to
preserve leading or trailing whitespace, or if the variable value contains
comment characters (i.e. it contains '#' or ';').
Double quote `"` and backslash `\` characters in variable values must
be escaped: use `\"` for `"` and `\\` for `\`.

The following escape sequences (beside `\"` and `\\`) are recognized:
`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
and `\b` for backspace (BS). No other char escape sequence, nor octal
char sequences are valid.

Variable value ending in a `\` is continued on the next line in the
Variable values ending in a `\` are continued on the next line in the
customary UNIX fashion.

Some variables may require special value format.
Some variables may require a special value format.

Example
~~~~~~~
Expand Down

0 comments on commit 773002a

Please sign in to comment.