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