config: move documentation to config.h
Move the documentation from Documentation/technical/api-config.txt into config.h as it's easier for the developers to find the usage information beside the code instead of looking for it in another doc file, also documentation/technical/api-config.txt is removed because the information it has is now redundant and it'll be hard to keep it up to date and syncronized with the documentation in config.h Signed-off-by: Heba Waly <heba.waly@gmail.com> Reviewed-by: Emily Shaffer <emilyshaffer@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Heba Waly committed
Oct 23, 2019 at 05:30 UTC
6c96630cb0900446f7069f64d3d58bac539c0a58
2 files changed
+335
-319
Documentation/technical/api-config.txt
deleted
-319
@@ -1,319 +0,0 @@
1
-config API
2
-==========
3
-
4
-The config API gives callers a way to access Git configuration files
5
-(and files which have the same syntax). See linkgit:git-config[1] for a
6
-discussion of the config file syntax.
7
-
8
-General Usage
9
--------------
10
-
11
-Config files are parsed linearly, and each variable found is passed to a
12
-caller-provided callback function. The callback function is responsible
13
-for any actions to be taken on the config option, and is free to ignore
14
-some options. It is not uncommon for the configuration to be parsed
15
-several times during the run of a Git program, with different callbacks
16
-picking out different variables useful to themselves.
17
-
18
-A config callback function takes three parameters:
19
-
20
-- the name of the parsed variable. This is in canonical "flat" form: the
21
- section, subsection, and variable segments will be separated by dots,
22
- and the section and variable segments will be all lowercase. E.g.,
23
- `core.ignorecase`, `diff.SomeType.textconv`.
24
-
25
-- the value of the found variable, as a string. If the variable had no
26
- value specified, the value will be NULL (typically this means it
27
- should be interpreted as boolean true).
28
-
29
-- a void pointer passed in by the caller of the config API; this can
30
- contain callback-specific data
31
-
32
-A config callback should return 0 for success, or -1 if the variable
33
-could not be parsed properly.
34
-
35
-Basic Config Querying
36
----------------------
37
-
38
-Most programs will simply want to look up variables in all config files
39
-that Git knows about, using the normal precedence rules. To do this,
40
-call `git_config` with a callback function and void data pointer.
41
-
42
-`git_config` will read all config sources in order of increasing
43
-priority. Thus a callback should typically overwrite previously-seen
44
-entries with new ones (e.g., if both the user-wide `~/.gitconfig` and
45
-repo-specific `.git/config` contain `color.ui`, the config machinery
46
-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 `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
-`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
-
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
-----------------------
70
-
71
-To read a specific file in git-config format, use
72
-`git_config_from_file`. This takes the same callback and data parameters
73
-as `git_config`.
74
-
75
-Querying For Specific Variables
76
--------------------------------
77
-
78
-For programs wanting to query for specific variables in a non-callback
79
-manner, the config API provides two functions `git_config_get_value`
80
-and `git_config_get_value_multi`. They both read values from an internal
81
-cache generated previously from reading the config files.
82
-
83
-`int git_config_get_value(const char *key, const char **value)`::
84
-
85
- Finds the highest-priority value for the configuration variable `key`,
86
- stores the pointer to it in `value` and returns 0. When the
87
- configuration variable `key` is not found, returns 1 without touching
88
- `value`. The caller should not free or modify `value`, as it is owned
89
- by the cache.
90
-
91
-`const struct string_list *git_config_get_value_multi(const char *key)`::
92
-
93
- Finds and returns the value list, sorted in order of increasing priority
94
- for the configuration variable `key`. When the configuration variable
95
- `key` is not found, returns NULL. The caller should not free or modify
96
- the returned pointer, as it is owned by the cache.
97
-
98
-`void git_config_clear(void)`::
99
-
100
- Resets and invalidates the config cache.
101
-
102
-The config API also provides type specific API functions which do conversion
103
-as well as retrieval for the queried variable, including:
104
-
105
-`int git_config_get_int(const char *key, int *dest)`::
106
-
107
- Finds and parses the value to an integer for the configuration variable
108
- `key`. Dies on error; otherwise, stores the value of the parsed integer in
109
- `dest` and returns 0. When the configuration variable `key` is not found,
110
- returns 1 without touching `dest`.
111
-
112
-`int git_config_get_ulong(const char *key, unsigned long *dest)`::
113
-
114
- Similar to `git_config_get_int` but for unsigned longs.
115
-
116
-`int git_config_get_bool(const char *key, int *dest)`::
117
-
118
- Finds and parses the value into a boolean value, for the configuration
119
- variable `key` respecting keywords like "true" and "false". Integer
120
- values are converted into true/false values (when they are non-zero or
121
- zero, respectively). Other values cause a die(). If parsing is successful,
122
- stores the value of the parsed result in `dest` and returns 0. When the
123
- configuration variable `key` is not found, returns 1 without touching
124
- `dest`.
125
-
126
-`int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)`::
127
-
128
- Similar to `git_config_get_bool`, except that integers are copied as-is,
129
- and `is_bool` flag is unset.
130
-
131
-`int git_config_get_maybe_bool(const char *key, int *dest)`::
132
-
133
- Similar to `git_config_get_bool`, except that it returns -1 on error
134
- rather than dying.
135
-
136
-`int git_config_get_string_const(const char *key, const char **dest)`::
137
-
138
- Allocates and copies the retrieved string into the `dest` parameter for
139
- the configuration variable `key`; if NULL string is given, prints an
140
- error message and returns -1. When the configuration variable `key` is
141
- not found, returns 1 without touching `dest`.
142
-
143
-`int git_config_get_string(const char *key, char **dest)`::
144
-
145
- Similar to `git_config_get_string_const`, except that retrieved value
146
- copied into the `dest` parameter is a mutable string.
147
-
148
-`int git_config_get_pathname(const char *key, const char **dest)`::
149
-
150
- Similar to `git_config_get_string`, but expands `~` or `~user` into
151
- the user's home directory when found at the beginning of the path.
152
-
153
-`git_die_config(const char *key, const char *err, ...)`::
154
-
155
- First prints the error message specified by the caller in `err` and then
156
- dies printing the line number and the file name of the highest priority
157
- value for the configuration variable `key`.
158
-
159
-`void git_die_config_linenr(const char *key, const char *filename, int linenr)`::
160
-
161
- Helper function which formats the die error message according to the
162
- parameters entered. Used by `git_die_config()`. It can be used by callers
163
- handling `git_config_get_value_multi()` to print the correct error message
164
- for the desired value.
165
-
166
-See test-config.c for usage examples.
167
-
168
-Value Parsing Helpers
169
----------------------
170
-
171
-To aid in parsing string values, the config API provides callbacks with
172
-a number of helper functions, including:
173
-
174
-`git_config_int`::
175
-Parse the string to an integer, including unit factors. Dies on error;
176
-otherwise, returns the parsed result.
177
-
178
-`git_config_ulong`::
179
-Identical to `git_config_int`, but for unsigned longs.
180
-
181
-`git_config_bool`::
182
-Parse a string into a boolean value, respecting keywords like "true" and
183
-"false". Integer values are converted into true/false values (when they
184
-are non-zero or zero, respectively). Other values cause a die(). If
185
-parsing is successful, the return value is the result.
186
-
187
-`git_config_bool_or_int`::
188
-Same as `git_config_bool`, except that integers are returned as-is, and
189
-an `is_bool` flag is unset.
190
-
191
-`git_parse_maybe_bool`::
192
-Same as `git_config_bool`, except that it returns -1 on error rather
193
-than dying.
194
-
195
-`git_config_string`::
196
-Allocates and copies the value string into the `dest` parameter; if no
197
-string is given, prints an error message and returns -1.
198
-
199
-`git_config_pathname`::
200
-Similar to `git_config_string`, but expands `~` or `~user` into the
201
-user's home directory when found at the beginning of the path.
202
-
203
-Include Directives
204
-------------------
205
-
206
-By default, the config parser does not respect include directives.
207
-However, a caller can use the special `git_config_include` wrapper
208
-callback to support them. To do so, you simply wrap your "real" callback
209
-function and data pointer in a `struct config_include_data`, and pass
210
-the wrapper to the regular config-reading functions. For example:
211
-
212
--------------------------------------------
213
-int read_file_with_include(const char *file, config_fn_t fn, void *data)
214
-{
215
- struct config_include_data inc = CONFIG_INCLUDE_INIT;
216
- inc.fn = fn;
217
- inc.data = data;
218
- return git_config_from_file(git_config_include, file, &inc);
219
-}
220
--------------------------------------------
221
-
222
-`git_config` respects includes automatically. The lower-level
223
-`git_config_from_file` does not.
224
-
225
-Custom Configsets
226
------------------
227
-
228
-A `config_set` can be used to construct an in-memory cache for
229
-config-like files that the caller specifies (i.e., files like `.gitmodules`,
230
-`~/.gitconfig` etc.). For example,
231
-
232
-----------------------------------------
233
-struct config_set gm_config;
234
-git_configset_init(&gm_config);
235
-int b;
236
-/* we add config files to the config_set */
237
-git_configset_add_file(&gm_config, ".gitmodules");
238
-git_configset_add_file(&gm_config, ".gitmodules_alt");
239
-
240
-if (!git_configset_get_bool(gm_config, "submodule.frotz.ignore", &b)) {
241
- /* hack hack hack */
242
-}
243
-
244
-/* when we are done with the configset */
245
-git_configset_clear(&gm_config);
246
-----------------------------------------
247
-
248
-Configset API provides functions for the above mentioned work flow, including:
249
-
250
-`void git_configset_init(struct config_set *cs)`::
251
-
252
- Initializes the config_set `cs`.
253
-
254
-`int git_configset_add_file(struct config_set *cs, const char *filename)`::
255
-
256
- Parses the file and adds the variable-value pairs to the `config_set`,
257
- dies if there is an error in parsing the file. Returns 0 on success, or
258
- -1 if the file does not exist or is inaccessible. The user has to decide
259
- if he wants to free the incomplete configset or continue using it when
260
- the function returns -1.
261
-
262
-`int git_configset_get_value(struct config_set *cs, const char *key, const char **value)`::
263
-
264
- Finds the highest-priority value for the configuration variable `key`
265
- and config set `cs`, stores the pointer to it in `value` and returns 0.
266
- When the configuration variable `key` is not found, returns 1 without
267
- touching `value`. The caller should not free or modify `value`, as it
268
- is owned by the cache.
269
-
270
-`const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)`::
271
-
272
- Finds and returns the value list, sorted in order of increasing priority
273
- for the configuration variable `key` and config set `cs`. When the
274
- configuration variable `key` is not found, returns NULL. The caller
275
- should not free or modify the returned pointer, as it is owned by the cache.
276
-
277
-`void git_configset_clear(struct config_set *cs)`::
278
-
279
- Clears `config_set` structure, removes all saved variable-value pairs.
280
-
281
-In addition to above functions, the `config_set` API provides type specific
282
-functions in the vein of `git_config_get_int` and family but with an extra
283
-parameter, pointer to struct `config_set`.
284
-They all behave similarly to the `git_config_get*()` family described in
285
-"Querying For Specific Variables" above.
286
-
287
-Writing Config Files
288
---------------------
289
-
290
-Git gives multiple entry points in the Config API to write config values to
291
-files namely `git_config_set_in_file` and `git_config_set`, which write to
292
-a specific config file or to `.git/config` respectively. They both take a
293
-key/value pair as parameter.
294
-In the end they both call `git_config_set_multivar_in_file` which takes four
295
-parameters:
296
-
297
-- the name of the file, as a string, to which key/value pairs will be written.
298
-
299
-- the name of key, as a string. This is in canonical "flat" form: the section,
300
- subsection, and variable segments will be separated by dots, and the section
301
- and variable segments will be all lowercase.
302
- E.g., `core.ignorecase`, `diff.SomeType.textconv`.
303
-
304
-- the value of the variable, as a string. If value is equal to NULL, it will
305
- remove the matching key from the config file.
306
-
307
-- the value regex, as a string. It will disregard key/value pairs where value
308
- does not match.
309
-
310
-- a multi_replace value, as an int. If value is equal to zero, nothing or only
311
- one matching key/value is replaced, else all matching key/values (regardless
312
- how many) are removed, before the new pair is written.
313
-
314
-It returns 0 on success.
315
-
316
-Also, there are functions `git_config_rename_section` and
317
-`git_config_rename_section_in_file` with parameters `old_name` and `new_name`
318
-for renaming or removing sections in the config files. If NULL is passed
319
-through `new_name` parameter, the section will be removed from the config file.
config.h
+335
@@ -4,6 +4,22 @@
4
#include "hashmap.h"
5
#include "string-list.h"
6
7
+
8
+/**
9
+ * The config API gives callers a way to access Git configuration files
10
+ * (and files which have the same syntax).
11
+ *
12
+ * General Usage
13
+ * -------------
14
+ *
15
+ * Config files are parsed linearly, and each variable found is passed to a
16
+ * caller-provided callback function. The callback function is responsible
17
+ * for any actions to be taken on the config option, and is free to ignore
18
+ * some options. It is not uncommon for the configuration to be parsed
19
+ * several times during the run of a Git program, with different callbacks
20
+ * picking out different variables useful to themselves.
21
+ */
22
+
23
struct object_id;
24
25
/* git_config_parse_key() returns these negated: */
@@ -71,9 +87,34 @@ struct config_options {
87
} error_action;
88
};
89
90
+/**
91
+ * A config callback function takes three parameters:
92
+ *
93
+ * - the name of the parsed variable. This is in canonical "flat" form: the
94
+ * section, subsection, and variable segments will be separated by dots,
95
+ * and the section and variable segments will be all lowercase. E.g.,
96
+ * `core.ignorecase`, `diff.SomeType.textconv`.
97
+ *
98
+ * - the value of the found variable, as a string. If the variable had no
99
+ * value specified, the value will be NULL (typically this means it
100
+ * should be interpreted as boolean true).
101
+ *
102
+ * - a void pointer passed in by the caller of the config API; this can
103
+ * contain callback-specific data
104
+ *
105
+ * A config callback should return 0 for success, or -1 if the variable
106
+ * could not be parsed properly.
107
+ */
108
typedef int (*config_fn_t)(const char *, const char *, void *);
109
+
110
int git_default_config(const char *, const char *, void *);
111
+
112
+/**
113
+ * Read a specific file in git-config format.
114
+ * This function takes the same callback and data parameters as `git_config`.
115
+ */
116
int git_config_from_file(config_fn_t fn, const char *, void *);
117
+
118
int git_config_from_file_with_options(config_fn_t fn, const char *,
119
void *,
120
const struct config_options *);
@@ -88,34 +129,157 @@ void git_config_push_parameter(const char *text);
129
int git_config_from_parameters(config_fn_t fn, void *data);
130
void read_early_config(config_fn_t cb, void *data);
131
void read_very_early_config(config_fn_t cb, void *data);
132
+
133
+/**
134
+ * Most programs will simply want to look up variables in all config files
135
+ * that Git knows about, using the normal precedence rules. To do this,
136
+ * call `git_config` with a callback function and void data pointer.
137
+ *
138
+ * `git_config` will read all config sources in order of increasing
139
+ * priority. Thus a callback should typically overwrite previously-seen
140
+ * entries with new ones (e.g., if both the user-wide `~/.gitconfig` and
141
+ * repo-specific `.git/config` contain `color.ui`, the config machinery
142
+ * will first feed the user-wide one to the callback, and then the
143
+ * repo-specific one; by overwriting, the higher-priority repo-specific
144
+ * value is left at the end).
145
+ */
146
void git_config(config_fn_t fn, void *);
147
+
148
+/**
149
+ * Lets the caller examine config while adjusting some of the default
150
+ * behavior of `git_config`. It should almost never be used by "regular"
151
+ * Git code that is looking up configuration variables.
152
+ * It is intended for advanced callers like `git-config`, which are
153
+ * intentionally tweaking the normal config-lookup process.
154
+ * It takes two extra parameters:
155
+ *
156
+ * - `config_source`
157
+ * If this parameter is non-NULL, it specifies the source to parse for
158
+ * configuration, rather than looking in the usual files. See `struct
159
+ * git_config_source` in `config.h` for details. Regular `git_config` defaults
160
+ * to `NULL`.
161
+ *
162
+ * - `opts`
163
+ * Specify options to adjust the behavior of parsing config files. See `struct
164
+ * config_options` in `config.h` for details. As an example: regular `git_config`
165
+ * sets `opts.respect_includes` to `1` by default.
166
+ */
167
int config_with_options(config_fn_t fn, void *,
168
struct git_config_source *config_source,
169
const struct config_options *opts);
170
+
171
+/**
172
+ * Value Parsing Helpers
173
+ * ---------------------
174
+ *
175
+ * The following helper functions aid in parsing string values
176
+ */
177
+
178
int git_parse_ssize_t(const char *, ssize_t *);
179
int git_parse_ulong(const char *, unsigned long *);
180
+
181
+/**
182
+ * Same as `git_config_bool`, except that it returns -1 on error rather
183
+ * than dying.
184
+ */
185
int git_parse_maybe_bool(const char *);
186
+
187
+/**
188
+ * Parse the string to an integer, including unit factors. Dies on error;
189
+ * otherwise, returns the parsed result.
190
+ */
191
int git_config_int(const char *, const char *);
192
+
193
int64_t git_config_int64(const char *, const char *);
194
+
195
+/**
196
+ * Identical to `git_config_int`, but for unsigned longs.
197
+ */
198
unsigned long git_config_ulong(const char *, const char *);
199
+
200
ssize_t git_config_ssize_t(const char *, const char *);
201
+
202
+/**
203
+ * Same as `git_config_bool`, except that integers are returned as-is, and
204
+ * an `is_bool` flag is unset.
205
+ */
206
int git_config_bool_or_int(const char *, const char *, int *);
207
+
208
+/**
209
+ * Parse a string into a boolean value, respecting keywords like "true" and
210
+ * "false". Integer values are converted into true/false values (when they
211
+ * are non-zero or zero, respectively). Other values cause a die(). If
212
+ * parsing is successful, the return value is the result.
213
+ */
214
int git_config_bool(const char *, const char *);
215
+
216
+/**
217
+ * Allocates and copies the value string into the `dest` parameter; if no
218
+ * string is given, prints an error message and returns -1.
219
+ */
220
int git_config_string(const char **, const char *, const char *);
221
+
222
+/**
223
+ * Similar to `git_config_string`, but expands `~` or `~user` into the
224
+ * user's home directory when found at the beginning of the path.
225
+ */
226
int git_config_pathname(const char **, const char *, const char *);
227
+
228
int git_config_expiry_date(timestamp_t *, const char *, const char *);
229
int git_config_color(char *, const char *, const char *);
230
int git_config_set_in_file_gently(const char *, const char *, const char *);
231
+
232
+/**
233
+ * write config values to a specific config file, takes a key/value pair as
234
+ * parameter.
235
+ */
236
void git_config_set_in_file(const char *, const char *, const char *);
237
+
238
int git_config_set_gently(const char *, const char *);
239
+
240
+/**
241
+ * write config values to `.git/config`, takes a key/value pair as parameter.
242
+ */
243
void git_config_set(const char *, const char *);
244
+
245
int git_config_parse_key(const char *, char **, int *);
246
int git_config_key_is_valid(const char *key);
247
int git_config_set_multivar_gently(const char *, const char *, const char *, int);
248
void git_config_set_multivar(const char *, const char *, const char *, int);
249
int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, int);
250
+
251
+/**
252
+ * takes four parameters:
253
+ *
254
+ * - the name of the file, as a string, to which key/value pairs will be written.
255
+ *
256
+ * - the name of key, as a string. This is in canonical "flat" form: the section,
257
+ * subsection, and variable segments will be separated by dots, and the section
258
+ * and variable segments will be all lowercase.
259
+ * E.g., `core.ignorecase`, `diff.SomeType.textconv`.
260
+ *
261
+ * - the value of the variable, as a string. If value is equal to NULL, it will
262
+ * remove the matching key from the config file.
263
+ *
264
+ * - the value regex, as a string. It will disregard key/value pairs where value
265
+ * does not match.
266
+ *
267
+ * - a multi_replace value, as an int. If value is equal to zero, nothing or only
268
+ * one matching key/value is replaced, else all matching key/values (regardless
269
+ * how many) are removed, before the new pair is written.
270
+ *
271
+ * It returns 0 on success.
272
+ */
273
void git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
274
+
275
+/**
276
+ * rename or remove sections in the config file
277
+ * parameters `old_name` and `new_name`
278
+ * If NULL is passed through `new_name` parameter,
279
+ * the section will be removed from the config file.
280
+ */
281
int git_config_rename_section(const char *, const char *);
282
+
283
int git_config_rename_section_in_file(const char *, const char *, const char *);
284
int git_config_copy_section(const char *, const char *);
285
int git_config_copy_section_in_file(const char *, const char *, const char *);
@@ -142,6 +306,30 @@ enum config_scope current_config_scope(void);
306
const char *current_config_origin_type(void);
307
const char *current_config_name(void);
308
309
+/**
310
+ * Include Directives
311
+ * ------------------
312
+ *
313
+ * By default, the config parser does not respect include directives.
314
+ * However, a caller can use the special `git_config_include` wrapper
315
+ * callback to support them. To do so, you simply wrap your "real" callback
316
+ * function and data pointer in a `struct config_include_data`, and pass
317
+ * the wrapper to the regular config-reading functions. For example:
318
+ *
319
+ * -------------------------------------------
320
+ * int read_file_with_include(const char *file, config_fn_t fn, void *data)
321
+ * {
322
+ * struct config_include_data inc = CONFIG_INCLUDE_INIT;
323
+ * inc.fn = fn;
324
+ * inc.data = data;
325
+ * return git_config_from_file(git_config_include, file, &inc);
326
+ * }
327
+ * -------------------------------------------
328
+ *
329
+ * `git_config` respects includes automatically. The lower-level
330
+ * `git_config_from_file` does not.
331
+ *
332
+ */
333
struct config_include_data {
334
int depth;
335
config_fn_t fn;
@@ -169,6 +357,33 @@ int parse_config_key(const char *var,
357
const char **subsection, int *subsection_len,
358
const char **key);
359
360
+/**
361
+ * Custom Configsets
362
+ * -----------------
363
+ *
364
+ * A `config_set` can be used to construct an in-memory cache for
365
+ * config-like files that the caller specifies (i.e., files like `.gitmodules`,
366
+ * `~/.gitconfig` etc.). For example,
367
+ *
368
+ * ----------------------------------------
369
+ * struct config_set gm_config;
370
+ * git_configset_init(&gm_config);
371
+ * int b;
372
+ * //we add config files to the config_set
373
+ * git_configset_add_file(&gm_config, ".gitmodules");
374
+ * git_configset_add_file(&gm_config, ".gitmodules_alt");
375
+ *
376
+ * if (!git_configset_get_bool(gm_config, "submodule.frotz.ignore", &b)) {
377
+ * //hack hack hack
378
+ * }
379
+ *
380
+ * when we are done with the configset:
381
+ * git_configset_clear(&gm_config);
382
+ * ----------------------------------------
383
+ *
384
+ * Configset API provides functions for the above mentioned work flow
385
+ */
386
+
387
struct config_set_element {
388
struct hashmap_entry ent;
389
char *key;
@@ -197,16 +412,47 @@ struct config_set {
412
struct configset_list list;
413
};
414
415
+/**
416
+ * Initializes the config_set `cs`.
417
+ */
418
void git_configset_init(struct config_set *cs);
419
+
420
+/**
421
+ * Parses the file and adds the variable-value pairs to the `config_set`,
422
+ * dies if there is an error in parsing the file. Returns 0 on success, or
423
+ * -1 if the file does not exist or is inaccessible. The user has to decide
424
+ * if he wants to free the incomplete configset or continue using it when
425
+ * the function returns -1.
426
+ */
427
int git_configset_add_file(struct config_set *cs, const char *filename);
428
+
429
+/**
430
+ * Finds and returns the value list, sorted in order of increasing priority
431
+ * for the configuration variable `key` and config set `cs`. When the
432
+ * configuration variable `key` is not found, returns NULL. The caller
433
+ * should not free or modify the returned pointer, as it is owned by the cache.
434
+ */
435
const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
436
+
437
+/**
438
+ * Clears `config_set` structure, removes all saved variable-value pairs.
439
+ */
440
void git_configset_clear(struct config_set *cs);
441
442
/*
443
* These functions return 1 if not found, and 0 if found, leaving the found
444
* value in the 'dest' pointer.
445
*/
446
+
447
+/*
448
+ * Finds the highest-priority value for the configuration variable `key`
449
+ * and config set `cs`, stores the pointer to it in `value` and returns 0.
450
+ * When the configuration variable `key` is not found, returns 1 without
451
+ * touching `value`. The caller should not free or modify `value`, as it
452
+ * is owned by the cache.
453
+ */
454
int git_configset_get_value(struct config_set *cs, const char *key, const char **dest);
455
+
456
int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
457
int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
458
int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
@@ -240,17 +486,94 @@ int repo_config_get_maybe_bool(struct repository *repo,
486
int repo_config_get_pathname(struct repository *repo,
487
const char *key, const char **dest);
488
489
+/**
490
+ * Querying For Specific Variables
491
+ * -------------------------------
492
+ *
493
+ * For programs wanting to query for specific variables in a non-callback
494
+ * manner, the config API provides two functions `git_config_get_value`
495
+ * and `git_config_get_value_multi`. They both read values from an internal
496
+ * cache generated previously from reading the config files.
497
+ */
498
+
499
+/**
500
+ * Finds the highest-priority value for the configuration variable `key`,
501
+ * stores the pointer to it in `value` and returns 0. When the
502
+ * configuration variable `key` is not found, returns 1 without touching
503
+ * `value`. The caller should not free or modify `value`, as it is owned
504
+ * by the cache.
505
+ */
506
int git_config_get_value(const char *key, const char **value);
507
+
508
+/**
509
+ * Finds and returns the value list, sorted in order of increasing priority
510
+ * for the configuration variable `key`. When the configuration variable
511
+ * `key` is not found, returns NULL. The caller should not free or modify
512
+ * the returned pointer, as it is owned by the cache.
513
+ */
514
const struct string_list *git_config_get_value_multi(const char *key);
515
+
516
+/**
517
+ * Resets and invalidates the config cache.
518
+ */
519
void git_config_clear(void);
520
+
521
+/**
522
+ * Allocates and copies the retrieved string into the `dest` parameter for
523
+ * the configuration variable `key`; if NULL string is given, prints an
524
+ * error message and returns -1. When the configuration variable `key` is
525
+ * not found, returns 1 without touching `dest`.
526
+ */
527
int git_config_get_string_const(const char *key, const char **dest);
528
+
529
+/**
530
+ * Similar to `git_config_get_string_const`, except that retrieved value
531
+ * copied into the `dest` parameter is a mutable string.
532
+ */
533
int git_config_get_string(const char *key, char **dest);
534
+
535
+/**
536
+ * Finds and parses the value to an integer for the configuration variable
537
+ * `key`. Dies on error; otherwise, stores the value of the parsed integer in
538
+ * `dest` and returns 0. When the configuration variable `key` is not found,
539
+ * returns 1 without touching `dest`.
540
+ */
541
int git_config_get_int(const char *key, int *dest);
542
+
543
+/**
544
+ * Similar to `git_config_get_int` but for unsigned longs.
545
+ */
546
int git_config_get_ulong(const char *key, unsigned long *dest);
547
+
548
+/**
549
+ * Finds and parses the value into a boolean value, for the configuration
550
+ * variable `key` respecting keywords like "true" and "false". Integer
551
+ * values are converted into true/false values (when they are non-zero or
552
+ * zero, respectively). Other values cause a die(). If parsing is successful,
553
+ * stores the value of the parsed result in `dest` and returns 0. When the
554
+ * configuration variable `key` is not found, returns 1 without touching
555
+ * `dest`.
556
+ */
557
int git_config_get_bool(const char *key, int *dest);
558
+
559
+/**
560
+ * Similar to `git_config_get_bool`, except that integers are copied as-is,
561
+ * and `is_bool` flag is unset.
562
+ */
563
int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
564
+
565
+/**
566
+ * Similar to `git_config_get_bool`, except that it returns -1 on error
567
+ * rather than dying.
568
+ */
569
int git_config_get_maybe_bool(const char *key, int *dest);
570
+
571
+/**
572
+ * Similar to `git_config_get_string`, but expands `~` or `~user` into
573
+ * the user's home directory when found at the beginning of the path.
574
+ */
575
int git_config_get_pathname(const char *key, const char **dest);
576
+
577
int git_config_get_index_threads(int *dest);
578
int git_config_get_untracked_cache(void);
579
int git_config_get_split_index(void);
@@ -270,7 +593,19 @@ struct key_value_info {
593
enum config_scope scope;
594
};
595
596
+/**
597
+ * First prints the error message specified by the caller in `err` and then
598
+ * dies printing the line number and the file name of the highest priority
599
+ * value for the configuration variable `key`.
600
+ */
601
NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
602
+
603
+/**
604
+ * Helper function which formats the die error message according to the
605
+ * parameters entered. Used by `git_die_config()`. It can be used by callers
606
+ * handling `git_config_get_value_multi()` to print the correct error message
607
+ * for the desired value.
608
+ */
609
NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
610
611
#define LOOKUP_CONFIG(mapping, var) \