git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 28/43] worktree setup: restore original state when things go wrong

From
Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Date
Apr 5, 2010, 18:41 UTC
Message-ID
<1270492888-26589-29-git-send-email-pclouds@gmail.com>
In-Reply-To
<1270492888-26589-1-git-send-email-pclouds@gmail.com>

In current state of setup_git_directory_gently(), when a repository is not found, many things will not be the same as when setup procedure is started (while they should be). For one thing, current working directory will not be the same in certain cases.

This patch reorders actions in clear steps and rolls back if one step is wrong. (Actually the last step, setting git_dir, can't be rolled back by this patch).

The steps and their state change are:
 1. Looking in working directory for repository candidates (or $GIT_DIR
    if it is set)
    This step may move $(cwd) to somewhere.
 2. Set internal variables to record repository features, based only
    on repository location and environment variables.
    This step sets variables:
    - inside_git_dir
    - inside_work_tree
 3. Inspect $GIT_DIR/config to see if it's a valid repository.
    This step may change variables:
    - repository_format_version
    - shared_repository
    - is_bare_repository_cfg
    - git_work_tree_cfg
 4. Save the repository location for later use.
    This step calls setup_git_dir() to set many variables in environment.c
 5. Calculate prefix (relative path to the original current working
    directory)

Setup procedure is completed at step 5. Stopping at any other steps is considered a setup failure.

In case of setup failure, if it's not fatal and nongit_ok is not NULL, prefix must be calculated before returning to caller. In other words:

  if (!fatal && gently)
    goto step_5;

Things that go wrong before step 4 will be cleaned up by unset_git_directory(). Step 4 is irreversible, for now.

Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
---
 cache.h |    1 +
 setup.c |   55 +++++++++++++++++++++++++++++++++++++++++++++++++++----
 2 files changed, 52 insertions(+), 4 deletions(-)
diff --git a/cache.h b/cache.h
index f4935b8..f53fb32 100644
--- a/cache.h
+++ b/cache.h
@@ -421,6 +421,7 @@ extern const char **get_pathspec(const char *prefix, const char **pathspec);
 extern void setup_work_tree(void);
 extern const char *setup_git_directory_gently(int *);
 extern const char *setup_git_directory(void);
+extern void unset_git_directory(const char *prefix);
 extern const char *prefix_path(const char *prefix, int len, const char *path);
 extern const char *prefix_filename(const char *prefix, int len, const char *path);
 extern int check_filename(const char *prefix, const char *name);
diff --git a/setup.c b/setup.c
index 2c1b64f..858cf6b 100644
--- a/setup.c
+++ b/setup.c
@@ -323,6 +323,42 @@ const char *read_gitfile_gently(const char *path)
 	return path;
 }
 
+void unset_git_directory(const char *prefix)
+{
+	/*
+	 * FIXME:
+	 * chdir(prefix) may be enough for most of cases,
+	 * if original cwd is outside worktree, prefix
+	 * will always be set NULL, thus impossible to move
+	 * back to orignal cwd
+	 */
+	if (prefix && chdir(prefix))
+		die("Cannot change to '%s'", prefix);
+
+	if (startup_info) {
+		startup_info->prefix = NULL;
+		startup_info->have_repository = 0;
+	}
+
+	/* Initialized in setup_git_directory_gently_1() */
+	inside_work_tree = -1;
+	inside_git_dir = -1;
+
+	/* Initialized in check_repository_format_version() */
+	/*
+	 * repository_format_version is zero for two reasons:
+	 * - For really old repos, there won't be core.repositoryformatversion
+	 *   we treat it as supported version zero.
+	 * - For repo creating commands like "git init" or "git clone"
+	 *   $GIT_DIR/config may not be there, just let it pass, the
+	 *   repository will be properly initialized later.
+	 * For history of this setting see commits 4f62953 and 96f1e58
+	 */
+	repository_format_version = 0;
+	shared_repository = PERM_UMASK;
+	is_bare_repository_cfg = -1;
+	git_work_tree_cfg = NULL;
+}
 /*
  * We cannot decide in this function whether we are in the work tree or
  * not, since the config can only be read _after_ this function was called.
@@ -403,6 +439,13 @@ static const char *setup_git_directory_gently_1(int *nongit_ok)
 	 * - ../ (bare)
 	 * - ../../.git/
 	 *   etc.
+	 *
+	 * When a repository is found:
+	 * - inside_git_dir/inside_work_tree are set
+	 * - check_repository_format_gently() is called
+	 *   if repo version is not supported, restore cwd
+	 * - set_git_dir
+	 * - calculate and return prefix
 	 */
 	offset = len = strlen(cwd);
 	for (;;) {
@@ -410,13 +453,15 @@ static const char *setup_git_directory_gently_1(int *nongit_ok)
 		if (!gitfile_dir && is_git_directory(DEFAULT_GIT_DIR_ENVIRONMENT))
 			gitfile_dir = DEFAULT_GIT_DIR_ENVIRONMENT;
 		if (gitfile_dir) {
-			if (set_git_dir(gitfile_dir))
-				die("Repository setup failed");
 			inside_git_dir = 0;
 			if (!work_tree_env)
 				inside_work_tree = 1;
-			if (check_repository_format_gently(gitfile_dir, nongit_ok))
+			if (check_repository_format_gently(gitfile_dir, nongit_ok)) {
+				unset_git_directory(offset != len ? cwd + offset + 1: NULL);
 				return NULL;
+			}
+			if (set_git_dir(gitfile_dir))
+				die("Repository setup failed");
 			root_len = offset_1st_component(cwd);
 			git_work_tree_cfg = xstrndup(cwd, offset > root_len ? offset : root_len);
 			break;
@@ -425,8 +470,10 @@ static const char *setup_git_directory_gently_1(int *nongit_ok)
 			inside_git_dir = 1;
 			if (!work_tree_env)
 				inside_work_tree = 0;
-			if (check_repository_format_gently(".", nongit_ok))
+			if (check_repository_format_gently(".", nongit_ok)) {
+				unset_git_directory(offset != len ? cwd + offset + 1: NULL);
 				return NULL;
+			}
 			if (offset != len) {
 				root_len = offset_1st_component(cwd);
 				cwd[offset > root_len ? offset : root_len] = '\0';
-- 
1.7.0.rc1.541.g2da82.dirty
Previous: Nguyễn Thái Ngọc DuyNext: Nguyễn Thái Ngọc Duy
Message 29 of 50 in “nd/setup update”
  1. 00/43 nd/setup updateNguyễn Thái Ngọc Duy, Apr 5, 2010
  2. 01/43 builtin: introduce startup_info structNguyễn Thái Ngọc Duy, Apr 5, 2010
  3. 02/43 builtin: Support RUN_SETUP_GENTLY to set up repository early if foundNguyễn Thái Ngọc Duy, Apr 5, 2010
  4. 03/43 config: use RUN_SETUP_GENTLYNguyễn Thái Ngọc Duy, Apr 5, 2010
  5. 04/43 hash-object: use RUN_SETUP_GENTLYNguyễn Thái Ngọc Duy, Apr 5, 2010
  6. 05/43 shortlog: use RUN_SETUP_GENTLYNguyễn Thái Ngọc Duy, Apr 5, 2010
  7. 06/43 grep: use RUN_SETUP_GENTLYNguyễn Thái Ngọc Duy, Apr 5, 2010
  8. 07/43 builtin: USE_PAGER should not be used without RUN_SETUP*Nguyễn Thái Ngọc Duy, Apr 5, 2010
  9. 08/43 archive: use RUN_SETUP_GENTLYNguyễn Thái Ngọc Duy, Apr 5, 2010
  10. 09/43 mailinfo: use RUN_SETUP_GENTLYNguyễn Thái Ngọc Duy, Apr 5, 2010
  11. 10/43 check-ref-format: use RUN_SETUP_GENTLYNguyễn Thái Ngọc Duy, Apr 5, 2010
  12. 11/43 verify-pack: use RUN_SETUP_GENTLYNguyễn Thái Ngọc Duy, Apr 5, 2010
  13. 12/43 apply: use RUN_SETUP_GENTLYNguyễn Thái Ngọc Duy, Apr 5, 2010
  14. 13/43 bundle: use RUN_SETUP_GENTLYNguyễn Thái Ngọc Duy, Apr 5, 2010
  15. 14/43 diff: use RUN_SETUP_GENTLYNguyễn Thái Ngọc Duy, Apr 5, 2010
  16. 15/43 help: take note why this command is not applicable for RUN_SETUP_GENTLYNguyễn Thái Ngọc Duy, Apr 5, 2010
  17. 16/43 ls-remote: use RUN_SETUP_GENTLYNguyễn Thái Ngọc Duy, Apr 5, 2010
  18. 17/43 var: use RUN_SETUP_GENTLYNguyễn Thái Ngọc Duy, Apr 5, 2010
  19. 18/43 merge-file: use RUN_SETUP_GENTLYNguyễn Thái Ngọc Duy, Apr 5, 2010
  20. 19/43 worktree setup: calculate prefix even if no worktree is foundNguyễn Thái Ngọc Duy, Apr 5, 2010
  21. 20/43 index-pack: trust the prefix returned by setup_git_directory_gently()Nguyễn Thái Ngọc Duy, Apr 5, 2010
  22. 21/43 index-pack: use RUN_SETUP_GENTLYNguyễn Thái Ngọc Duy, Apr 5, 2010
  23. 22/43 Move enter_repo() to setup.cNguyễn Thái Ngọc Duy, Apr 5, 2010
  24. 23/43 enter_repo(): initialize other variables as setup_git_directory_gently() doesNguyễn Thái Ngọc Duy, Apr 5, 2010
  25. 24/43 rev-parse --git-dir: print relative gitdir correctlyNguyễn Thái Ngọc Duy, Apr 5, 2010
  26. 25/43 worktree setup: call set_git_dir explicitlyNguyễn Thái Ngọc Duy, Apr 5, 2010
  27. 26/43 Add git_config_early()Nguyễn Thái Ngọc Duy, Apr 5, 2010
  28. 27/43 Use git_config_early() instead of git_config() during repo setupNguyễn Thái Ngọc Duy, Apr 5, 2010
  29. 28/43 worktree setup: restore original state when things go wrongNguyễn Thái Ngọc Duy, Apr 5, 2010
  30. 29/43 init/clone: turn on startup->have_repository properlyNguyễn Thái Ngọc Duy, Apr 5, 2010
  31. 30/43 git_config(): do not read .git/config if there is no repositoryNguyễn Thái Ngọc Duy, Apr 5, 2010
  32. 31/43 Do not read .git/info/exclude if there is no repositoryNguyễn Thái Ngọc Duy, Apr 5, 2010
  33. 32/43 Do not read .git/info/attributes if there is no repositoryNguyễn Thái Ngọc Duy, Apr 5, 2010
  34. 33/43 apply: do not check sha1 if there is no repositoryNguyễn Thái Ngọc Duy, Apr 5, 2010
  35. 34/43 config: do not read .git/config if there is no repositoryNguyễn Thái Ngọc Duy, Apr 5, 2010
  36. 35/43 run_builtin(): save "-h" detection result for later useNguyễn Thái Ngọc Duy, Apr 5, 2010
  37. 36/43 builtins: utilize startup_info->help where possibleNguyễn Thái Ngọc Duy, Apr 5, 2010
  38. 37/43 builtins: check for startup_info->help, print and exit earlyNguyễn Thái Ngọc Duy, Apr 5, 2010
  39. 38/43 Allow to undo setup_git_directory_gently() gracefully (and fix alias code)Nguyễn Thái Ngọc Duy, Apr 5, 2010
  40. 39/43 alias: keep repository found while collecting aliases as long as possibleNguyễn Thái Ngọc Duy, Apr 5, 2010
  41. 40/43 Guard unallowed access to repository when it's not set upNguyễn Thái Ngọc Duy, Apr 5, 2010
  42. 41/43 t0001: Add test cases for "git init" with aliasesNguyễn Thái Ngọc Duy, Apr 5, 2010
  43. 42/43 builtins: setup repository before print unknown command errorNguyễn Thái Ngọc Duy, Apr 5, 2010
  44. 43/43 builtins: do not commit pager choice earlyNguyễn Thái Ngọc Duy, Apr 5, 2010
  45. 0/2 fix weird git --paginate behaviorJonathan Nieder, Apr 6, 2010
  46. 1/2 t7006: test core.pager configuration in subdir of toplevelJonathan Nieder, Apr 6, 2010
  47. 2/2 builtins: do not commit pager choice earlyJonathan Nieder, Apr 6, 2010
  48. Jonathan NiederApr 6, 2010
  49. Nguyen Thai Ngoc DuyApr 6, 2010
  50. Junio C HamanoApr 6, 2010

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.