Skip to contentSkip to conversation

cleanup for 'dl/range-diff-with-notes'

PATCH New Denton Liu 1 participant 4 messages Dec 6, 2019

lore
Share & tools
lore

Denton Liu

author
#0 lore raw

cover cleanup for 'dl/range-diff-with-notes'

This series performs some small polishing touches for the 'dl/range-diff-with-notes' topic. Notably, we fix an incorrect test case name but we also perform some nit-picky cleanup for the range-diff code.

Denton Liu (3):
t3206: fix incorrect test name
range-diff: mark pointers as const
range-diff: clear other_arg at end of function

 builtin/range-diff.c  | 1 +
 range-diff.c          | 6 +++---
 range-diff.h          | 4 ++--
 t/t3206-range-diff.sh | 2 +-
 4 files changed, 7 insertions(+), 6 deletions(-)
Signature · 1 line
2.24.0.612.g9b7bad38f5
author
#1 lore raw

PATCH 1/3 t3206: fix incorrect test name

The name of the test used to indicate that it was testing the --notes option but it was really testing the format.notes configuration. Correct the test name to reflect this.

---
 t/t3206-range-diff.sh | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
t/t3206-range-diff.sh +1 -1
index ec2b456dbb..0575dd72b1 100755
@@ -638,7 +638,7 @@ test_expect_success 'format-patch --range-diff with --notes' '
 	test_cmp expect actual
 '
 
-test_expect_success 'format-patch --range-diff with --notes' '
+test_expect_success 'format-patch --range-diff with format.notes config' '
 	git notes add -m "topic note" topic &&
 	git notes add -m "unmodified note" unmodified &&
 	test_when_finished git notes remove topic unmodified &&
Signature · 1 line
2.24.0.612.g9b7bad38f5
author
#2 lore raw

PATCH 2/3 range-diff: mark pointers as const

In reply to Denton Liu

The contents pointed to by diffopt and other_arg should not be modified. Mark these as const to indicate this.

---
 range-diff.c | 6 +++---
 range-diff.h | 4 ++--
 2 files changed, 5 insertions(+), 5 deletions(-)
range-diff.c +3 -3
index f56b4012a2..f745567cf6 100644
@@ -41,7 +41,7 @@ static size_t find_end_of_line(char *buffer, unsigned long size)
  * as struct object_id (will need to be free()d).
  */
 static int read_patches(const char *range, struct string_list *list,
-			struct argv_array *other_arg)
+			const struct argv_array *other_arg)
 {
 	struct child_process cp = CHILD_PROCESS_INIT;
 	struct strbuf buf = STRBUF_INIT, contents = STRBUF_INIT;
@@ -506,8 +506,8 @@ static struct strbuf *output_prefix_cb(struct diff_options *opt, void *data)
 
 int show_range_diff(const char *range1, const char *range2,
 		    int creation_factor, int dual_color,
-		    struct diff_options *diffopt,
-		    struct argv_array *other_arg)
+		    const struct diff_options *diffopt,
+		    const struct argv_array *other_arg)
 {
 	int res = 0;
 
range-diff.h +2 -2
index 7d918ab9ed..381d52f4d3 100644
@@ -13,7 +13,7 @@
  */
 int show_range_diff(const char *range1, const char *range2,
 		    int creation_factor, int dual_color,
-		    struct diff_options *diffopt,
-		    struct argv_array *other_arg);
+		    const struct diff_options *diffopt,
+		    const struct argv_array *other_arg);
 
 #endif
Signature · 1 line
2.24.0.612.g9b7bad38f5
author
#3 lore raw

PATCH 3/3 range-diff: clear `other_arg` at end of function

In reply to Denton Liu

We were leaking memory by not clearing other_arg after we were done using it. Clear it after we've finished using it.

Note that this isn't strictly necessary since the memory will be reclaimed once the command exits. However, since we are releasing the strbufs, we should also clear other_arg for consistency.

---
 builtin/range-diff.c | 1 +
 1 file changed, 1 insertion(+)
builtin/range-diff.c +1 -0
index 98acf3533e..d8a4670629 100644
@@ -84,6 +84,7 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix)
 	res = show_range_diff(range1.buf, range2.buf, creation_factor,
 			      simple_color < 1, &diffopt, &other_arg);
 
+	argv_array_clear(&other_arg);
 	strbuf_release(&range1);
 	strbuf_release(&range2);
 
Signature · 1 line
2.24.0.612.g9b7bad38f5