doc: show usage of branch description
[git/debian.git] / builtin / init-db.c
blob9966522b4a97a0d1ae430e581125fbfd1d5609ac
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 */
6 #include "cache.h"
7 #include "builtin.h"
8 #include "exec_cmd.h"
9 #include "parse-options.h"
11 #ifndef DEFAULT_GIT_TEMPLATE_DIR
12 #define DEFAULT_GIT_TEMPLATE_DIR "/usr/share/git-core/templates"
13 #endif
15 #ifdef NO_TRUSTABLE_FILEMODE
16 #define TEST_FILEMODE 0
17 #else
18 #define TEST_FILEMODE 1
19 #endif
21 static int init_is_bare_repository = 0;
22 static int init_shared_repository = -1;
23 static const char *init_db_template_dir;
24 static const char *git_link;
26 static void safe_create_dir(const char *dir, int share)
28 if (mkdir(dir, 0777) < 0) {
29 if (errno != EEXIST) {
30 perror(dir);
31 exit(1);
34 else if (share && adjust_shared_perm(dir))
35 die(_("Could not make %s writable by group"), dir);
38 static void copy_templates_1(char *path, int baselen,
39 char *template, int template_baselen,
40 DIR *dir)
42 struct dirent *de;
44 /* Note: if ".git/hooks" file exists in the repository being
45 * re-initialized, /etc/core-git/templates/hooks/update would
46 * cause "git init" to fail here. I think this is sane but
47 * it means that the set of templates we ship by default, along
48 * with the way the namespace under .git/ is organized, should
49 * be really carefully chosen.
51 safe_create_dir(path, 1);
52 while ((de = readdir(dir)) != NULL) {
53 struct stat st_git, st_template;
54 int namelen;
55 int exists = 0;
57 if (de->d_name[0] == '.')
58 continue;
59 namelen = strlen(de->d_name);
60 if ((PATH_MAX <= baselen + namelen) ||
61 (PATH_MAX <= template_baselen + namelen))
62 die(_("insanely long template name %s"), de->d_name);
63 memcpy(path + baselen, de->d_name, namelen+1);
64 memcpy(template + template_baselen, de->d_name, namelen+1);
65 if (lstat(path, &st_git)) {
66 if (errno != ENOENT)
67 die_errno(_("cannot stat '%s'"), path);
69 else
70 exists = 1;
72 if (lstat(template, &st_template))
73 die_errno(_("cannot stat template '%s'"), template);
75 if (S_ISDIR(st_template.st_mode)) {
76 DIR *subdir = opendir(template);
77 int baselen_sub = baselen + namelen;
78 int template_baselen_sub = template_baselen + namelen;
79 if (!subdir)
80 die_errno(_("cannot opendir '%s'"), template);
81 path[baselen_sub++] =
82 template[template_baselen_sub++] = '/';
83 path[baselen_sub] =
84 template[template_baselen_sub] = 0;
85 copy_templates_1(path, baselen_sub,
86 template, template_baselen_sub,
87 subdir);
88 closedir(subdir);
90 else if (exists)
91 continue;
92 else if (S_ISLNK(st_template.st_mode)) {
93 char lnk[256];
94 int len;
95 len = readlink(template, lnk, sizeof(lnk));
96 if (len < 0)
97 die_errno(_("cannot readlink '%s'"), template);
98 if (sizeof(lnk) <= len)
99 die(_("insanely long symlink %s"), template);
100 lnk[len] = 0;
101 if (symlink(lnk, path))
102 die_errno(_("cannot symlink '%s' '%s'"), lnk, path);
104 else if (S_ISREG(st_template.st_mode)) {
105 if (copy_file(path, template, st_template.st_mode))
106 die_errno(_("cannot copy '%s' to '%s'"), template,
107 path);
109 else
110 error(_("ignoring template %s"), template);
114 static void copy_templates(const char *template_dir)
116 char path[PATH_MAX];
117 char template_path[PATH_MAX];
118 int template_len;
119 DIR *dir;
120 const char *git_dir = get_git_dir();
121 int len = strlen(git_dir);
122 char *to_free = NULL;
124 if (!template_dir)
125 template_dir = getenv(TEMPLATE_DIR_ENVIRONMENT);
126 if (!template_dir)
127 template_dir = init_db_template_dir;
128 if (!template_dir)
129 template_dir = to_free = system_path(DEFAULT_GIT_TEMPLATE_DIR);
130 if (!template_dir[0]) {
131 free(to_free);
132 return;
134 template_len = strlen(template_dir);
135 if (PATH_MAX <= (template_len+strlen("/config")))
136 die(_("insanely long template path %s"), template_dir);
137 strcpy(template_path, template_dir);
138 if (template_path[template_len-1] != '/') {
139 template_path[template_len++] = '/';
140 template_path[template_len] = 0;
142 dir = opendir(template_path);
143 if (!dir) {
144 warning(_("templates not found %s"), template_dir);
145 goto free_return;
148 /* Make sure that template is from the correct vintage */
149 strcpy(template_path + template_len, "config");
150 repository_format_version = 0;
151 git_config_from_file(check_repository_format_version,
152 template_path, NULL);
153 template_path[template_len] = 0;
155 if (repository_format_version &&
156 repository_format_version != GIT_REPO_VERSION) {
157 warning(_("not copying templates of "
158 "a wrong format version %d from '%s'"),
159 repository_format_version,
160 template_dir);
161 goto close_free_return;
164 memcpy(path, git_dir, len);
165 if (len && path[len - 1] != '/')
166 path[len++] = '/';
167 path[len] = 0;
168 copy_templates_1(path, len,
169 template_path, template_len,
170 dir);
171 close_free_return:
172 closedir(dir);
173 free_return:
174 free(to_free);
177 static int git_init_db_config(const char *k, const char *v, void *cb)
179 if (!strcmp(k, "init.templatedir"))
180 return git_config_pathname(&init_db_template_dir, k, v);
182 return 0;
185 static int create_default_files(const char *template_path)
187 const char *git_dir = get_git_dir();
188 unsigned len = strlen(git_dir);
189 static char path[PATH_MAX];
190 struct stat st1;
191 char repo_version_string[10];
192 char junk[2];
193 int reinit;
194 int filemode;
196 if (len > sizeof(path)-50)
197 die(_("insane git directory %s"), git_dir);
198 memcpy(path, git_dir, len);
200 if (len && path[len-1] != '/')
201 path[len++] = '/';
204 * Create .git/refs/{heads,tags}
206 safe_create_dir(git_path("refs"), 1);
207 safe_create_dir(git_path("refs/heads"), 1);
208 safe_create_dir(git_path("refs/tags"), 1);
210 /* Just look for `init.templatedir` */
211 git_config(git_init_db_config, NULL);
213 /* First copy the templates -- we might have the default
214 * config file there, in which case we would want to read
215 * from it after installing.
217 copy_templates(template_path);
219 git_config(git_default_config, NULL);
220 is_bare_repository_cfg = init_is_bare_repository;
222 /* reading existing config may have overwrote it */
223 if (init_shared_repository != -1)
224 shared_repository = init_shared_repository;
227 * We would have created the above under user's umask -- under
228 * shared-repository settings, we would need to fix them up.
230 if (shared_repository) {
231 adjust_shared_perm(get_git_dir());
232 adjust_shared_perm(git_path("refs"));
233 adjust_shared_perm(git_path("refs/heads"));
234 adjust_shared_perm(git_path("refs/tags"));
238 * Create the default symlink from ".git/HEAD" to the "master"
239 * branch, if it does not exist yet.
241 strcpy(path + len, "HEAD");
242 reinit = (!access(path, R_OK)
243 || readlink(path, junk, sizeof(junk)-1) != -1);
244 if (!reinit) {
245 if (create_symref("HEAD", "refs/heads/master", NULL) < 0)
246 exit(1);
249 /* This forces creation of new config file */
250 sprintf(repo_version_string, "%d", GIT_REPO_VERSION);
251 git_config_set("core.repositoryformatversion", repo_version_string);
253 path[len] = 0;
254 strcpy(path + len, "config");
256 /* Check filemode trustability */
257 filemode = TEST_FILEMODE;
258 if (TEST_FILEMODE && !lstat(path, &st1)) {
259 struct stat st2;
260 filemode = (!chmod(path, st1.st_mode ^ S_IXUSR) &&
261 !lstat(path, &st2) &&
262 st1.st_mode != st2.st_mode &&
263 !chmod(path, st1.st_mode));
264 if (filemode && !reinit && (st1.st_mode & S_IXUSR))
265 filemode = 0;
267 git_config_set("core.filemode", filemode ? "true" : "false");
269 if (is_bare_repository())
270 git_config_set("core.bare", "true");
271 else {
272 const char *work_tree = get_git_work_tree();
273 git_config_set("core.bare", "false");
274 /* allow template config file to override the default */
275 if (log_all_ref_updates == -1)
276 git_config_set("core.logallrefupdates", "true");
277 if (!starts_with(git_dir, work_tree) ||
278 strcmp(git_dir + strlen(work_tree), "/.git")) {
279 git_config_set("core.worktree", work_tree);
283 if (!reinit) {
284 /* Check if symlink is supported in the work tree */
285 path[len] = 0;
286 strcpy(path + len, "tXXXXXX");
287 if (!close(xmkstemp(path)) &&
288 !unlink(path) &&
289 !symlink("testing", path) &&
290 !lstat(path, &st1) &&
291 S_ISLNK(st1.st_mode))
292 unlink(path); /* good */
293 else
294 git_config_set("core.symlinks", "false");
296 /* Check if the filesystem is case-insensitive */
297 path[len] = 0;
298 strcpy(path + len, "CoNfIg");
299 if (!access(path, F_OK))
300 git_config_set("core.ignorecase", "true");
301 probe_utf8_pathname_composition(path, len);
304 return reinit;
307 static void create_object_directory(void)
309 const char *object_directory = get_object_directory();
310 int len = strlen(object_directory);
311 char *path = xmalloc(len + 40);
313 memcpy(path, object_directory, len);
315 safe_create_dir(object_directory, 1);
316 strcpy(path+len, "/pack");
317 safe_create_dir(path, 1);
318 strcpy(path+len, "/info");
319 safe_create_dir(path, 1);
321 free(path);
324 int set_git_dir_init(const char *git_dir, const char *real_git_dir,
325 int exist_ok)
327 if (real_git_dir) {
328 struct stat st;
330 if (!exist_ok && !stat(git_dir, &st))
331 die(_("%s already exists"), git_dir);
333 if (!exist_ok && !stat(real_git_dir, &st))
334 die(_("%s already exists"), real_git_dir);
337 * make sure symlinks are resolved because we'll be
338 * moving the target repo later on in separate_git_dir()
340 git_link = xstrdup(real_path(git_dir));
341 set_git_dir(real_path(real_git_dir));
343 else {
344 set_git_dir(real_path(git_dir));
345 git_link = NULL;
347 return 0;
350 static void separate_git_dir(const char *git_dir)
352 struct stat st;
353 FILE *fp;
355 if (!stat(git_link, &st)) {
356 const char *src;
358 if (S_ISREG(st.st_mode))
359 src = read_gitfile(git_link);
360 else if (S_ISDIR(st.st_mode))
361 src = git_link;
362 else
363 die(_("unable to handle file type %d"), (int)st.st_mode);
365 if (rename(src, git_dir))
366 die_errno(_("unable to move %s to %s"), src, git_dir);
369 fp = fopen(git_link, "w");
370 if (!fp)
371 die(_("Could not create git link %s"), git_link);
372 fprintf(fp, "gitdir: %s\n", git_dir);
373 fclose(fp);
376 int init_db(const char *template_dir, unsigned int flags)
378 int reinit;
379 const char *git_dir = get_git_dir();
381 if (git_link)
382 separate_git_dir(git_dir);
384 safe_create_dir(git_dir, 0);
386 init_is_bare_repository = is_bare_repository();
388 /* Check to see if the repository version is right.
389 * Note that a newly created repository does not have
390 * config file, so this will not fail. What we are catching
391 * is an attempt to reinitialize new repository with an old tool.
393 check_repository_format();
395 reinit = create_default_files(template_dir);
397 create_object_directory();
399 if (shared_repository) {
400 char buf[10];
401 /* We do not spell "group" and such, so that
402 * the configuration can be read by older version
403 * of git. Note, we use octal numbers for new share modes,
404 * and compatibility values for PERM_GROUP and
405 * PERM_EVERYBODY.
407 if (shared_repository < 0)
408 /* force to the mode value */
409 sprintf(buf, "0%o", -shared_repository);
410 else if (shared_repository == PERM_GROUP)
411 sprintf(buf, "%d", OLD_PERM_GROUP);
412 else if (shared_repository == PERM_EVERYBODY)
413 sprintf(buf, "%d", OLD_PERM_EVERYBODY);
414 else
415 die("oops");
416 git_config_set("core.sharedrepository", buf);
417 git_config_set("receive.denyNonFastforwards", "true");
420 if (!(flags & INIT_DB_QUIET)) {
421 int len = strlen(git_dir);
423 /* TRANSLATORS: The first '%s' is either "Reinitialized
424 existing" or "Initialized empty", the second " shared" or
425 "", and the last '%s%s' is the verbatim directory name. */
426 printf(_("%s%s Git repository in %s%s\n"),
427 reinit ? _("Reinitialized existing") : _("Initialized empty"),
428 shared_repository ? _(" shared") : "",
429 git_dir, len && git_dir[len-1] != '/' ? "/" : "");
432 return 0;
435 static int guess_repository_type(const char *git_dir)
437 const char *slash;
438 char *cwd;
439 int cwd_is_git_dir;
442 * "GIT_DIR=. git init" is always bare.
443 * "GIT_DIR=`pwd` git init" too.
445 if (!strcmp(".", git_dir))
446 return 1;
447 cwd = xgetcwd();
448 cwd_is_git_dir = !strcmp(git_dir, cwd);
449 free(cwd);
450 if (cwd_is_git_dir)
451 return 1;
453 * "GIT_DIR=.git or GIT_DIR=something/.git is usually not.
455 if (!strcmp(git_dir, ".git"))
456 return 0;
457 slash = strrchr(git_dir, '/');
458 if (slash && !strcmp(slash, "/.git"))
459 return 0;
462 * Otherwise it is often bare. At this point
463 * we are just guessing.
465 return 1;
468 static int shared_callback(const struct option *opt, const char *arg, int unset)
470 *((int *) opt->value) = (arg) ? git_config_perm("arg", arg) : PERM_GROUP;
471 return 0;
474 static const char *const init_db_usage[] = {
475 N_("git init [-q | --quiet] [--bare] [--template=<template-directory>] [--shared[=<permissions>]] [directory]"),
476 NULL
480 * If you want to, you can share the DB area with any number of branches.
481 * That has advantages: you can save space by sharing all the SHA1 objects.
482 * On the other hand, it might just make lookup slower and messier. You
483 * be the judge. The default case is to have one DB per managed directory.
485 int cmd_init_db(int argc, const char **argv, const char *prefix)
487 const char *git_dir;
488 const char *real_git_dir = NULL;
489 const char *work_tree;
490 const char *template_dir = NULL;
491 unsigned int flags = 0;
492 const struct option init_db_options[] = {
493 OPT_STRING(0, "template", &template_dir, N_("template-directory"),
494 N_("directory from which templates will be used")),
495 OPT_SET_INT(0, "bare", &is_bare_repository_cfg,
496 N_("create a bare repository"), 1),
497 { OPTION_CALLBACK, 0, "shared", &init_shared_repository,
498 N_("permissions"),
499 N_("specify that the git repository is to be shared amongst several users"),
500 PARSE_OPT_OPTARG | PARSE_OPT_NONEG, shared_callback, 0},
501 OPT_BIT('q', "quiet", &flags, N_("be quiet"), INIT_DB_QUIET),
502 OPT_STRING(0, "separate-git-dir", &real_git_dir, N_("gitdir"),
503 N_("separate git dir from working tree")),
504 OPT_END()
507 argc = parse_options(argc, argv, prefix, init_db_options, init_db_usage, 0);
509 if (real_git_dir && !is_absolute_path(real_git_dir))
510 real_git_dir = xstrdup(real_path(real_git_dir));
512 if (argc == 1) {
513 int mkdir_tried = 0;
514 retry:
515 if (chdir(argv[0]) < 0) {
516 if (!mkdir_tried) {
517 int saved;
519 * At this point we haven't read any configuration,
520 * and we know shared_repository should always be 0;
521 * but just in case we play safe.
523 saved = shared_repository;
524 shared_repository = 0;
525 switch (safe_create_leading_directories_const(argv[0])) {
526 case SCLD_OK:
527 case SCLD_PERMS:
528 break;
529 case SCLD_EXISTS:
530 errno = EEXIST;
531 /* fallthru */
532 default:
533 die_errno(_("cannot mkdir %s"), argv[0]);
534 break;
536 shared_repository = saved;
537 if (mkdir(argv[0], 0777) < 0)
538 die_errno(_("cannot mkdir %s"), argv[0]);
539 mkdir_tried = 1;
540 goto retry;
542 die_errno(_("cannot chdir to %s"), argv[0]);
544 } else if (0 < argc) {
545 usage(init_db_usage[0]);
547 if (is_bare_repository_cfg == 1) {
548 char *cwd = xgetcwd();
549 setenv(GIT_DIR_ENVIRONMENT, cwd, argc > 0);
550 free(cwd);
553 if (init_shared_repository != -1)
554 shared_repository = init_shared_repository;
557 * GIT_WORK_TREE makes sense only in conjunction with GIT_DIR
558 * without --bare. Catch the error early.
560 git_dir = getenv(GIT_DIR_ENVIRONMENT);
561 work_tree = getenv(GIT_WORK_TREE_ENVIRONMENT);
562 if ((!git_dir || is_bare_repository_cfg == 1) && work_tree)
563 die(_("%s (or --work-tree=<directory>) not allowed without "
564 "specifying %s (or --git-dir=<directory>)"),
565 GIT_WORK_TREE_ENVIRONMENT,
566 GIT_DIR_ENVIRONMENT);
569 * Set up the default .git directory contents
571 if (!git_dir)
572 git_dir = DEFAULT_GIT_DIR_ENVIRONMENT;
574 if (is_bare_repository_cfg < 0)
575 is_bare_repository_cfg = guess_repository_type(git_dir);
577 if (!is_bare_repository_cfg) {
578 const char *git_dir_parent = strrchr(git_dir, '/');
579 if (git_dir_parent) {
580 char *rel = xstrndup(git_dir, git_dir_parent - git_dir);
581 git_work_tree_cfg = xstrdup(real_path(rel));
582 free(rel);
584 if (!git_work_tree_cfg)
585 git_work_tree_cfg = xgetcwd();
586 if (work_tree)
587 set_git_work_tree(work_tree);
588 else
589 set_git_work_tree(git_work_tree_cfg);
590 if (access(get_git_work_tree(), X_OK))
591 die_errno (_("Cannot access work tree '%s'"),
592 get_git_work_tree());
594 else {
595 if (work_tree)
596 set_git_work_tree(work_tree);
599 set_git_dir_init(git_dir, real_git_dir, 1);
601 return init_db(template_dir, flags);