setup.h

   1 #ifndef SETUP_H
   2 #define SETUP_H
   3
   4 #include "string-list.h"
   5
   6 int is_inside_git_dir(void);
   7 int is_inside_work_tree(void);
   8 int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
   9 int get_common_dir(struct strbuf *sb, const char *gitdir);
  10
  11 /*
  12  * Return true if the given path is a git directory; note that this _just_
  13  * looks at the directory itself. If you want to know whether "foo/.git"
  14  * is a repository, you must feed that path, not just "foo".
  15  */
  16 int is_git_directory(const char *path);
  17
  18 /*
  19  * Return 1 if the given path is the root of a git repository or
  20  * submodule, else 0. Will not return 1 for bare repositories with the
  21  * exception of creating a bare repository in "foo/.git" and calling
  22  * is_git_repository("foo").
  23  *
  24  * If we run into read errors, we err on the side of saying "yes, it is",
  25  * as we usually consider sub-repos precious, and would prefer to err on the
  26  * side of not disrupting or deleting them.
  27  */
  28 int is_nonbare_repository_dir(struct strbuf *path);
  29
  30 #define READ_GITFILE_ERR_STAT_FAILED 1
  31 #define READ_GITFILE_ERR_NOT_A_FILE 2
  32 #define READ_GITFILE_ERR_OPEN_FAILED 3
  33 #define READ_GITFILE_ERR_READ_FAILED 4
  34 #define READ_GITFILE_ERR_INVALID_FORMAT 5
  35 #define READ_GITFILE_ERR_NO_PATH 6
  36 #define READ_GITFILE_ERR_NOT_A_REPO 7
  37 #define READ_GITFILE_ERR_TOO_LARGE 8
  38 void read_gitfile_error_die(int error_code, const char *path, const char *dir);
  39 const char *read_gitfile_gently(const char *path, int *return_error_code);
  40 #define read_gitfile(path) read_gitfile_gently((path), NULL)
  41 const char *resolve_gitdir_gently(const char *suspect, int *return_error_code);
  42 #define resolve_gitdir(path) resolve_gitdir_gently((path), NULL)
  43
  44 void setup_work_tree(void);
  45 /*
  46  * Find the commondir and gitdir of the repository that contains the current
  47  * working directory, without changing the working directory or other global
  48  * state. The result is appended to commondir and gitdir.  If the discovered
  49  * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will
  50  * both have the same result appended to the buffer.  The return value is
  51  * either 0 upon success and non-zero if no repository was found.
  52  */
  53 int discover_git_directory(struct strbuf *commondir,
  54                            struct strbuf *gitdir);
  55 const char *setup_git_directory_gently(int *);
  56 const char *setup_git_directory(void);
  57 char *prefix_path(const char *prefix, int len, const char *path);
  58 char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
  59
  60 int check_filename(const char *prefix, const char *name);
  61 void verify_filename(const char *prefix,
  62                      const char *name,
  63                      int diagnose_misspelt_rev);
  64 void verify_non_filename(const char *prefix, const char *name);
  65 int path_inside_repo(const char *prefix, const char *path);
  66
  67 void sanitize_stdfds(void);
  68 int daemonize(void);
  69
  70 /*
  71  * GIT_REPO_VERSION is the version we write by default. The
  72  * _READ variant is the highest number we know how to
  73  * handle.
  74  */
  75 #define GIT_REPO_VERSION 0
  76 #define GIT_REPO_VERSION_READ 1
  77
  78 /*
  79  * You _have_ to initialize a `struct repository_format` using
  80  * `= REPOSITORY_FORMAT_INIT` before calling `read_repository_format()`.
  81  */
  82 struct repository_format {
  83         int version;
  84         int precious_objects;
  85         char *partial_clone; /* value of extensions.partialclone */
  86         int worktree_config;
  87         int is_bare;
  88         int hash_algo;
  89         int sparse_index;
  90         char *work_tree;
  91         struct string_list unknown_extensions;
  92         struct string_list v1_only_extensions;
  93 };
  94
  95 /*
  96  * Always use this to initialize a `struct repository_format`
  97  * to a well-defined, default state before calling
  98  * `read_repository()`.
  99  */
 100 #define REPOSITORY_FORMAT_INIT \
 101 { \
 102         .version = -1, \
 103         .is_bare = -1, \
 104         .hash_algo = GIT_HASH_SHA1, \
 105         .unknown_extensions = STRING_LIST_INIT_DUP, \
 106         .v1_only_extensions = STRING_LIST_INIT_DUP, \
 107 }
 108
 109 /*
 110  * Read the repository format characteristics from the config file "path" into
 111  * "format" struct. Returns the numeric version. On error, or if no version is
 112  * found in the configuration, -1 is returned, format->version is set to -1,
 113  * and all other fields in the struct are set to the default configuration
 114  * (REPOSITORY_FORMAT_INIT). Always initialize the struct using
 115  * REPOSITORY_FORMAT_INIT before calling this function.
 116  */
 117 int read_repository_format(struct repository_format *format, const char *path);
 118
 119 /*
 120  * Free the memory held onto by `format`, but not the struct itself.
 121  * (No need to use this after `read_repository_format()` fails.)
 122  */
 123 void clear_repository_format(struct repository_format *format);
 124
 125 /*
 126  * Verify that the repository described by repository_format is something we
 127  * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
 128  * any errors encountered.
 129  */
 130 int verify_repository_format(const struct repository_format *format,
 131                              struct strbuf *err);
 132
 133 /*
 134  * Check the repository format version in the path found in get_git_dir(),
 135  * and die if it is a version we don't understand. Generally one would
 136  * set_git_dir() before calling this, and use it only for "are we in a valid
 137  * repo?".
 138  *
 139  * If successful and fmt is not NULL, fill fmt with data.
 140  */
 141 void check_repository_format(struct repository_format *fmt);
 142
 143 /*
 144  * NOTE NOTE NOTE!!
 145  *
 146  * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
 147  * not be changed. Old repositories have core.sharedrepository written in
 148  * numeric format, and therefore these values are preserved for compatibility
 149  * reasons.
 150  */
 151 enum sharedrepo {
 152         PERM_UMASK          = 0,
 153         OLD_PERM_GROUP      = 1,
 154         OLD_PERM_EVERYBODY  = 2,
 155         PERM_GROUP          = 0660,
 156         PERM_EVERYBODY      = 0664
 157 };
 158 int git_config_perm(const char *var, const char *value);
 159
 160 struct startup_info {
 161         int have_repository;
 162         const char *prefix;
 163         const char *original_cwd;
 164 };
 165 extern struct startup_info *startup_info;
 166 extern const char *tmp_original_cwd;
 167
 168 #endif /* SETUP_H */