doc: fix config API documentation about config_with_options
In commit dc8441fdb ("config: don't implicitly use gitdir or commondir", 2017-06-14) the function git_config_with_options was renamed to config_with_options to better reflect the fact that it does not access the git global config or the repo config by default. However Documentation/technical/api-config.txt still refers to the previous name, fix that. While at it also update the documentation about the extra parameters, because they too changed since the initial definition. Signed-off-by: Antonio Ospite <ao2@ao2.it> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Antonio Ospite committed
May 9, 2018 at 15:16 UTC
f7997e36821d816710658874784cd538d134dee2
1 file changed
+10
-8
Documentation/technical/api-config.txt
+10
-8
@@ -47,21 +47,23 @@ will first feed the user-wide one to the callback, and then the
47
repo-specific one; by overwriting, the higher-priority repo-specific
48
value is left at the end).
49
50
-The `git_config_with_options` function lets the caller examine config
50
+The `config_with_options` function lets the caller examine config
51
while adjusting some of the default behavior of `git_config`. It should
52
almost never be used by "regular" Git code that is looking up
53
configuration variables. It is intended for advanced callers like
54
`git-config`, which are intentionally tweaking the normal config-lookup
55
process. It takes two extra parameters:
56
57
-`filename`::
58
-If this parameter is non-NULL, it specifies the name of a file to
59
-parse for configuration, rather than looking in the usual files. Regular
60
-`git_config` defaults to `NULL`.
57
+`config_source`::
58
+If this parameter is non-NULL, it specifies the source to parse for
59
+configuration, rather than looking in the usual files. See `struct
60
+git_config_source` in `config.h` for details. Regular `git_config` defaults
61
+to `NULL`.
62
62
-`respect_includes`::
63
-Specify whether include directives should be followed in parsed files.
64
-Regular `git_config` defaults to `1`.
63
+`opts`::
64
+Specify options to adjust the behavior of parsing config files. See `struct
65
+config_options` in `config.h` for details. As an example: regular `git_config`
66
+sets `opts.respect_includes` to `1` by default.
67
68
Reading Specific Files
69
----------------------