diff options
| author | Ramkumar Ramachandra <artagnon@gmail.com> | 2013-07-26 10:42:02 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2013-07-26 15:55:18 (GMT) |
| commit | 5ff0c0e8752f8613ff1143fe909b1797ad338a83 (patch) | |
| tree | 8dbab0fc55804ee8696f2cae896b24728641da84 | |
| parent | 117eea7eaaeb5ecb77d9b7cebdb40b4e85f37374 (diff) | |
| download | git-5ff0c0e8752f8613ff1143fe909b1797ad338a83.zip git-5ff0c0e8752f8613ff1143fe909b1797ad338a83.tar.gz git-5ff0c0e8752f8613ff1143fe909b1797ad338a83.tar.bz2 | |
config doc: quote paths, fixing tilde-interpretation
The --global section of git-config(1) currently reads like:
For writing options: write to global /.gitconfig file rather than the
^
start tilde
repository .git/config, write to $XDG_CONFIG_HOME/git/config file if
this file exists and the/.gitconfig file doesn’t.
^
end tilde
Instead of tilde (~) being interpreted literally, asciidoc subscripts
the text between the two tildes. To fix this problem, use backticks (`)
to quote all the paths in the file uniformly, just like config.txt does.
Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/git-config.txt | 26 |
1 files changed, 14 insertions, 12 deletions
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt index fbad05e..cc455ec 100644 --- a/Documentation/git-config.txt +++ b/Documentation/git-config.txt @@ -96,29 +96,31 @@ OPTIONS names are not. --global:: - For writing options: write to global ~/.gitconfig file rather than - the repository .git/config, write to $XDG_CONFIG_HOME/git/config file - if this file exists and the ~/.gitconfig file doesn't. + For writing options: write to global `~/.gitconfig` file + rather than the repository `.git/config`, write to + `$XDG_CONFIG_HOME/git/config` file if this file exists and the + `~/.gitconfig` file doesn't. + -For reading options: read only from global ~/.gitconfig and from -$XDG_CONFIG_HOME/git/config rather than from all available files. +For reading options: read only from global `~/.gitconfig` and from +`$XDG_CONFIG_HOME/git/config` rather than from all available files. + See also <<FILES>>. --system:: - For writing options: write to system-wide $(prefix)/etc/gitconfig - rather than the repository .git/config. + For writing options: write to system-wide + `$(prefix)/etc/gitconfig` rather than the repository + `.git/config`. + -For reading options: read only from system-wide $(prefix)/etc/gitconfig +For reading options: read only from system-wide `$(prefix)/etc/gitconfig` rather than from all available files. + See also <<FILES>>. --local:: - For writing options: write to the repository .git/config file. + For writing options: write to the repository `.git/config` file. This is the default behavior. + -For reading options: read only from the repository .git/config rather than +For reading options: read only from the repository `.git/config` rather than from all available files. + See also <<FILES>>. @@ -215,9 +217,9 @@ $GIT_DIR/config:: $XDG_CONFIG_HOME/git/config:: Second user-specific configuration file. If $XDG_CONFIG_HOME is not set - or empty, $HOME/.config/git/config will be used. Any single-valued + or empty, `$HOME/.config/git/config` will be used. Any single-valued variable set in this file will be overwritten by whatever is in - ~/.gitconfig. It is a good idea not to create this file if + `~/.gitconfig`. It is a good idea not to create this file if you sometimes use older versions of Git, as support for this file was added fairly recently. |