git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: xiaozhu <xiaozhu@gmail.com>
To: git@vger.kernel.org
Subject: a bug about format-patch of multibyte characters comment
Date: Sat, 12 Feb 2011 19:13:15 +0900	[thread overview]
Message-ID: <4D565D3B.7060808@gmail.com> (raw)

Hi,

I found a bug when I use format-patch to export a patch which contains comment with
some multibyte characters. I also found the relation source, but I can't understand
the source clearly, so I think I need a help to know how can I fix it.

At first, the symptom.

I commit a fix to my repository with comment like following:
-----------------------------------------------------
XXXXXXXXXXXX
YYYYYY
-----------------------------------------------------

two lines of multibyte language comment.

then I use format-patch to export this fix, I get a patch file like following:

------------------------------------------------------------------------------
 From d3532c3263a02a2367a3aa5c9cc3f0bd738b79b1 Mon Sep 17 00:00:00 2001
From: xz <xz>
Date: Fri, 11 Feb 2011 21:30:35 +0900
Subject: [PATCH] =?UTF-8?q?=E6=97=A5=E6=9C=AC=E8=AA=9E=E3=81=8C=E5=A4=A7=E4=B8=88=E5=A4=AB
=20=E6=94=B9=E8=A1=8C=E3=81=99=E3=82=8B?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
  testfile.txt |    4 +++-
  1 files changed, 3 insertions(+), 1 deletions(-)

diff --git a/testfile.txt b/testfile.txt
index 1e5d832..da982fd 100644
--- a/testfile.txt
+++ b/testfile.txt
@@ -1 +1,3 @@
-sadfasdf
\ No newline at end of file
+sadfasdf

..........

-------------------------------------------------------------------------------

If I use am to apply this patch, am can't analyze the comment correctly, then the
committed comment will become
"=?UTF-8?q?=E6=97=A5=E6=9C=AC=E8=AA=9E=E3=81=8C=E5=A4=A7=E4=B8=88=E5=A4=AB".

Above is the symptom.

Then I did some try, I modify the comment to 3 lines:
-----------------------------------------------------
XXXXXXXXXXXX

YYYYYY
-----------------------------------------------------

add a empty line, then I get a patch like following:
------------------------------------------------------------------------------
 From d3532c3263a02a2367a3aa5c9cc3f0bd738b79b1 Mon Sep 17 00:00:00 2001
From: xz <xz>
Date: Fri, 11 Feb 2011 21:30:35 +0900
Subject: [PATCH] =?UTF-8?q?=E6=97=A5=E6=9C=AC=E8=AA=9E=E3=81=8C=E5=A4=A7=E4=B8=88=E5=A4=AB?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

YYYYYY
---
  testfile.txt |    4 +++-
  1 files changed, 3 insertions(+), 1 deletions(-)

diff --git a/testfile.txt b/testfile.txt
index 1e5d832..da982fd 100644
--- a/testfile.txt
+++ b/testfile.txt
@@ -1 +1,3 @@
-sadfasdf
\ No newline at end of file
+sadfasdf

..........

-------------------------------------------------------------------------------

this patch will be applied successfully. So I know the problem is about the subject creating.
I search the source, then I found the following function at "pretty.c:655":

const char *format_subject(struct strbuf *sb, const char *msg,
			   const char *line_separator)
{
	int first = 1;

	for (;;) {
		const char *line = msg;
		int linelen = get_one_line(line);

		msg += linelen;
		
		if (!linelen || is_empty_line(line, &linelen))
			break;

		if (!sb)cat
			continue;
		strbuf_grow(sb, linelen + 2);
		if (!first)
			strbuf_addstr(sb, line_separator);
		strbuf_add(sb, line, linelen);
		first = 0;
	}
	return msg;
}

At first I want to know: Does this function means that always add the first line
of comment to the argument sb, then return the rest? Is there any other thing that I
didn't considered?

I found 4 place where to call this function, I think there is no problem about 3
of them, but I don't know is there any other problem to the rest one which is
at "pretty.c:931".

At last, if what I think is correct, I plan to fix it as following:

const char *format_subject(struct strbuf *sb, const char *msg,
			   const char *line_separator)
{
	int first = 1;

	//for (;;) {
		const char *line = msg;
		int linelen = get_one_line(line);

		msg += linelen;
		
		if (!linelen || is_empty_line(line, &linelen)) return msg;
			//break;

		if (!sb) return msg;
			//continue;
		strbuf_grow(sb, linelen + 2);
		if (!first)
			strbuf_addstr(sb, line_separator);
		strbuf_add(sb, line, linelen);
		first = 0;
	//}
	return msg;
}

I dont't think it is necessary to have a loop here, so I want to remove
the loop. Is there anybody can confirm my fix for me?

             reply	other threads:[~2011-02-12 10:13 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-02-12 10:13 xiaozhu [this message]
2011-02-12 12:30 ` a bug about format-patch of multibyte characters comment "Martin Krüger"
2011-02-13  7:53 ` Jeff King
2011-02-13  8:31   ` Jeff King
2011-02-13  8:45     ` xiaozhu
2011-02-13  8:52       ` Jeff King
2011-02-13 10:14         ` xiaozhu
2011-02-13 10:22           ` xzer
2011-02-13 10:26             ` Jeff King
2011-02-13 10:50               ` xiaozhu
2011-02-13 10:23           ` Jeff King
2011-02-13  9:48   ` Johannes Sixt
2011-02-13 10:03     ` Jeff King

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4D565D3B.7060808@gmail.com \
    --to=xiaozhu@gmail.com \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).