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

[PATCH 37/43] builtins: check for startup_info->help, print and exit early

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

These commands need more than just git_config() before parsing commmand line arguments. Some of these activities will unconditionally look into a repository. When startup_info->help is TRUE, no repository is set up and the caller expects callees to print help usage and exit, no more.

Do as expected.
Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 builtin/branch.c         |    3 +++
 builtin/checkout-index.c |    3 +++
 builtin/commit.c         |    6 ++++++
 builtin/gc.c             |    3 +++
 builtin/ls-files.c       |    3 +++
 builtin/merge.c          |    3 +++
 builtin/update-index.c   |    3 +++
 builtin/upload-archive.c |    7 ++++---
 8 files changed, 28 insertions(+), 3 deletions(-)
diff --git a/builtin/branch.c b/builtin/branch.c
index 6cf7e72..cc0053b 100644
--- a/builtin/branch.c
+++ b/builtin/branch.c
@@ -651,6 +651,9 @@ int cmd_branch(int argc, const char **argv, const char *prefix)
 		OPT_END(),
 	};
 
+	if (startup_info->help)
+		usage_with_options(builtin_branch_usage, options);
+
 	git_config(git_branch_config, NULL);
 
 	if (branch_use_color == -1)
diff --git a/builtin/checkout-index.c b/builtin/checkout-index.c
index a7a5ee1..7f25cd7 100644
--- a/builtin/checkout-index.c
+++ b/builtin/checkout-index.c
@@ -241,6 +241,9 @@ int cmd_checkout_index(int argc, const char **argv, const char *prefix)
 		OPT_END()
 	};
 
+	if (startup_info->help)
+		usage_with_options(builtin_checkout_index_usage, builtin_checkout_index_options);
+
 	git_config(git_default_config, NULL);
 	state.base_dir = "";
 	prefix_length = prefix ? strlen(prefix) : 0;
diff --git a/builtin/commit.c b/builtin/commit.c
index c5ab683..bccbbef 100644
--- a/builtin/commit.c
+++ b/builtin/commit.c
@@ -1034,6 +1034,9 @@ int cmd_status(int argc, const char **argv, const char *prefix)
 		OPT_END(),
 	};
 
+	if (startup_info->help)
+		usage_with_options(builtin_status_usage, builtin_status_options);
+
 	if (null_termination && status_format == STATUS_FORMAT_LONG)
 		status_format = STATUS_FORMAT_PORCELAIN;
 
@@ -1208,6 +1211,9 @@ int cmd_commit(int argc, const char **argv, const char *prefix)
 	int allow_fast_forward = 1;
 	struct wt_status s;
 
+	if (startup_info->help)
+		usage_with_options(builtin_commit_usage, builtin_commit_options);
+
 	wt_status_prepare(&s);
 	git_config(git_commit_config, &s);
 	in_merge = file_exists(git_path("MERGE_HEAD"));
diff --git a/builtin/gc.c b/builtin/gc.c
index c304638..f040171 100644
--- a/builtin/gc.c
+++ b/builtin/gc.c
@@ -191,6 +191,9 @@ int cmd_gc(int argc, const char **argv, const char *prefix)
 
 	git_config(gc_config, NULL);
 
+	if (startup_info->help)
+		usage_with_options(builtin_gc_usage, builtin_gc_options);
+
 	if (pack_refs < 0)
 		pack_refs = !is_bare_repository();
 
diff --git a/builtin/ls-files.c b/builtin/ls-files.c
index b065061..5125560 100644
--- a/builtin/ls-files.c
+++ b/builtin/ls-files.c
@@ -518,6 +518,9 @@ int cmd_ls_files(int argc, const char **argv, const char *prefix)
 		OPT_END()
 	};
 
+	if (startup_info->help)
+		usage_with_options(ls_files_usage, builtin_ls_files_options);
+
 	memset(&dir, 0, sizeof(dir));
 	if (prefix)
 		prefix_offset = strlen(prefix);
diff --git a/builtin/merge.c b/builtin/merge.c
index c043066..3cced9e 100644
--- a/builtin/merge.c
+++ b/builtin/merge.c
@@ -886,6 +886,9 @@ int cmd_merge(int argc, const char **argv, const char *prefix)
 	const char *best_strategy = NULL, *wt_strategy = NULL;
 	struct commit_list **remotes = &remoteheads;
 
+	if (startup_info->help)
+		usage_with_options(builtin_merge_usage, builtin_merge_options);
+
 	if (read_cache_unmerged()) {
 		die_resolve_conflict("merge");
 	}
diff --git a/builtin/update-index.c b/builtin/update-index.c
index 3ab214d..46a53f5 100644
--- a/builtin/update-index.c
+++ b/builtin/update-index.c
@@ -589,6 +589,9 @@ int cmd_update_index(int argc, const char **argv, const char *prefix)
 	int lock_error = 0;
 	struct lock_file *lock_file;
 
+	if (startup_info->help)
+		usage(update_index_usage);
+
 	git_config(git_default_config, NULL);
 
 	/* We can't free this memory, it becomes part of a linked list parsed atexit() */
diff --git a/builtin/upload-archive.c b/builtin/upload-archive.c
index 73f788e..d4f4741 100644
--- a/builtin/upload-archive.c
+++ b/builtin/upload-archive.c
@@ -26,9 +26,6 @@ static int run_upload_archive(int argc, const char **argv, const char *prefix)
 	int sent_argc;
 	int len;
 
-	if (argc != 2)
-		usage(upload_archive_usage);
-
 	if (strlen(argv[1]) + 1 > sizeof(buf))
 		die("insanely long repository name");
 
@@ -98,6 +95,10 @@ int cmd_upload_archive(int argc, const char **argv, const char *prefix)
 {
 	pid_t writer;
 	int fd1[2], fd2[2];
+
+	if (startup_info->help || argc != 2)
+		usage(upload_archive_usage);
+
 	/*
 	 * Set up sideband subprocess.
 	 *
-- 
1.7.0.rc1.541.g2da82.dirty
Previous: Nguyễn Thái Ngọc DuyNext: Nguyễn Thái Ngọc Duy
Message 38 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.