From 6fddfe5dae5b964e29b5d594311b4ab3c963b711 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Thu, 31 May 2007 07:38:19 +0000 Subject: [PATCH] Autogenerated HTML docs for v1.5.2-146-gb75c6 --- git-config.html | 77 ++++++++++++++++++++++++++++++++++++++++++------- git-config.txt | 76 +++++++++++++++++++++++++++++++++++++++++------- 2 files changed, 131 insertions(+), 22 deletions(-) diff --git a/git-config.html b/git-config.html index fa978c771..ee533dab3 100644 --- a/git-config.html +++ b/git-config.html @@ -294,7 +294,7 @@ If you want to update or unset an option which can occur on multiple lines, a POSIX regexp value_regex needs to be given. Only the existing values that match the regexp are updated or unset. If you want to handle the lines that do not match the regex, just -prepend a single exclamation mark in front (see EXAMPLES).

+prepend a single exclamation mark in front (see also [EXAMPLES]).

The type specifier can be either --int or --bool, which will make git-config ensure that the variable(s) are of the given type and convert the value to the canonical form (simple decimal number for int, @@ -335,7 +335,7 @@ you try to unset/set an option for which multiple lines match, or

  • -you use --global option without $HOME being properly set. +you use --global option without $HOME being properly set.

    • @@ -393,17 +393,24 @@ you use --global option without $HOME being properly set.

    - Use global ~/.gitconfig file rather than the repository .git/config. + For writing options: write to global ~/.gitconfig file rather than + the repository .git/config.

    +

    For reading options: read only from global ~/.gitconfig rather than +from all available files.

    +

    See also [FILES].

    --system

    - Use 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 +rather than from all available files.

    +

    See also [FILES].

    --remove-section @@ -466,6 +473,53 @@ you use --global option without $HOME being properly set. +

    FILES

    +
    +

    There are three files where git-config will search for configuration +options:

    +
    +
    git/config::
    +
    +
    Repository specific configuration file. (The filename is
+of course relative to the repository root, not the working
+directory.)
    +
    +
    +
    +~/.gitconfig +
    +
    +

    + User-specific configuration file. Also called "global" + configuration file. +

    +
    +
    +$(prefix)/etc/gitconfig +
    +
    +

    + System-wide configuration file. +

    +
    +
    +

    If no further options are given, all reading options will read all of these +files that are available. If the global or the system-wide configuration +file are not available they will be ignored. If the repository configuration +file is not available or readable, git-config will exit with a non-zero +error code. However, in neither case will an error message be issued.

    +

    All writing options will per default write to the repository specific +configuration file. Note that this also affects options like --replace-all +and --unset. git-config will only ever change one file at a time.

    +

    You can override these rules either by command line options or by environment +variables. The --global and the --system options will limit the file used +to the global or system-wide file respectively. The GIT_CONFIG environment +variable has a similar effect, but you can specify any filename you want.

    +

    The GIT_CONFIG_LOCAL environment variable on the other hand only changes +the name used instead of the repository configuration file. The global and +the system-wide configuration files will still be read. (For writing options +this will obviously result in the same behavior as using GIT_CONFIG.)

    +

    ENVIRONMENT

    @@ -475,7 +529,8 @@ GIT_CONFIG

    Take the configuration from the given file instead of .git/config. - Using the "--global" option forces this to ~/.gitconfig. + Using the "--global" option forces this to ~/.gitconfig. Using the + "--system" option forces this to $(prefix)/etc/gitconfig.

    @@ -483,14 +538,14 @@ GIT_CONFIG_LOCAL

    - Currently the same as $GIT_CONFIG; when Git will support global - configuration files, this will cause it to take the configuration - from the global configuration file in addition to the given file. + Take the configuration from the given file instead if .git/config. + Still read the global and the system-wide configuration files, though.

    +

    See also [FILES].

    -

    EXAMPLE

    +

    EXAMPLES

    Given a .git/config like this:

    @@ -1702,7 +1757,7 @@ transfer.unpackLimit
    diff --git a/git-config.txt b/git-config.txt index 827a49970..056b14724 100644 --- a/git-config.txt +++ b/git-config.txt @@ -31,7 +31,7 @@ If you want to update or unset an option which can occur on multiple lines, a POSIX regexp `value_regex` needs to be given. Only the existing values that match the regexp are updated or unset. If you want to handle the lines that do *not* match the regex, just -prepend a single exclamation mark in front (see EXAMPLES). +prepend a single exclamation mark in front (see also <>). The type specifier can be either '--int' or '--bool', which will make 'git-config' ensure that the variable(s) are of the given type and @@ -48,7 +48,7 @@ This command will fail if: . the section or key is invalid, . you try to unset an option which does not exist, . you try to unset/set an option for which multiple lines match, or -. you use --global option without $HOME being properly set. +. you use '--global' option without $HOME being properly set. OPTIONS @@ -75,11 +75,22 @@ OPTIONS Like --get-all, but interprets the name as a regular expression. --global:: - Use global ~/.gitconfig file rather than the repository .git/config. + For writing options: write to global ~/.gitconfig file rather than + the repository .git/config. ++ +For reading options: read only from global ~/.gitconfig rather than +from all available files. ++ +See also <>. --system:: - Use 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 +rather than from all available files. ++ +See also <>. --remove-section:: Remove the given section from the configuration file. @@ -106,21 +117,64 @@ OPTIONS by 1024, 1048576, or 1073741824 prior to output. +[[FILES]] +FILES +----- + +There are three files where git-config will search for configuration +options: + +.git/config:: + Repository specific configuration file. (The filename is + of course relative to the repository root, not the working + directory.) + +~/.gitconfig:: + User-specific configuration file. Also called "global" + configuration file. + +$(prefix)/etc/gitconfig:: + System-wide configuration file. + +If no further options are given, all reading options will read all of these +files that are available. If the global or the system-wide configuration +file are not available they will be ignored. If the repository configuration +file is not available or readable, git-config will exit with a non-zero +error code. However, in neither case will an error message be issued. + +All writing options will per default write to the repository specific +configuration file. Note that this also affects options like '--replace-all' +and '--unset'. *git-config will only ever change one file at a time*. + +You can override these rules either by command line options or by environment +variables. The '--global' and the '--system' options will limit the file used +to the global or system-wide file respectively. The GIT_CONFIG environment +variable has a similar effect, but you can specify any filename you want. + +The GIT_CONFIG_LOCAL environment variable on the other hand only changes +the name used instead of the repository configuration file. The global and +the system-wide configuration files will still be read. (For writing options +this will obviously result in the same behavior as using GIT_CONFIG.) + + ENVIRONMENT ----------- GIT_CONFIG:: Take the configuration from the given file instead of .git/config. - Using the "--global" option forces this to ~/.gitconfig. + Using the "--global" option forces this to ~/.gitconfig. Using the + "--system" option forces this to $(prefix)/etc/gitconfig. GIT_CONFIG_LOCAL:: - Currently the same as $GIT_CONFIG; when Git will support global - configuration files, this will cause it to take the configuration - from the global configuration file in addition to the given file. + Take the configuration from the given file instead if .git/config. + Still read the global and the system-wide configuration files, though. +See also <>. -EXAMPLE -------- + +[[EXAMPLES]] +EXAMPLES +-------- Given a .git/config like this: -- 2.26.2