git-config: better document default behavior for `--include`
authorJeff King <peff@peff.net>
Mon, 19 Jan 2015 19:58:47 +0000 (14:58 -0500)
committerJunio C Hamano <gitster@pobox.com>
Sat, 13 Feb 2016 20:51:31 +0000 (12:51 -0800)
As described in the commit message of 9b25a0b (config: add
include directive, 2012-02-06), the `--include` option is
only on by default in some cases. But our documentation
described it as just "defaults to on", which doesn't tell
the whole story.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-config.txt
index aa8303b1adb1ac6efba6a5919a6a59495e89c6fb..eca302ef90bb7d0960c6d2d880e58e2c6d82e854 100644 (file)
@@ -181,7 +181,9 @@ See also <<FILES>>.
 --includes::
 --no-includes::
        Respect `include.*` directives in config files when looking up
-       values. Defaults to on.
+       values. Defaults to `off` when a specific file is given (e.g.,
+       using `--file`, `--global`, etc) and `on` when searching all
+       config files.
 
 [[FILES]]
 FILES