undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'ao/config-api-doc'

Browse Source 
Doc update.

* ao/config-api-doc:
  doc: fix config API documentation about config_with_options
This commit is contained in:
Junio C Hamano 2018-05-23 14:38:10 +09:00
commit d9a0ddc217
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Documentation/technical/api-config.txt
View File

@ -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 repo-specific one; by overwriting, the higher-priority repo-specific
value is left at the end). 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 while adjusting some of the default behavior of `git_config`. It should
almost never be used by "regular" Git code that is looking up almost never be used by "regular" Git code that is looking up
configuration variables. It is intended for advanced callers like configuration variables. It is intended for advanced callers like
`git-config`, which are intentionally tweaking the normal config-lookup `git-config`, which are intentionally tweaking the normal config-lookup
process. It takes two extra parameters: process. It takes two extra parameters:
`filename`:: `config_source`::
If this parameter is non-NULL, it specifies the name of a file to If this parameter is non-NULL, it specifies the source to parse for
parse for configuration, rather than looking in the usual files. Regular configuration, rather than looking in the usual files. See `struct
`git_config` defaults to `NULL`. git_config_source` in `config.h` for details. Regular `git_config` defaults
to `NULL`.
`respect_includes`:: `opts`::
Specify whether include directives should be followed in parsed files. Specify options to adjust the behavior of parsing config files. See `struct
Regular `git_config` defaults to `1`. config_options` in `config.h` for details. As an example: regular `git_config`
sets `opts.respect_includes` to `1` by default.
Reading Specific Files Reading Specific Files
---------------------- ----------------------