t0080: mark as leak-free
[alt-git.git] / setup.h
blob3599aec93c5ac0b72aafaf3cdcb030831cc53e3b
1 #ifndef SETUP_H
2 #define SETUP_H
4 #include "string-list.h"
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);
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".
16 int is_git_directory(const char *path);
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").
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.
28 int is_nonbare_repository_dir(struct strbuf *path);
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)
44 void setup_work_tree(void);
47 * discover_git_directory_reason() is similar to discover_git_directory(),
48 * except it returns an enum value instead. It is important to note that
49 * a zero-valued return here is actually GIT_DIR_NONE, which is different
50 * from discover_git_directory.
52 enum discovery_result {
53 GIT_DIR_EXPLICIT = 1,
54 GIT_DIR_DISCOVERED = 2,
55 GIT_DIR_BARE = 3,
56 /* these are errors */
57 GIT_DIR_HIT_CEILING = -1,
58 GIT_DIR_HIT_MOUNT_POINT = -2,
59 GIT_DIR_INVALID_GITFILE = -3,
60 GIT_DIR_INVALID_OWNERSHIP = -4,
61 GIT_DIR_DISALLOWED_BARE = -5,
62 GIT_DIR_INVALID_FORMAT = -6,
63 GIT_DIR_CWD_FAILURE = -7,
65 enum discovery_result discover_git_directory_reason(struct strbuf *commondir,
66 struct strbuf *gitdir);
69 * Find the commondir and gitdir of the repository that contains the current
70 * working directory, without changing the working directory or other global
71 * state. The result is appended to commondir and gitdir. If the discovered
72 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will
73 * both have the same result appended to the buffer. The return value is
74 * either 0 upon success and -1 if no repository was found.
76 static inline int discover_git_directory(struct strbuf *commondir,
77 struct strbuf *gitdir)
79 if (discover_git_directory_reason(commondir, gitdir) <= 0)
80 return -1;
81 return 0;
84 const char *setup_git_directory_gently(int *);
85 const char *setup_git_directory(void);
86 char *prefix_path(const char *prefix, int len, const char *path);
87 char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
89 int check_filename(const char *prefix, const char *name);
90 void verify_filename(const char *prefix,
91 const char *name,
92 int diagnose_misspelt_rev);
93 void verify_non_filename(const char *prefix, const char *name);
94 int path_inside_repo(const char *prefix, const char *path);
96 void sanitize_stdfds(void);
97 int daemonize(void);
100 * GIT_REPO_VERSION is the version we write by default. The
101 * _READ variant is the highest number we know how to
102 * handle.
104 #define GIT_REPO_VERSION 0
105 #define GIT_REPO_VERSION_READ 1
108 * You _have_ to initialize a `struct repository_format` using
109 * `= REPOSITORY_FORMAT_INIT` before calling `read_repository_format()`.
111 struct repository_format {
112 int version;
113 int precious_objects;
114 char *partial_clone; /* value of extensions.partialclone */
115 int worktree_config;
116 int is_bare;
117 int hash_algo;
118 unsigned int ref_storage_format;
119 int sparse_index;
120 char *work_tree;
121 struct string_list unknown_extensions;
122 struct string_list v1_only_extensions;
126 * Always use this to initialize a `struct repository_format`
127 * to a well-defined, default state before calling
128 * `read_repository()`.
130 #define REPOSITORY_FORMAT_INIT \
132 .version = -1, \
133 .is_bare = -1, \
134 .hash_algo = GIT_HASH_SHA1, \
135 .ref_storage_format = REF_STORAGE_FORMAT_FILES, \
136 .unknown_extensions = STRING_LIST_INIT_DUP, \
137 .v1_only_extensions = STRING_LIST_INIT_DUP, \
141 * Read the repository format characteristics from the config file "path" into
142 * "format" struct. Returns the numeric version. On error, or if no version is
143 * found in the configuration, -1 is returned, format->version is set to -1,
144 * and all other fields in the struct are set to the default configuration
145 * (REPOSITORY_FORMAT_INIT). Always initialize the struct using
146 * REPOSITORY_FORMAT_INIT before calling this function.
148 int read_repository_format(struct repository_format *format, const char *path);
151 * Free the memory held onto by `format`, but not the struct itself.
152 * (No need to use this after `read_repository_format()` fails.)
154 void clear_repository_format(struct repository_format *format);
157 * Verify that the repository described by repository_format is something we
158 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
159 * any errors encountered.
161 int verify_repository_format(const struct repository_format *format,
162 struct strbuf *err);
165 * Check the repository format version in the path found in get_git_dir(),
166 * and die if it is a version we don't understand. Generally one would
167 * set_git_dir() before calling this, and use it only for "are we in a valid
168 * repo?".
170 * If successful and fmt is not NULL, fill fmt with data.
172 void check_repository_format(struct repository_format *fmt);
174 #define INIT_DB_QUIET (1 << 0)
175 #define INIT_DB_EXIST_OK (1 << 1)
176 #define INIT_DB_SKIP_REFDB (1 << 2)
178 int init_db(const char *git_dir, const char *real_git_dir,
179 const char *template_dir, int hash_algo,
180 unsigned int ref_storage_format,
181 const char *initial_branch, int init_shared_repository,
182 unsigned int flags);
183 void initialize_repository_version(int hash_algo,
184 unsigned int ref_storage_format,
185 int reinit);
186 void create_reference_database(unsigned int ref_storage_format,
187 const char *initial_branch, int quiet);
190 * NOTE NOTE NOTE!!
192 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
193 * not be changed. Old repositories have core.sharedrepository written in
194 * numeric format, and therefore these values are preserved for compatibility
195 * reasons.
197 enum sharedrepo {
198 PERM_UMASK = 0,
199 OLD_PERM_GROUP = 1,
200 OLD_PERM_EVERYBODY = 2,
201 PERM_GROUP = 0660,
202 PERM_EVERYBODY = 0664
204 int git_config_perm(const char *var, const char *value);
206 struct startup_info {
207 int have_repository;
208 const char *prefix;
209 const char *original_cwd;
211 extern struct startup_info *startup_info;
212 extern const char *tmp_original_cwd;
214 #endif /* SETUP_H */