[PATCH v2 2/4] Documentation: list all type specifiers in config prose
- From
Taylor Blau <me@ttaylorr.com>
- Date
- Mar 24, 2018, 00:55 UTC
- Message-ID
- <20180324005556.8145-3-me@ttaylorr.com>
- In-Reply-To
- <20180324005556.8145-1-me@ttaylorr.com>
The documentation for the `git-config(1)` builtin has not been recently updated to include new types, such as `--bool-or-int`, and `--expiry-date`. To ensure completeness when adding a new type specifier, let's update the existing documentation to include the new types.
Since this paragraph is growing in length, let's also convert this to a list so that it can be read with greater ease. We provide a minimal description of all valid type specifiers, and reference the <<OPTIONS>> section where each specifier is described in full detail.
This commit also prepares for the new type specifier `--color`, so that this section will not lag behind when yet more new specifiers are added.
Signed-off-by: Taylor Blau <me@ttaylorr.com> --- Documentation/git-config.txt | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-)
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt index d9e389a33..d9d45aca3 100644 --- a/Documentation/git-config.txt +++ b/Documentation/git-config.txt @@ -38,12 +38,25 @@ 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 also <<EXAMPLES>>). -The type specifier can be either `--int` or `--bool`, to 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, -a "true" or "false" string for bool), or `--path`, which does some -path expansion (see `--path` below). If no type specifier is passed, no -checks or transformations are performed on the value. +A type specifier option can be used to force interpretation of values and +conversion to canonical form. Currently supported type specifiers are: + +`bool`:: + The value is taken as a boolean. + +`int`:: + The value is taken as an integer. + +`bool-or-int`:: + The value is taken as a boolean or integer, as above. + +`path`:: + The value is taken as a filepath. + +`expiry-date`:: + The value is taken as a timestamp. + +For more information about the above type specifiers, see <<OPTIONS>> below. When reading, the values are read from the system, global and repository local configuration files by default, and options
-- 2.16.2.440.gc6284da4f