environment.con commit Documentation: remove unnecessary backslashes (c200deb)
   1/*
   2 * We put all the git config variables in this same object
   3 * file, so that programs can link against the config parser
   4 * without having to link against all the rest of git.
   5 *
   6 * In particular, no need to bring in libz etc unless needed,
   7 * even if you might want to know where the git directory etc
   8 * are.
   9 */
  10#include "cache.h"
  11#include "refs.h"
  12#include "fmt-merge-msg.h"
  13#include "commit.h"
  14
  15int trust_executable_bit = 1;
  16int trust_ctime = 1;
  17int check_stat = 1;
  18int has_symlinks = 1;
  19int minimum_abbrev = 4, default_abbrev = 7;
  20int ignore_case;
  21int assume_unchanged;
  22int prefer_symlink_refs;
  23int is_bare_repository_cfg = -1; /* unspecified */
  24int log_all_ref_updates = -1; /* unspecified */
  25int warn_ambiguous_refs = 1;
  26int warn_on_object_refname_ambiguity = 1;
  27int ref_paranoia = -1;
  28int repository_format_version;
  29int repository_format_precious_objects;
  30const char *git_commit_encoding;
  31const char *git_log_output_encoding;
  32int shared_repository = PERM_UMASK;
  33const char *apply_default_whitespace;
  34const char *apply_default_ignorewhitespace;
  35const char *git_attributes_file;
  36int zlib_compression_level = Z_BEST_SPEED;
  37int core_compression_level;
  38int core_compression_seen;
  39int fsync_object_files;
  40size_t packed_git_window_size = DEFAULT_PACKED_GIT_WINDOW_SIZE;
  41size_t packed_git_limit = DEFAULT_PACKED_GIT_LIMIT;
  42size_t delta_base_cache_limit = 96 * 1024 * 1024;
  43unsigned long big_file_threshold = 512 * 1024 * 1024;
  44const char *pager_program;
  45int pager_use_color = 1;
  46const char *editor_program;
  47const char *askpass_program;
  48const char *excludes_file;
  49enum auto_crlf auto_crlf = AUTO_CRLF_FALSE;
  50int check_replace_refs = 1;
  51char *git_replace_ref_base;
  52enum eol core_eol = EOL_UNSET;
  53enum safe_crlf safe_crlf = SAFE_CRLF_WARN;
  54unsigned whitespace_rule_cfg = WS_DEFAULT_RULE;
  55enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
  56enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
  57enum push_default_type push_default = PUSH_DEFAULT_UNSPECIFIED;
  58#ifndef OBJECT_CREATION_MODE
  59#define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
  60#endif
  61enum object_creation_mode object_creation_mode = OBJECT_CREATION_MODE;
  62char *notes_ref_name;
  63int grafts_replace_parents = 1;
  64int core_apply_sparse_checkout;
  65int merge_log_config = -1;
  66int precomposed_unicode = -1; /* see probe_utf8_pathname_composition() */
  67struct startup_info *startup_info;
  68unsigned long pack_size_limit_cfg;
  69
  70#ifndef PROTECT_HFS_DEFAULT
  71#define PROTECT_HFS_DEFAULT 0
  72#endif
  73int protect_hfs = PROTECT_HFS_DEFAULT;
  74
  75#ifndef PROTECT_NTFS_DEFAULT
  76#define PROTECT_NTFS_DEFAULT 0
  77#endif
  78int protect_ntfs = PROTECT_NTFS_DEFAULT;
  79
  80/*
  81 * The character that begins a commented line in user-editable file
  82 * that is subject to stripspace.
  83 */
  84char comment_line_char = '#';
  85int auto_comment_line_char;
  86
  87/* Parallel index stat data preload? */
  88int core_preload_index = 1;
  89
  90/* This is set by setup_git_dir_gently() and/or git_default_config() */
  91char *git_work_tree_cfg;
  92static char *work_tree;
  93
  94static const char *namespace;
  95static size_t namespace_len;
  96
  97static const char *git_dir, *git_common_dir;
  98static char *git_object_dir, *git_index_file, *git_graft_file;
  99int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
 100
 101/*
 102 * Repository-local GIT_* environment variables; see cache.h for details.
 103 */
 104const char * const local_repo_env[] = {
 105        ALTERNATE_DB_ENVIRONMENT,
 106        CONFIG_ENVIRONMENT,
 107        CONFIG_DATA_ENVIRONMENT,
 108        DB_ENVIRONMENT,
 109        GIT_DIR_ENVIRONMENT,
 110        GIT_WORK_TREE_ENVIRONMENT,
 111        GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
 112        GRAFT_ENVIRONMENT,
 113        INDEX_ENVIRONMENT,
 114        NO_REPLACE_OBJECTS_ENVIRONMENT,
 115        GIT_REPLACE_REF_BASE_ENVIRONMENT,
 116        GIT_PREFIX_ENVIRONMENT,
 117        GIT_SHALLOW_FILE_ENVIRONMENT,
 118        GIT_COMMON_DIR_ENVIRONMENT,
 119        NULL
 120};
 121
 122static char *expand_namespace(const char *raw_namespace)
 123{
 124        struct strbuf buf = STRBUF_INIT;
 125        struct strbuf **components, **c;
 126
 127        if (!raw_namespace || !*raw_namespace)
 128                return xstrdup("");
 129
 130        strbuf_addstr(&buf, raw_namespace);
 131        components = strbuf_split(&buf, '/');
 132        strbuf_reset(&buf);
 133        for (c = components; *c; c++)
 134                if (strcmp((*c)->buf, "/") != 0)
 135                        strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
 136        strbuf_list_free(components);
 137        if (check_refname_format(buf.buf, 0))
 138                die("bad git namespace path \"%s\"", raw_namespace);
 139        strbuf_addch(&buf, '/');
 140        return strbuf_detach(&buf, NULL);
 141}
 142
 143static char *git_path_from_env(const char *envvar, const char *git_dir,
 144                               const char *path, int *fromenv)
 145{
 146        const char *value = getenv(envvar);
 147        if (!value)
 148                return xstrfmt("%s/%s", git_dir, path);
 149        if (fromenv)
 150                *fromenv = 1;
 151        return xstrdup(value);
 152}
 153
 154static void setup_git_env(void)
 155{
 156        struct strbuf sb = STRBUF_INIT;
 157        const char *gitfile;
 158        const char *shallow_file;
 159        const char *replace_ref_base;
 160
 161        git_dir = getenv(GIT_DIR_ENVIRONMENT);
 162        if (!git_dir)
 163                git_dir = DEFAULT_GIT_DIR_ENVIRONMENT;
 164        gitfile = read_gitfile(git_dir);
 165        git_dir = xstrdup(gitfile ? gitfile : git_dir);
 166        if (get_common_dir(&sb, git_dir))
 167                git_common_dir_env = 1;
 168        git_common_dir = strbuf_detach(&sb, NULL);
 169        git_object_dir = git_path_from_env(DB_ENVIRONMENT, git_common_dir,
 170                                           "objects", &git_db_env);
 171        git_index_file = git_path_from_env(INDEX_ENVIRONMENT, git_dir,
 172                                           "index", &git_index_env);
 173        git_graft_file = git_path_from_env(GRAFT_ENVIRONMENT, git_common_dir,
 174                                           "info/grafts", &git_graft_env);
 175        if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
 176                check_replace_refs = 0;
 177        replace_ref_base = getenv(GIT_REPLACE_REF_BASE_ENVIRONMENT);
 178        git_replace_ref_base = xstrdup(replace_ref_base ? replace_ref_base
 179                                                          : "refs/replace/");
 180        namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
 181        namespace_len = strlen(namespace);
 182        shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
 183        if (shallow_file)
 184                set_alternate_shallow_file(shallow_file, 0);
 185}
 186
 187int is_bare_repository(void)
 188{
 189        /* if core.bare is not 'false', let's see if there is a work tree */
 190        return is_bare_repository_cfg && !get_git_work_tree();
 191}
 192
 193const char *get_git_dir(void)
 194{
 195        if (!git_dir)
 196                setup_git_env();
 197        return git_dir;
 198}
 199
 200const char *get_git_common_dir(void)
 201{
 202        return git_common_dir;
 203}
 204
 205const char *get_git_namespace(void)
 206{
 207        if (!namespace)
 208                setup_git_env();
 209        return namespace;
 210}
 211
 212const char *strip_namespace(const char *namespaced_ref)
 213{
 214        if (!starts_with(namespaced_ref, get_git_namespace()))
 215                return NULL;
 216        return namespaced_ref + namespace_len;
 217}
 218
 219static int git_work_tree_initialized;
 220
 221/*
 222 * Note.  This works only before you used a work tree.  This was added
 223 * primarily to support git-clone to work in a new repository it just
 224 * created, and is not meant to flip between different work trees.
 225 */
 226void set_git_work_tree(const char *new_work_tree)
 227{
 228        if (git_work_tree_initialized) {
 229                new_work_tree = real_path(new_work_tree);
 230                if (strcmp(new_work_tree, work_tree))
 231                        die("internal error: work tree has already been set\n"
 232                            "Current worktree: %s\nNew worktree: %s",
 233                            work_tree, new_work_tree);
 234                return;
 235        }
 236        git_work_tree_initialized = 1;
 237        work_tree = xstrdup(real_path(new_work_tree));
 238}
 239
 240const char *get_git_work_tree(void)
 241{
 242        return work_tree;
 243}
 244
 245char *get_object_directory(void)
 246{
 247        if (!git_object_dir)
 248                setup_git_env();
 249        return git_object_dir;
 250}
 251
 252int odb_mkstemp(char *template, size_t limit, const char *pattern)
 253{
 254        int fd;
 255        /*
 256         * we let the umask do its job, don't try to be more
 257         * restrictive except to remove write permission.
 258         */
 259        int mode = 0444;
 260        snprintf(template, limit, "%s/%s",
 261                 get_object_directory(), pattern);
 262        fd = git_mkstemp_mode(template, mode);
 263        if (0 <= fd)
 264                return fd;
 265
 266        /* slow path */
 267        /* some mkstemp implementations erase template on failure */
 268        snprintf(template, limit, "%s/%s",
 269                 get_object_directory(), pattern);
 270        safe_create_leading_directories(template);
 271        return xmkstemp_mode(template, mode);
 272}
 273
 274int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1)
 275{
 276        int fd;
 277
 278        snprintf(name, namesz, "%s/pack/pack-%s.keep",
 279                 get_object_directory(), sha1_to_hex(sha1));
 280        fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
 281        if (0 <= fd)
 282                return fd;
 283
 284        /* slow path */
 285        safe_create_leading_directories(name);
 286        return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
 287}
 288
 289char *get_index_file(void)
 290{
 291        if (!git_index_file)
 292                setup_git_env();
 293        return git_index_file;
 294}
 295
 296char *get_graft_file(void)
 297{
 298        if (!git_graft_file)
 299                setup_git_env();
 300        return git_graft_file;
 301}
 302
 303int set_git_dir(const char *path)
 304{
 305        if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
 306                return error("Could not set GIT_DIR to '%s'", path);
 307        setup_git_env();
 308        return 0;
 309}
 310
 311const char *get_log_output_encoding(void)
 312{
 313        return git_log_output_encoding ? git_log_output_encoding
 314                : get_commit_output_encoding();
 315}
 316
 317const char *get_commit_output_encoding(void)
 318{
 319        return git_commit_encoding ? git_commit_encoding : "UTF-8";
 320}