Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
setup: make startup_info available everywhere
Commit a60645f (setup: remember whether repository was
found, 2010-08-05) introduced the startup_info structure,
which records some parts of the setup_git_directory()
process (notably, whether we actually found a repository or
not).

One of the uses of this data is for functions to behave
appropriately based on whether we are in a repo. But the
startup_info struct is just a pointer to storage provided by
the main program, and the only program that sets it up is
the git.c wrapper. Thus builtins have access to
startup_info, but externally linked programs do not.

Worse, library code which is accessible from both has to be
careful about accessing startup_info. This can be used to
trigger a die("BUG") via get_sha1():

	$ git fast-import <<-\EOF
	tag foo
	from HEAD:./whatever
	EOF

	fatal: BUG: startup_info struct is not initialized.

Obviously that's fairly nonsensical input to feed to
fast-import, but we should never hit a die("BUG"). And there
may be other ways to trigger it if other non-builtins
resolve sha1s.

So let's point the storage for startup_info to a static
variable in setup.c, making it available to all users of the
library code. We _could_ turn startup_info into a regular
extern struct, but doing so would mean tweaking all of the
existing use sites. So let's leave the pointer indirection
in place.  We can, however, drop any checks for NULL, as
they will always be false (and likewise, we can drop the
test covering this case, which was a rather artificial
situation using one of the test-* programs).

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Jeff King authored and Junio C Hamano committed Mar 7, 2016
1 parent ab5d01a commit 46c3cd4
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 17 deletions.
2 changes: 1 addition & 1 deletion cache.h
Expand Up @@ -1771,7 +1771,7 @@ int split_cmdline(char *cmdline, const char ***argv);
/* Takes a negative value returned by split_cmdline */
const char *split_cmdline_strerror(int cmdline_errno);

/* git.c */
/* setup.c */
struct startup_info {
int have_repository;
const char *prefix;
Expand Down
1 change: 0 additions & 1 deletion environment.c
Expand Up @@ -64,7 +64,6 @@ int grafts_replace_parents = 1;
int core_apply_sparse_checkout;
int merge_log_config = -1;
int precomposed_unicode = -1; /* see probe_utf8_pathname_composition() */
struct startup_info *startup_info;
unsigned long pack_size_limit_cfg;

#ifndef PROTECT_HFS_DEFAULT
Expand Down
3 changes: 0 additions & 3 deletions git.c
Expand Up @@ -15,7 +15,6 @@ const char git_more_info_string[] =
"concept guides. See 'git help <command>' or 'git help <concept>'\n"
"to read about a specific subcommand or concept.");

static struct startup_info git_startup_info;
static int use_pager = -1;
static char *orig_cwd;
static const char *env_names[] = {
Expand Down Expand Up @@ -637,8 +636,6 @@ int main(int argc, char **av)
const char *cmd;
int done_help = 0;

startup_info = &git_startup_info;

cmd = git_extract_argv0_path(argv[0]);
if (!cmd)
cmd = "git-help";
Expand Down
10 changes: 6 additions & 4 deletions setup.c
Expand Up @@ -7,6 +7,9 @@ static int inside_work_tree = -1;
static int work_tree_config_is_bogus;
static struct string_list unknown_extensions = STRING_LIST_INIT_DUP;

static struct startup_info the_startup_info;
struct startup_info *startup_info = &the_startup_info;

/*
* The input parameter must contain an absolute path, and it must already be
* normalized.
Expand Down Expand Up @@ -905,10 +908,9 @@ const char *setup_git_directory_gently(int *nongit_ok)
else
setenv(GIT_PREFIX_ENVIRONMENT, "", 1);

if (startup_info) {
startup_info->have_repository = !nongit_ok || !*nongit_ok;
startup_info->prefix = prefix;
}
startup_info->have_repository = !nongit_ok || !*nongit_ok;
startup_info->prefix = prefix;

return prefix;
}

Expand Down
3 changes: 0 additions & 3 deletions sha1_name.c
Expand Up @@ -1353,9 +1353,6 @@ static char *resolve_relative_path(const char *rel)
if (!starts_with(rel, "./") && !starts_with(rel, "../"))
return NULL;

if (!startup_info)
die("BUG: startup_info struct is not initialized.");

if (!is_inside_work_tree())
die("relative path syntax can't be used outside working tree.");

Expand Down
5 changes: 0 additions & 5 deletions t/t1506-rev-parse-diagnosis.sh
Expand Up @@ -166,11 +166,6 @@ test_expect_success 'relative path when cwd is outside worktree' '
grep "relative path syntax can.t be used outside working tree." error
'

test_expect_success 'relative path when startup_info is NULL' '
test_must_fail test-match-trees HEAD:./file.txt HEAD:./file.txt 2>error &&
grep "BUG: startup_info struct is not initialized." error
'

test_expect_success '<commit>:file correctly diagnosed after a pathname' '
test_must_fail git rev-parse file.txt HEAD:file.txt 1>actual 2>error &&
test_i18ngrep ! "exists on disk" error &&
Expand Down

0 comments on commit 46c3cd4

Please sign in to comment.