diff options
Diffstat (limited to 'include')
| -rw-r--r-- | include/git2/common.h | 41 | ||||
| -rw-r--r-- | include/git2/strarray.h | 4 |
2 files changed, 35 insertions, 10 deletions
diff --git a/include/git2/common.h b/include/git2/common.h index 7066d5ea3..b8c3e42ce 100644 --- a/include/git2/common.h +++ b/include/git2/common.h @@ -128,7 +128,9 @@ enum { GIT_OPT_GET_MWINDOW_SIZE, GIT_OPT_SET_MWINDOW_SIZE, GIT_OPT_GET_MWINDOW_MAPPED_LIMIT, - GIT_OPT_SET_MWINDOW_MAPPED_LIMIT + GIT_OPT_SET_MWINDOW_MAPPED_LIMIT, + GIT_OPT_GET_SEARCH_PATH, + GIT_OPT_SET_SEARCH_PATH, }; /** @@ -136,17 +138,40 @@ enum { * * Available options: * - * opts(GIT_OPT_MWINDOW_SIZE, size_t): - * set the maximum mmap window size + * opts(GIT_OPT_GET_MWINDOW_SIZE, size_t *): + * Get the maximum mmap window size * - * opts(GIT_OPT_MWINDOW_MAPPED_LIMIT, size_t): - * set the maximum amount of memory that can be mapped at any time + * opts(GIT_OPT_SET_MWINDOW_SIZE, size_t): + * Set the maximum mmap window size + * + * opts(GIT_OPT_GET_MWINDOW_MAPPED_LIMIT, size_t *): + * Get the maximum memory that will be mapped in total by the library + * + * opts(GIT_OPT_SET_MWINDOW_MAPPED_LIMIT, size_t): + * Set the maximum amount of memory that can be mapped at any time * by the library * - * @param option Option key - * @param ... value to set the option + * opts(GIT_OPT_GET_SEARCH_PATH, int level, char *out, size_t len) + * Get the search path for a given level of config data. "level" must + * be one of GIT_CONFIG_LEVEL_SYSTEM, GIT_CONFIG_LEVEL_GLOBAL, or + * GIT_CONFIG_LEVEL_XDG. The search path is written to the `out` + * buffer up to size `len`. Returns GIT_EBUFS if buffer is too small. + * + * opts(GIT_OPT_SET_SEARCH_PATH, int level, const char *path) + * Set the search path for a level of config data. The search path + * applied to shared attributes and ignore files, too. + * - `path` lists directories delimited by GIT_PATH_LIST_SEPARATOR. + * Pass NULL to reset to the default (generally based on environment + * variables). Use magic path `$PATH` to include the old value + * of the path (if you want to prepend or append, for instance). + * - `level` must be GIT_CONFIG_LEVEL_SYSTEM, GIT_CONFIG_LEVEL_GLOBAL, + * or GIT_CONFIG_LEVEL_XDG. + * + * @param option Option key + * @param ... value to set the option + * @return 0 on success, <0 on failure */ -GIT_EXTERN(void) git_libgit2_opts(int option, ...); +GIT_EXTERN(int) git_libgit2_opts(int option, ...); /** @} */ GIT_END_DECL diff --git a/include/git2/strarray.h b/include/git2/strarray.h index 6ea570c14..d338eb7ad 100644 --- a/include/git2/strarray.h +++ b/include/git2/strarray.h @@ -43,8 +43,8 @@ GIT_EXTERN(void) git_strarray_free(git_strarray *array); /** * Copy a string array object from source to target. * - * Note: target is overwritten and hence should be empty, - * otherwise its contents are leaked. + * Note: target is overwritten and hence should be empty, otherwise its + * contents are leaked. Call git_strarray_free() if necessary. * * @param tgt target * @param src source |