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

[PATCH v4 3/6] wt-status: make the require_clean_work_tree() function reusable

From
Johannes Schindelin <johannes.schindelin@gmx.de>
Date
Oct 7, 2016, 16:08 UTC
Message-ID
<fc1ff20fe6a6b5bc43adc1c72a29960e1e303528.1475856491.git.johannes.schindelin@gmx.de>
In-Reply-To
<cover.1475856491.git.johannes.schindelin@gmx.de>

The function used by "git pull" to stop the user when the working tree has changes is useful in other places.

Let's move it into a more prominent (and into an actually reusable) spot: wt-status.[ch].

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
---
 builtin/pull.c | 77 +---------------------------------------------------------
 wt-status.c    | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 wt-status.h    |  3 +++
 3 files changed, 80 insertions(+), 76 deletions(-)
diff --git a/builtin/pull.c b/builtin/pull.c
index 58fc176..01b6465 100644
--- a/builtin/pull.c
+++ b/builtin/pull.c
@@ -17,6 +17,7 @@
 #include "revision.h"
 #include "tempfile.h"
 #include "lockfile.h"
+#include "wt-status.h"
 
 enum rebase_type {
 	REBASE_INVALID = -1,
@@ -326,82 +327,6 @@ static int git_pull_config(const char *var, const char *value, void *cb)
 }
 
 /**
- * Returns 1 if there are unstaged changes, 0 otherwise.
- */
-static int has_unstaged_changes(void)
-{
-	struct rev_info rev_info;
-	int result;
-
-	init_revisions(&rev_info, NULL);
-	DIFF_OPT_SET(&rev_info.diffopt, IGNORE_SUBMODULES);
-	DIFF_OPT_SET(&rev_info.diffopt, QUICK);
-	diff_setup_done(&rev_info.diffopt);
-	result = run_diff_files(&rev_info, 0);
-	return diff_result_code(&rev_info.diffopt, result);
-}
-
-/**
- * Returns 1 if there are uncommitted changes, 0 otherwise.
- */
-static int has_uncommitted_changes(void)
-{
-	struct rev_info rev_info;
-	int result;
-
-	if (is_cache_unborn())
-		return 0;
-
-	init_revisions(&rev_info, NULL);
-	DIFF_OPT_SET(&rev_info.diffopt, IGNORE_SUBMODULES);
-	DIFF_OPT_SET(&rev_info.diffopt, QUICK);
-	add_head_to_pending(&rev_info);
-	diff_setup_done(&rev_info.diffopt);
-	result = run_diff_index(&rev_info, 1);
-	return diff_result_code(&rev_info.diffopt, result);
-}
-
-/**
- * If the work tree has unstaged or uncommitted changes, dies with the
- * appropriate message.
- */
-static int require_clean_work_tree(const char *action, const char *hint,
-		int gently)
-{
-	struct lock_file *lock_file = xcalloc(1, sizeof(*lock_file));
-	int err = 0;
-
-	hold_locked_index(lock_file, 0);
-	refresh_cache(REFRESH_QUIET);
-	update_index_if_able(&the_index, lock_file);
-	rollback_lock_file(lock_file);
-
-	if (has_unstaged_changes()) {
-		/* TRANSLATORS: the action is e.g. "pull with rebase" */
-		error(_("Cannot %s: You have unstaged changes."), _(action));
-		err = 1;
-	}
-
-	if (has_uncommitted_changes()) {
-		if (err)
-			error(_("Additionally, your index contains uncommitted changes."));
-		else
-			error(_("Cannot %s: Your index contains uncommitted changes."),
-			      _(action));
-		err = 1;
-	}
-
-	if (err) {
-		if (hint)
-			error("%s", hint);
-		if (!gently)
-			exit(128);
-	}
-
-	return err;
-}
-
-/**
  * Appends merge candidates from FETCH_HEAD that are not marked not-for-merge
  * into merge_heads.
  */
diff --git a/wt-status.c b/wt-status.c
index 99d1b0a..89475f1 100644
--- a/wt-status.c
+++ b/wt-status.c
@@ -16,6 +16,7 @@
 #include "strbuf.h"
 #include "utf8.h"
 #include "worktree.h"
+#include "lockfile.h"
 
 static const char cut_line[] =
 "------------------------ >8 ------------------------\n";
@@ -2208,3 +2209,78 @@ void wt_status_print(struct wt_status *s)
 		break;
 	}
 }
+
+/**
+ * Returns 1 if there are unstaged changes, 0 otherwise.
+ */
+static int has_unstaged_changes(void)
+{
+	struct rev_info rev_info;
+	int result;
+
+	init_revisions(&rev_info, NULL);
+	DIFF_OPT_SET(&rev_info.diffopt, IGNORE_SUBMODULES);
+	DIFF_OPT_SET(&rev_info.diffopt, QUICK);
+	diff_setup_done(&rev_info.diffopt);
+	result = run_diff_files(&rev_info, 0);
+	return diff_result_code(&rev_info.diffopt, result);
+}
+
+/**
+ * Returns 1 if there are uncommitted changes, 0 otherwise.
+ */
+static int has_uncommitted_changes(void)
+{
+	struct rev_info rev_info;
+	int result;
+
+	if (is_cache_unborn())
+		return 0;
+
+	init_revisions(&rev_info, NULL);
+	DIFF_OPT_SET(&rev_info.diffopt, IGNORE_SUBMODULES);
+	DIFF_OPT_SET(&rev_info.diffopt, QUICK);
+	add_head_to_pending(&rev_info);
+	diff_setup_done(&rev_info.diffopt);
+	result = run_diff_index(&rev_info, 1);
+	return diff_result_code(&rev_info.diffopt, result);
+}
+
+/**
+ * If the work tree has unstaged or uncommitted changes, dies with the
+ * appropriate message.
+ */
+int require_clean_work_tree(const char *action, const char *hint, int gently)
+{
+	struct lock_file *lock_file = xcalloc(1, sizeof(*lock_file));
+	int err = 0;
+
+	hold_locked_index(lock_file, 0);
+	refresh_cache(REFRESH_QUIET);
+	update_index_if_able(&the_index, lock_file);
+	rollback_lock_file(lock_file);
+
+	if (has_unstaged_changes()) {
+		/* TRANSLATORS: the action is e.g. "pull with rebase" */
+		error(_("Cannot %s: You have unstaged changes."), _(action));
+		err = 1;
+	}
+
+	if (has_uncommitted_changes()) {
+		if (err)
+			error(_("Additionally, your index contains uncommitted changes."));
+		else
+			error(_("Cannot %s: Your index contains uncommitted changes."),
+			      _(action));
+		err = 1;
+	}
+
+	if (err) {
+		if (hint)
+			error("%s", hint);
+		if (!gently)
+			exit(128);
+	}
+
+	return err;
+}
diff --git a/wt-status.h b/wt-status.h
index e401837..68b4709 100644
--- a/wt-status.h
+++ b/wt-status.h
@@ -128,4 +128,7 @@ void status_printf_ln(struct wt_status *s, const char *color, const char *fmt, .
 __attribute__((format (printf, 3, 4)))
 void status_printf(struct wt_status *s, const char *color, const char *fmt, ...);
 
+/* The following function expects that the caller took care of reading the index. */
+int require_clean_work_tree(const char *action, const char *hint, int gently);
+
 #endif /* STATUS_H */
-- 
2.10.0.windows.1.325.ge6089c1
Previous: Johannes SchindelinNext: Johannes Schindelin
Message 47 of 52 in “Pull out require_clean_work_tree() functionality from builtin/pull.c”
  1. 0/6 Pull out require_clean_work_tree() functionality from builtin/pull.cJohannes Schindelin, Aug 25, 2016
  2. 1/6 pull: drop confusing prefix parameter of die_on_unclean_work_tree()Johannes Schindelin, Aug 25, 2016
  3. Junio C HamanoAug 29, 2016
  4. 3/6 Make the require_clean_work_tree() function truly reusableJohannes Schindelin, Aug 25, 2016
  5. 2/6 pull: make code more similar to the shell script againJohannes Schindelin, Aug 25, 2016
  6. Junio C HamanoAug 29, 2016
  7. Johannes SchindelinAug 30, 2016
  8. Johannes SchindelinSep 9, 2016
  9. 4/6 require_clean_work_tree: ensure that the index was readJohannes Schindelin, Aug 25, 2016
  10. Junio C HamanoAug 29, 2016
  11. Junio C HamanoAug 30, 2016
  12. Johannes SchindelinAug 30, 2016
  13. Johannes SchindelinAug 30, 2016
  14. Junio C HamanoAug 30, 2016
  15. Johannes SchindelinAug 30, 2016
  16. 5/6 Export also the has_un{staged,committed}_changed() functionsJohannes Schindelin, Aug 25, 2016
  17. Junio C HamanoAug 29, 2016
  18. 6/6 wt-status: teach has_{unstaged,uncommitted}_changes() about submodulesJohannes Schindelin, Aug 25, 2016
  19. 0/5 Pull out require_clean_work_tree() functionality from builtin/pull.cJohannes Schindelin, Sep 11, 2016
  20. 1/5 pull: drop confusing prefix parameter of die_on_unclean_work_tree()Johannes Schindelin, Sep 11, 2016
  21. 2/5 pull: make code more similar to the shell script againJohannes Schindelin, Sep 11, 2016
  22. Junio C HamanoSep 12, 2016
  23. 3/5 Make the require_clean_work_tree() function truly reusableJohannes Schindelin, Sep 11, 2016
  24. Junio C HamanoSep 12, 2016
  25. 4/5 Export also the has_un{staged,committed}_changed() functionsJohannes Schindelin, Sep 11, 2016
  26. 5/5 wt-status: teach has_{unstaged,uncommitted}_changes() about submodulesJohannes Schindelin, Sep 11, 2016
  27. Junio C HamanoSep 12, 2016
  28. 0/6 Pull out require_clean_work_tree() functionality from builtin/pull.cJohannes Schindelin, Oct 4, 2016
  29. 1/6 pull: drop confusing prefix parameter of die_on_unclean_work_tree()Johannes Schindelin, Oct 4, 2016
  30. 2/6 pull: make code more similar to the shell script againJohannes Schindelin, Oct 4, 2016
  31. 3/6 Make the require_clean_work_tree() function reusableJohannes Schindelin, Oct 4, 2016
  32. Junio C HamanoOct 4, 2016
  33. Johannes SchindelinOct 5, 2016
  34. Junio C HamanoOct 5, 2016
  35. 4/6 Export also the has_un{staged,committed}_changed() functionsJohannes Schindelin, Oct 4, 2016
  36. Junio C HamanoOct 4, 2016
  37. Jakub NarębskiOct 5, 2016
  38. 5/6 wt-status: teach has_{unstaged,uncommitted}_changes() about submodulesJohannes Schindelin, Oct 4, 2016
  39. 6/6 wt-status: begin error messages with lower-caseJohannes Schindelin, Oct 4, 2016
  40. Jakub NarębskiOct 5, 2016
  41. Johannes SchindelinOct 6, 2016
  42. Junio C HamanoOct 4, 2016
  43. Johannes SchindelinOct 5, 2016
  44. 0/6 Pull out require_clean_work_tree() functionality from builtin/pull.cJohannes Schindelin, Oct 7, 2016
  45. 1/6 pull: drop confusing prefix parameter of die_on_unclean_work_tree()Johannes Schindelin, Oct 7, 2016
  46. 2/6 pull: make code more similar to the shell script againJohannes Schindelin, Oct 7, 2016
  47. 3/6 wt-status: make the require_clean_work_tree() function reusableJohannes Schindelin, Oct 7, 2016
  48. 4/6 wt-status: export also the has_un{staged,committed}_changes() functionsJohannes Schindelin, Oct 7, 2016
  49. 5/6 wt-status: teach has_{unstaged,uncommitted}_changes() about submodulesJohannes Schindelin, Oct 7, 2016
  50. 6/6 wt-status: begin error messages with lower-caseJohannes Schindelin, Oct 7, 2016
  51. Junio C HamanoOct 7, 2016
  52. Jakub NarębskiOct 7, 2016

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.