Update draft release notes for 1.5.4

[git.git] / Documentation / git-config.txt

diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index 5b794f439990e3ddeb80adee31de44063ef44ee6..98509b4f441abc7671645ece78c9ba83a8dac4c0 100644 (file)
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -20,6 +20,8 @@ SYNOPSIS
 'git-config' [<file-option>] --rename-section old_name new_name
 'git-config' [<file-option>] --remove-section name
 'git-config' [<file-option>] [-z|--null] -l | --list
 'git-config' [<file-option>] --rename-section old_name new_name
 'git-config' [<file-option>] --remove-section name
 'git-config' [<file-option>] [-z|--null] -l | --list

+'git-config' [<file-option>] --get-color name [default]
+'git-config' [<file-option>] --get-colorbool name [stdout-is-tty]

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -134,6 +136,21 @@ See also <<FILES>>.
        output without getting confused e.g. by values that
        contain line breaks.
 
        output without getting confused e.g. by values that
        contain line breaks.
 

+--get-colorbool name [stdout-is-tty]::
+
+       Find the color setting for `name` (e.g. `color.diff`) and output
+       "true" or "false".  `stdout-is-tty` should be either "true" or
+       "false", and is taken into account when configuration says
+       "auto".  If `stdout-is-tty` is missing, then checks the standard
+       output of the command itself, and exits with status 0 if color
+       is to be used, or exits with status 1 otherwise.
+
+--get-color name default::
+
+       Find the color configured for `name` (e.g. `color.diff.new`) and
+       output it as the ANSI color escape sequence to the standard
+       output.  The optional `default` parameter is used instead, if
+       there is no color configured for `name`.

 
 [[FILES]]
 FILES
 
 [[FILES]]
 FILES


@@ -142,7 +159,7 @@ FILES
 If not set explicitly with '--file', there are three files where
 git-config will search for configuration options:
 
 If not set explicitly with '--file', there are three files where
 git-config will search for configuration options:
 

-.git/config::
+$GIT_DIR/config::

        Repository specific configuration file. (The filename is
        of course relative to the repository root, not the working
        directory.)
        Repository specific configuration file. (The filename is
        of course relative to the repository root, not the working
        directory.)


@@ -292,6 +309,15 @@ To add a new proxy, without altering any of the existing ones, use
 % git config core.gitproxy '"proxy-command" for example.com'
 ------------
 
 % git config core.gitproxy '"proxy-command" for example.com'
 ------------
 

+An example to use customized color from the configuration in your
+script:
+
+------------
+#!/bin/sh
+WS=$(git config --get-color color.diff.whitespace "blue reverse")
+RESET=$(git config --get-color "" "reset")
+echo "${WS}your whitespace color or blue reverse${RESET}"
+------------

 
 include::config.txt[]
 
 
 include::config.txt[]