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)
45 * Check if a repository is safe and die if it is not, by verifying the
46 * ownership of the worktree (if any), the git directory, and the gitfile (if
49 * Exemptions for known-safe repositories can be added via `safe.directory`
50 * config settings; for non-bare repositories, their worktree needs to be
51 * added, for bare ones their git directory.
53 void die_upon_dubious_ownership(const char *gitfile
, const char *worktree
,
56 void setup_work_tree(void);
59 * discover_git_directory_reason() is similar to discover_git_directory(),
60 * except it returns an enum value instead. It is important to note that
61 * a zero-valued return here is actually GIT_DIR_NONE, which is different
62 * from discover_git_directory.
64 enum discovery_result
{
66 GIT_DIR_DISCOVERED
= 2,
68 /* these are errors */
69 GIT_DIR_HIT_CEILING
= -1,
70 GIT_DIR_HIT_MOUNT_POINT
= -2,
71 GIT_DIR_INVALID_GITFILE
= -3,
72 GIT_DIR_INVALID_OWNERSHIP
= -4,
73 GIT_DIR_DISALLOWED_BARE
= -5,
74 GIT_DIR_INVALID_FORMAT
= -6,
75 GIT_DIR_CWD_FAILURE
= -7,
77 enum discovery_result
discover_git_directory_reason(struct strbuf
*commondir
,
78 struct strbuf
*gitdir
);
81 * Find the commondir and gitdir of the repository that contains the current
82 * working directory, without changing the working directory or other global
83 * state. The result is appended to commondir and gitdir. If the discovered
84 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will
85 * both have the same result appended to the buffer. The return value is
86 * either 0 upon success and -1 if no repository was found.
88 static inline int discover_git_directory(struct strbuf
*commondir
,
89 struct strbuf
*gitdir
)
91 if (discover_git_directory_reason(commondir
, gitdir
) <= 0)
96 const char *setup_git_directory_gently(int *);
97 const char *setup_git_directory(void);
98 char *prefix_path(const char *prefix
, int len
, const char *path
);
99 char *prefix_path_gently(const char *prefix
, int len
, int *remaining
, const char *path
);
101 int check_filename(const char *prefix
, const char *name
);
102 void verify_filename(const char *prefix
,
104 int diagnose_misspelt_rev
);
105 void verify_non_filename(const char *prefix
, const char *name
);
106 int path_inside_repo(const char *prefix
, const char *path
);
108 void sanitize_stdfds(void);
112 * GIT_REPO_VERSION is the version we write by default. The
113 * _READ variant is the highest number we know how to
116 #define GIT_REPO_VERSION 0
117 #define GIT_REPO_VERSION_READ 1
120 * You _have_ to initialize a `struct repository_format` using
121 * `= REPOSITORY_FORMAT_INIT` before calling `read_repository_format()`.
123 struct repository_format
{
125 int precious_objects
;
126 char *partial_clone
; /* value of extensions.partialclone */
132 struct string_list unknown_extensions
;
133 struct string_list v1_only_extensions
;
137 * Always use this to initialize a `struct repository_format`
138 * to a well-defined, default state before calling
139 * `read_repository()`.
141 #define REPOSITORY_FORMAT_INIT \
145 .hash_algo = GIT_HASH_SHA1, \
146 .unknown_extensions = STRING_LIST_INIT_DUP, \
147 .v1_only_extensions = STRING_LIST_INIT_DUP, \
151 * Read the repository format characteristics from the config file "path" into
152 * "format" struct. Returns the numeric version. On error, or if no version is
153 * found in the configuration, -1 is returned, format->version is set to -1,
154 * and all other fields in the struct are set to the default configuration
155 * (REPOSITORY_FORMAT_INIT). Always initialize the struct using
156 * REPOSITORY_FORMAT_INIT before calling this function.
158 int read_repository_format(struct repository_format
*format
, const char *path
);
161 * Free the memory held onto by `format`, but not the struct itself.
162 * (No need to use this after `read_repository_format()` fails.)
164 void clear_repository_format(struct repository_format
*format
);
167 * Verify that the repository described by repository_format is something we
168 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
169 * any errors encountered.
171 int verify_repository_format(const struct repository_format
*format
,
175 * Check the repository format version in the path found in get_git_dir(),
176 * and die if it is a version we don't understand. Generally one would
177 * set_git_dir() before calling this, and use it only for "are we in a valid
180 * If successful and fmt is not NULL, fill fmt with data.
182 void check_repository_format(struct repository_format
*fmt
);
184 const char *get_template_dir(const char *option_template
);
186 #define INIT_DB_QUIET 0x0001
187 #define INIT_DB_EXIST_OK 0x0002
189 int init_db(const char *git_dir
, const char *real_git_dir
,
190 const char *template_dir
, int hash_algo
,
191 const char *initial_branch
, int init_shared_repository
,
193 void initialize_repository_version(int hash_algo
, int reinit
);
198 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
199 * not be changed. Old repositories have core.sharedrepository written in
200 * numeric format, and therefore these values are preserved for compatibility
206 OLD_PERM_EVERYBODY
= 2,
208 PERM_EVERYBODY
= 0664
210 int git_config_perm(const char *var
, const char *value
);
212 struct startup_info
{
215 const char *original_cwd
;
217 extern struct startup_info
*startup_info
;
218 extern const char *tmp_original_cwd
;