diff options
Diffstat (limited to 'include/git2/config.h')
| -rw-r--r-- | include/git2/config.h | 52 |
1 files changed, 17 insertions, 35 deletions
diff --git a/include/git2/config.h b/include/git2/config.h index e05d23694..74ee96bde 100644 --- a/include/git2/config.h +++ b/include/git2/config.h @@ -1,26 +1,8 @@ /* - * This file is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License, version 2, - * as published by the Free Software Foundation. - * - * In addition to the permissions in the GNU General Public License, - * the authors give you unlimited permission to link the compiled - * version of this file into combinations with other programs, - * and to distribute those combinations without any restriction - * coming from the use of this file. (The General Public License - * restrictions do apply in other respects; for example, they cover - * modification of the file, and distribution when not linked into - * a combined executable.) - * - * This file is distributed in the hope that it will be useful, but - * WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; see the file COPYING. If not, write to - * the Free Software Foundation, 51 Franklin Street, Fifth Floor, - * Boston, MA 02110-1301, USA. + * Copyright (C) 2009-2011 the libgit2 contributors + * + * This file is part of libgit2, distributed under the GNU GPL v2 with + * a Linking Exception. For full terms see the included COPYING file. */ #ifndef INCLUDE_git_config_h__ #define INCLUDE_git_config_h__ @@ -76,7 +58,7 @@ GIT_EXTERN(int) git_config_find_global(char *global_config_path); * and opens the located file, if it exists. * * @param out Pointer to store the config instance - * @return GIT_SUCCESS on success; error code otherwise + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_config_open_global(git_config **out); @@ -100,7 +82,7 @@ GIT_EXTERN(int) git_config_file__ondisk(struct git_config_file **out, const char * can do anything with it. * * @param out pointer to the new configuration - * @return GIT_SUCCESS on success; error code otherwise + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_config_new(git_config **out); @@ -117,7 +99,7 @@ GIT_EXTERN(int) git_config_new(git_config **out); * @param cfg the configuration to add the file to * @param file the configuration file (backend) to add * @param priority the priority the backend should have - * @return GIT_SUCCESS on success; error code otherwise + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_config_add_file(git_config *cfg, git_config_file *file, int priority); @@ -138,7 +120,7 @@ GIT_EXTERN(int) git_config_add_file(git_config *cfg, git_config_file *file, int * @param cfg the configuration to add the file to * @param path path to the configuration file (backend) to add * @param priority the priority the backend should have - * @return GIT_SUCCESS on success; error code otherwise + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_config_add_file_ondisk(git_config *cfg, const char *path, int priority); @@ -153,7 +135,7 @@ GIT_EXTERN(int) git_config_add_file_ondisk(git_config *cfg, const char *path, in * * @param cfg The configuration instance to create * @param path Path to the on-disk file to open - * @return GIT_SUCCESS on success; error code otherwise + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_config_open_ondisk(git_config **cfg, const char *path); @@ -170,7 +152,7 @@ GIT_EXTERN(void) git_config_free(git_config *cfg); * @param cfg where to look for the variable * @param name the variable's name * @param out pointer to the variable where the value should be stored - * @return GIT_SUCCESS on success; error code otherwise + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_config_get_int(git_config *cfg, const char *name, int *out); @@ -180,7 +162,7 @@ GIT_EXTERN(int) git_config_get_int(git_config *cfg, const char *name, int *out); * @param cfg where to look for the variable * @param name the variable's name * @param out pointer to the variable where the value should be stored - * @return GIT_SUCCESS on success; error code otherwise + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_config_get_long(git_config *cfg, const char *name, long int *out); @@ -193,7 +175,7 @@ GIT_EXTERN(int) git_config_get_long(git_config *cfg, const char *name, long int * @param cfg where to look for the variable * @param name the variable's name * @param out pointer to the variable where the value should be stored - * @return GIT_SUCCESS on success; error code otherwise + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_config_get_bool(git_config *cfg, const char *name, int *out); @@ -206,7 +188,7 @@ GIT_EXTERN(int) git_config_get_bool(git_config *cfg, const char *name, int *out) * @param cfg where to look for the variable * @param name the variable's name * @param out pointer to the variable's value - * @return GIT_SUCCESS on success; error code otherwise + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_config_get_string(git_config *cfg, const char *name, const char **out); @@ -216,7 +198,7 @@ GIT_EXTERN(int) git_config_get_string(git_config *cfg, const char *name, const c * @param cfg where to look for the variable * @param name the variable's name * @param value Integer value for the variable - * @return GIT_SUCCESS on success; error code otherwise + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_config_set_int(git_config *cfg, const char *name, int value); @@ -226,7 +208,7 @@ GIT_EXTERN(int) git_config_set_int(git_config *cfg, const char *name, int value) * @param cfg where to look for the variable * @param name the variable's name * @param value Long integer value for the variable - * @return GIT_SUCCESS on success; error code otherwise + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_config_set_long(git_config *cfg, const char *name, long int value); @@ -236,7 +218,7 @@ GIT_EXTERN(int) git_config_set_long(git_config *cfg, const char *name, long int * @param cfg where to look for the variable * @param name the variable's name * @param value the value to store - * @return GIT_SUCCESS on success; error code otherwise + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_config_set_bool(git_config *cfg, const char *name, int value); @@ -249,7 +231,7 @@ GIT_EXTERN(int) git_config_set_bool(git_config *cfg, const char *name, int value * @param cfg where to look for the variable * @param name the variable's name * @param value the string to store. - * @return GIT_SUCCESS on success; error code otherwise + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_config_set_string(git_config *cfg, const char *name, const char *value); |