diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2018-05-23 14:38:10 +0900 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2018-05-23 14:38:10 +0900 |
| commit | d9a0ddc217b74615b901ad4dfdde04bfbde59770 (patch) | |
| tree | bb0414ebbcd9e4166a79d1aab1cb402f04b75e5a /Documentation/technical | |
| parent | Merge branch 'bc/mailmap-self' (diff) | |
| parent | doc: fix config API documentation about config_with_options (diff) | |
| download | tgif-d9a0ddc217b74615b901ad4dfdde04bfbde59770.tar.xz | |
Merge branch 'ao/config-api-doc'
Doc update.
* ao/config-api-doc:
doc: fix config API documentation about config_with_options
Diffstat (limited to 'Documentation/technical')
| -rw-r--r-- | Documentation/technical/api-config.txt | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/Documentation/technical/api-config.txt b/Documentation/technical/api-config.txt index 9a778b0cad..fa39ac9d71 100644 --- a/Documentation/technical/api-config.txt +++ b/Documentation/technical/api-config.txt @@ -47,21 +47,23 @@ will first feed the user-wide one to the callback, and then the repo-specific one; by overwriting, the higher-priority repo-specific value is left at the end). -The `git_config_with_options` function lets the caller examine config +The `config_with_options` function lets the caller examine config while adjusting some of the default behavior of `git_config`. It should almost never be used by "regular" Git code that is looking up configuration variables. It is intended for advanced callers like `git-config`, which are intentionally tweaking the normal config-lookup process. It takes two extra parameters: -`filename`:: -If this parameter is non-NULL, it specifies the name of a file to -parse for configuration, rather than looking in the usual files. Regular -`git_config` defaults to `NULL`. +`config_source`:: +If this parameter is non-NULL, it specifies the source to parse for +configuration, rather than looking in the usual files. See `struct +git_config_source` in `config.h` for details. Regular `git_config` defaults +to `NULL`. -`respect_includes`:: -Specify whether include directives should be followed in parsed files. -Regular `git_config` defaults to `1`. +`opts`:: +Specify options to adjust the behavior of parsing config files. See `struct +config_options` in `config.h` for details. As an example: regular `git_config` +sets `opts.respect_includes` to `1` by default. Reading Specific Files ---------------------- |