Re: [PATCH] Use "" instead of "<unknown>" for placeholders

Subsystems: the rest

7 messages, 3 authors, 2016-06-15 · open the first message on its own page

Re: [PATCH] Use "" instead of "<unknown>" for placeholders

From: Junio C Hamano <hidden>
Date: 2016-06-15 22:43:36

Michal Vitecek [off-list ref] writes:

[jc: Added Dscho back on CC: list]

quoted

I made it because I want to use my own pretty format which currently 
only allows '%s' for subject and '%b' for body. But '%b' is 
substituted with <undefined> if the body is "missing" which I 
obviously don't like :)

Then you should fix %b not to show "<undefined>".

 I'll do it if it is okay. Shall I do the same for the other
 placeholders as well?

Yeah.  Don't know why I did it that way.

 Here comes the big patch :)

Now, this breaks t6006 which needs this patch.

Looking at this patch, I am not sure if your change is really a
desirable one --- shouldn't it be removing the line itself, not
just <unknown> token?

---
 t/t6006-rev-list-format.sh |   16 ++++++++--------
 1 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/t/t6006-rev-list-format.sh b/t/t6006-rev-list-format.sh
index ad6d0b8..2be323c 100755
--- a/t/t6006-rev-list-format.sh
+++ b/t/t6006-rev-list-format.sh

@@ -79,9 +79,9 @@ EOF
 
 test_format encoding %e <<'EOF'
 commit 131a310eb913d107dd3c09a65d1651175898735d
-<unknown>
+
 commit 86c75cfd708a0e5868dc876ed5b8bb66c80b4873
-<unknown>
+
 EOF
 
 test_format subject %s <<'EOF'

@@ -93,9 +93,9 @@ EOF
 
 test_format body %b <<'EOF'
 commit 131a310eb913d107dd3c09a65d1651175898735d
-<unknown>
+
 commit 86c75cfd708a0e5868dc876ed5b8bb66c80b4873
-<unknown>
+
 EOF
 
 test_format colors %Credfoo%Cgreenbar%Cbluebaz%Cresetxyzzy <<'EOF'

@@ -121,9 +121,9 @@ test_format complex-encoding %e <<'EOF'
 commit f58db70b055c5718631e5c61528b28b12090cdea
 iso8859-1
 commit 131a310eb913d107dd3c09a65d1651175898735d
-<unknown>
+
 commit 86c75cfd708a0e5868dc876ed5b8bb66c80b4873
-<unknown>
+
 EOF
 
 test_format complex-subject %s <<'EOF'

@@ -142,9 +142,9 @@ and it will be encoded in iso8859-1. We should therefore
 include an iso8859 character: 臓bueno!
 
 commit 131a310eb913d107dd3c09a65d1651175898735d
-<unknown>
+
 commit 86c75cfd708a0e5868dc876ed5b8bb66c80b4873
-<unknown>
+
 EOF
 
 test_done

Re: [PATCH] Use "" instead of "<unknown>" for placeholders

From: Johannes Schindelin <hidden>
Date: 2016-06-15 22:43:36

Hi,

On Fri, 21 Sep 2007, Junio C Hamano wrote:

Michal Vitecek [off-list ref] writes:

[jc: Added Dscho back on CC: list]

Thanks.  I missed that one.  My comment would have been exactly the same.

Ciao,
Dscho

Re: [PATCH] Use "" instead of "<unknown>" for placeholders

From: Michal Vitecek <hidden>
Date: 2016-06-15 22:43:36

Junio C Hamano wrote:

quoted

I made it because I want to use my own pretty format which currently 
only allows '%s' for subject and '%b' for body. But '%b' is 
substituted with <undefined> if the body is "missing" which I 
obviously don't like :)

Then you should fix %b not to show "<undefined>".

 I'll do it if it is okay. Shall I do the same for the other
 placeholders as well?

Yeah.  Don't know why I did it that way.

 Here comes the big patch :)

Now, this breaks t6006 which needs this patch.

Oops - I'm sorry about that. I ran the test suite (1.5.3.1) but it 
failed in 2 tests before the patch and in 2 tests after it so I 
considered it okay.

Looking at this patch, I am not sure if your change is really a
desirable one --- shouldn't it be removing the line itself, not
just <unknown> token?

This sounds as the best solution. I'll look into it. Thanks for your time.

-- 
		fuf					(fuf@mageo.cz)

Re: [PATCH] Use "" instead of "<unknown>" for placeholders

From: Michal Vitecek <hidden>
Date: 2016-06-15 22:43:36

 Hello again,

Michal Vitecek wrote:

Junio C Hamano wrote:

quoted

I made it because I want to use my own pretty format which currently 
only allows '%s' for subject and '%b' for body. But '%b' is 
substituted with <undefined> if the body is "missing" which I 
obviously don't like :)

Then you should fix %b not to show "<undefined>".

 I'll do it if it is okay. Shall I do the same for the other
 placeholders as well?

Yeah.  Don't know why I did it that way.

 Here comes the big patch :)

Now, this breaks t6006 which needs this patch.

Oops - I'm sorry about that. I ran the test suite (1.5.3.1) but it failed 
in 2 tests before the patch and in 2 tests after it so I considered it 
okay.

quoted

Looking at this patch, I am not sure if your change is really a
desirable one --- shouldn't it be removing the line itself, not
just <unknown> token?

This sounds as the best solution. I'll look into it. Thanks for your time.

 Here comes the patch. I hope it will be ok this time :) Thanks.

 Don't use "<unknown>" for unknown values of placeholders and suppress
 printing of empty user formats.

---
 builtin-rev-list.c         |    3 ++-
 commit.c                   |    3 ---
 interpolate.c              |    6 +++++-
 log-tree.c                 |   10 ++++++----
 t/t6006-rev-list-format.sh |    8 --------
 t/t7500-commit.sh          |    4 ++--
 6 files changed, 15 insertions(+), 19 deletions(-)

diff --git a/builtin-rev-list.c b/builtin-rev-list.c
index 3894633..1de981d 100644
--- a/builtin-rev-list.c
+++ b/builtin-rev-list.c

@@ -85,7 +85,8 @@ static void show_commit(struct commit *commit)
 		pretty_print_commit(revs.commit_format, commit, ~0,
 				    &buf, &buflen,
 				    revs.abbrev, NULL, NULL, revs.date_mode);
-		printf("%s%c", buf, hdr_termination);
+                if (strlen(buf))
+                    printf("%s%c", buf, hdr_termination);
 		free(buf);
 	}
 	maybe_flush_or_die(stdout, "stdout");

diff --git a/commit.c b/commit.c
index 99f65ce..c9a1818 100644
--- a/commit.c
+++ b/commit.c

@@ -917,9 +917,6 @@ long format_commit_message(const struct commit *commit, const void *format,
 	}
 	if (msg[i])
 		table[IBODY].value = xstrdup(msg + i);
-	for (i = 0; i < ARRAY_SIZE(table); i++)
-		if (!table[i].value)
-			interp_set_entry(table, i, "<unknown>");
 
 	do {
 		char *buf = *buf_p;

diff --git a/interpolate.c b/interpolate.c
index 0082677..58fd055 100644
--- a/interpolate.c
+++ b/interpolate.c

@@ -76,8 +76,12 @@ unsigned long interpolate(char *result, unsigned long reslen,
 			/* Check for valid interpolation. */
 			if (i < ninterps) {
 				value = interps[i].value;
-				valuelen = strlen(value);
+                                if (value == NULL) {
+                                    src += namelen;
+                                    continue;
+                                }
 
+				valuelen = strlen(value);
 				if (newlen + valuelen + 1 < reslen) {
 					/* Substitute. */
 					strncpy(dest, value, valuelen);

diff --git a/log-tree.c b/log-tree.c
index a642371..5653332 100644
--- a/log-tree.c
+++ b/log-tree.c

@@ -175,14 +175,15 @@ void show_log(struct rev_info *opt, const char *sep)
 	 *  - The pretty-printed commit lacks a newline at the end
 	 *    of the buffer, but we do want to make sure that we
 	 *    have a newline there. If the separator isn't already
-	 *    a newline, add an extra one.
+         *    a newline, add an extra one and do the same for the
+         *    user format as well.
 	 *  - unlike other log messages, the one-line format does
 	 *    not have an empty line between entries.
 	 */
 	extra = "";
-	if (*sep != '\n' && opt->commit_format == CMIT_FMT_ONELINE)
+	if (*sep != '\n' && (opt->commit_format == CMIT_FMT_ONELINE || opt->commit_format == CMIT_FMT_USERFORMAT))
 		extra = "\n";
-	if (opt->shown_one && opt->commit_format != CMIT_FMT_ONELINE)
+	if (opt->shown_one && opt->commit_format != CMIT_FMT_ONELINE && opt->commit_format != CMIT_FMT_USERFORMAT)
 		putchar(opt->diffopt.line_termination);
 	opt->shown_one = 1;

@@ -298,7 +299,8 @@ void show_log(struct rev_info *opt, const char *sep)
 	if (opt->show_log_size)
 		printf("log size %i\n", len);
 
-	printf("%s%s%s", msgbuf, extra, sep);
+        if (strlen(msgbuf))
+            printf("%s%s%s", msgbuf, extra, sep);
 	free(msgbuf);
 }

diff --git a/t/t6006-rev-list-format.sh b/t/t6006-rev-list-format.sh
index ad6d0b8..1e4541a 100755
--- a/t/t6006-rev-list-format.sh
+++ b/t/t6006-rev-list-format.sh

@@ -79,9 +79,7 @@ EOF
 
 test_format encoding %e <<'EOF'
 commit 131a310eb913d107dd3c09a65d1651175898735d
-<unknown>
 commit 86c75cfd708a0e5868dc876ed5b8bb66c80b4873
-<unknown>
 EOF
 
 test_format subject %s <<'EOF'

@@ -93,9 +91,7 @@ EOF
 
 test_format body %b <<'EOF'
 commit 131a310eb913d107dd3c09a65d1651175898735d
-<unknown>
 commit 86c75cfd708a0e5868dc876ed5b8bb66c80b4873
-<unknown>
 EOF
 
 test_format colors %Credfoo%Cgreenbar%Cbluebaz%Cresetxyzzy <<'EOF'

@@ -121,9 +117,7 @@ test_format complex-encoding %e <<'EOF'
 commit f58db70b055c5718631e5c61528b28b12090cdea
 iso8859-1
 commit 131a310eb913d107dd3c09a65d1651175898735d
-<unknown>
 commit 86c75cfd708a0e5868dc876ed5b8bb66c80b4873
-<unknown>
 EOF
 
 test_format complex-subject %s <<'EOF'

@@ -142,9 +136,7 @@ and it will be encoded in iso8859-1. We should therefore
 include an iso8859 character: ÂĄbueno!
 
 commit 131a310eb913d107dd3c09a65d1651175898735d
-<unknown>
 commit 86c75cfd708a0e5868dc876ed5b8bb66c80b4873
-<unknown>
 EOF
 
 test_done

diff --git a/t/t7500-commit.sh b/t/t7500-commit.sh
index f11ada8..abbf54b 100755
--- a/t/t7500-commit.sh
+++ b/t/t7500-commit.sh

@@ -81,7 +81,7 @@ test_expect_success 'explicit commit message should override template' '
 	git add foo &&
 	GIT_EDITOR=../t7500/add-content git commit --template "$TEMPLATE" \
 		-m "command line msg" &&
-	commit_msg_is "command line msg<unknown>"
+	commit_msg_is "command line msg"
 '
 
 test_expect_success 'commit message from file should override template' '

@@ -90,7 +90,7 @@ test_expect_success 'commit message from file should override template' '
 	echo "standard input msg" |
 		GIT_EDITOR=../t7500/add-content git commit \
 			--template "$TEMPLATE" --file - &&
-	commit_msg_is "standard input msg<unknown>"
+	commit_msg_is "standard input msg"
 '
 
 test_done

-- 
1.5.3.1


-- 
		fuf		(fuf@mageo.cz)

Re: [PATCH] Use "" instead of "<unknown>" for placeholders

From: Johannes Schindelin <hidden>
Date: 2016-06-15 22:43:36

Hi,

On Tue, 25 Sep 2007, Michal Vitecek wrote:

 Hello again,

Michal Vitecek wrote:

quoted

Junio C Hamano wrote:

quoted

I made it because I want to use my own pretty format which currently 
only allows '%s' for subject and '%b' for body. But '%b' is 
substituted with <undefined> if the body is "missing" which I 
obviously don't like :)

Then you should fix %b not to show "<undefined>".

 I'll do it if it is okay. Shall I do the same for the other
 placeholders as well?

Yeah.  Don't know why I did it that way.

 Here comes the big patch :)

Now, this breaks t6006 which needs this patch.

Oops - I'm sorry about that. I ran the test suite (1.5.3.1) but it failed 
in 2 tests before the patch and in 2 tests after it so I considered it 
okay.

quoted

Looking at this patch, I am not sure if your change is really a
desirable one --- shouldn't it be removing the line itself, not
just <unknown> token?

This sounds as the best solution. I'll look into it. Thanks for your time.

 Here comes the patch. I hope it will be ok this time :) Thanks.

 Don't use "<unknown>" for unknown values of placeholders and suppress
 printing of empty user formats.

---

Please move the discussion which should not be in the commit message 
_after_ the "---".

quoted hunk

diff --git a/builtin-rev-list.c b/builtin-rev-list.c
index 3894633..1de981d 100644
--- a/builtin-rev-list.c
+++ b/builtin-rev-list.c

@@ -85,7 +85,8 @@ static void show_commit(struct commit *commit)
 		pretty_print_commit(revs.commit_format, commit, ~0,
 				    &buf, &buflen,
 				    revs.abbrev, NULL, NULL, revs.date_mode);
-		printf("%s%c", buf, hdr_termination);
+                if (strlen(buf))
+                    printf("%s%c", buf, hdr_termination);

We use tabs for indentation, not spaces.

Also, instead of the expensive "strlen(buf)", you rather want to check "if 
(*buf)".

quoted hunk

diff --git a/log-tree.c b/log-tree.c
index a642371..5653332 100644
--- a/log-tree.c
+++ b/log-tree.c

@@ -298,7 +299,8 @@ void show_log(struct rev_info *opt, const char *sep)
 	if (opt->show_log_size)
 		printf("log size %i\n", len);
 
-	printf("%s%s%s", msgbuf, extra, sep);
+        if (strlen(msgbuf))
+            printf("%s%s%s", msgbuf, extra, sep);

Again, "if (*msgbuf)" is way more efficient.

Ciao,
Dscho

Re: [PATCH] Use "" instead of "<unknown>" for placeholders

From: Michal Vitecek <hidden>
Date: 2016-06-15 22:43:36

 Hi,

Johannes Schindelin wrote:

quoted

I made it because I want to use my own pretty format which currently 
only allows '%s' for subject and '%b' for body. But '%b' is 
substituted with <undefined> if the body is "missing" which I 
obviously don't like :)

Then you should fix %b not to show "<undefined>".

 I'll do it if it is okay. Shall I do the same for the other
 placeholders as well?

Yeah.  Don't know why I did it that way.

 Here comes the big patch :)

Now, this breaks t6006 which needs this patch.

Oops - I'm sorry about that. I ran the test suite (1.5.3.1) but it failed 
in 2 tests before the patch and in 2 tests after it so I considered it 
okay.

quoted

Looking at this patch, I am not sure if your change is really a
desirable one --- shouldn't it be removing the line itself, not
just <unknown> token?

This sounds as the best solution. I'll look into it. Thanks for your time.

 Here comes the patch. I hope it will be ok this time :) Thanks.

 Don't use "<unknown>" for unknown values of placeholders and suppress
 printing of empty user formats.

---

We use tabs for indentation, not spaces.

Also, instead of the expensive "strlen(buf)", you rather want to check "if 
(*buf)".

---

 Thanks for the notes - here comes the patch with the above fixes.


 builtin-rev-list.c         |    3 ++-
 commit.c                   |    3 ---
 interpolate.c              |    6 +++++-
 log-tree.c                 |   10 ++++++----
 t/t6006-rev-list-format.sh |    8 --------
 t/t7500-commit.sh          |    4 ++--
 6 files changed, 15 insertions(+), 19 deletions(-)

diff --git a/builtin-rev-list.c b/builtin-rev-list.c
index 3894633..0b74eb3 100644
--- a/builtin-rev-list.c
+++ b/builtin-rev-list.c

@@ -85,7 +85,8 @@ static void show_commit(struct commit *commit)
 		pretty_print_commit(revs.commit_format, commit, ~0,
 				    &buf, &buflen,
 				    revs.abbrev, NULL, NULL, revs.date_mode);
-		printf("%s%c", buf, hdr_termination);
+		if (*buf)
+			printf("%s%c", buf, hdr_termination);
 		free(buf);
 	}
 	maybe_flush_or_die(stdout, "stdout");

diff --git a/commit.c b/commit.c
index 99f65ce..c9a1818 100644
--- a/commit.c
+++ b/commit.c

@@ -917,9 +917,6 @@ long format_commit_message(const struct commit *commit, const void *format,
 	}
 	if (msg[i])
 		table[IBODY].value = xstrdup(msg + i);
-	for (i = 0; i < ARRAY_SIZE(table); i++)
-		if (!table[i].value)
-			interp_set_entry(table, i, "<unknown>");
 
 	do {
 		char *buf = *buf_p;

diff --git a/interpolate.c b/interpolate.c
index 0082677..2f727cd 100644
--- a/interpolate.c
+++ b/interpolate.c

@@ -76,8 +76,12 @@ unsigned long interpolate(char *result, unsigned long reslen,
 			/* Check for valid interpolation. */
 			if (i < ninterps) {
 				value = interps[i].value;
-				valuelen = strlen(value);
+				if (!value) {
+					src += namelen;
+					continue;
+				}
 
+				valuelen = strlen(value);
 				if (newlen + valuelen + 1 < reslen) {
 					/* Substitute. */
 					strncpy(dest, value, valuelen);

diff --git a/log-tree.c b/log-tree.c
index a642371..79502f4 100644
--- a/log-tree.c
+++ b/log-tree.c

@@ -175,14 +175,15 @@ void show_log(struct rev_info *opt, const char *sep)
 	 *  - The pretty-printed commit lacks a newline at the end
 	 *    of the buffer, but we do want to make sure that we
 	 *    have a newline there. If the separator isn't already
-	 *    a newline, add an extra one.
+         *    a newline, add an extra one and do the same for the
+         *    user format as well.
 	 *  - unlike other log messages, the one-line format does
 	 *    not have an empty line between entries.
 	 */
 	extra = "";
-	if (*sep != '\n' && opt->commit_format == CMIT_FMT_ONELINE)
+	if (*sep != '\n' && (opt->commit_format == CMIT_FMT_ONELINE || opt->commit_format == CMIT_FMT_USERFORMAT))
 		extra = "\n";
-	if (opt->shown_one && opt->commit_format != CMIT_FMT_ONELINE)
+	if (opt->shown_one && opt->commit_format != CMIT_FMT_ONELINE && opt->commit_format != CMIT_FMT_USERFORMAT)
 		putchar(opt->diffopt.line_termination);
 	opt->shown_one = 1;

@@ -298,7 +299,8 @@ void show_log(struct rev_info *opt, const char *sep)
 	if (opt->show_log_size)
 		printf("log size %i\n", len);
 
-	printf("%s%s%s", msgbuf, extra, sep);
+	if (*msgbuf)
+		printf("%s%s%s", msgbuf, extra, sep);
 	free(msgbuf);
 }

diff --git a/t/t6006-rev-list-format.sh b/t/t6006-rev-list-format.sh
index ad6d0b8..1e4541a 100755
--- a/t/t6006-rev-list-format.sh
+++ b/t/t6006-rev-list-format.sh

@@ -79,9 +79,7 @@ EOF
 
 test_format encoding %e <<'EOF'
 commit 131a310eb913d107dd3c09a65d1651175898735d
-<unknown>
 commit 86c75cfd708a0e5868dc876ed5b8bb66c80b4873
-<unknown>
 EOF
 
 test_format subject %s <<'EOF'

@@ -93,9 +91,7 @@ EOF
 
 test_format body %b <<'EOF'
 commit 131a310eb913d107dd3c09a65d1651175898735d
-<unknown>
 commit 86c75cfd708a0e5868dc876ed5b8bb66c80b4873
-<unknown>
 EOF
 
 test_format colors %Credfoo%Cgreenbar%Cbluebaz%Cresetxyzzy <<'EOF'

@@ -121,9 +117,7 @@ test_format complex-encoding %e <<'EOF'
 commit f58db70b055c5718631e5c61528b28b12090cdea
 iso8859-1
 commit 131a310eb913d107dd3c09a65d1651175898735d
-<unknown>
 commit 86c75cfd708a0e5868dc876ed5b8bb66c80b4873
-<unknown>
 EOF
 
 test_format complex-subject %s <<'EOF'

@@ -142,9 +136,7 @@ and it will be encoded in iso8859-1. We should therefore
 include an iso8859 character: ÂĄbueno!
 
 commit 131a310eb913d107dd3c09a65d1651175898735d
-<unknown>
 commit 86c75cfd708a0e5868dc876ed5b8bb66c80b4873
-<unknown>
 EOF
 
 test_done

diff --git a/t/t7500-commit.sh b/t/t7500-commit.sh
index f11ada8..abbf54b 100755
--- a/t/t7500-commit.sh
+++ b/t/t7500-commit.sh

@@ -81,7 +81,7 @@ test_expect_success 'explicit commit message should override template' '
 	git add foo &&
 	GIT_EDITOR=../t7500/add-content git commit --template "$TEMPLATE" \
 		-m "command line msg" &&
-	commit_msg_is "command line msg<unknown>"
+	commit_msg_is "command line msg"
 '
 
 test_expect_success 'commit message from file should override template' '

@@ -90,7 +90,7 @@ test_expect_success 'commit message from file should override template' '
 	echo "standard input msg" |
 		GIT_EDITOR=../t7500/add-content git commit \
 			--template "$TEMPLATE" --file - &&
-	commit_msg_is "standard input msg<unknown>"
+	commit_msg_is "standard input msg"
 '
 
 test_done

-- 
1.5.3.2


-- 
		fuf		(fuf@mageo.cz)

Re: [PATCH] Use "" instead of "<unknown>" for placeholders

From: Johannes Schindelin <hidden>
Date: 2016-06-15 22:43:36

Hi,

On Tue, 25 Sep 2007, Johannes Schindelin wrote:

On Tue, 25 Sep 2007, Michal Vitecek wrote:

quoted

[lots of quoted mails]

 Here comes the patch. I hope it will be ok this time :) Thanks.

 Don't use "<unknown>" for unknown values of placeholders and suppress
 printing of empty user formats.

---

Please move the discussion which should not be in the commit message 
_after_ the "---".

What about this comment?

Ciao,
Dscho

`h`	back out one level
`j`	next message in thread
`k`	previous message in thread
`l`	drill in
`Esc`	close help / fold thread tree
`?`	toggle this help