[PATCH 3/3] Do not create commits whose message contains NUL
From: Nguyễn Thái Ngọc Duy <hidden>
Date: 2016-06-15 22:52:38
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
We assume that the commit log messages are uninterpreted sequences of non-NUL bytes (see Documentation/i18n.txt). However the assumption does not really stand out and it's quite easy to set an editor to save in a NUL-included encoding. Currently we silently cut at the first NUL we see. Make it more obvious that NUL is not welcome by refusing to create such commits. Those who deliberately want to create them can still do with hash-object. Signed-off-by: Nguyễn Thái Ngọc Duy <redacted> --- Documentation/config.txt | 4 ++++ advice.c | 2 ++ advice.h | 1 + commit.c | 9 +++++++++ t/t3900-i18n-commit.sh | 6 ++++++ t/t3900/UTF-16.txt | Bin 0 -> 32 bytes 6 files changed, 22 insertions(+), 0 deletions(-) create mode 100644 t/t3900/UTF-16.txt
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 5a841da..daf57c2 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt@@ -144,6 +144,10 @@ advice.*:: Advice shown when you used linkgit::git-checkout[1] to move to the detach HEAD state, to instruct how to create a local branch after the fact. Default: true. + commitWideEncoding:: + Advice shown when linkgit::git-commit[1] refuses to + proceed because there are NULs in commit message. + Default: true. -- core.fileMode::
diff --git a/advice.c b/advice.c
index e02e632..130949e 100644
--- a/advice.c
+++ b/advice.c@@ -6,6 +6,7 @@ int advice_commit_before_merge = 1; int advice_resolve_conflict = 1; int advice_implicit_identity = 1; int advice_detached_head = 1; +int advice_commmit_wide_encoding = 1; static struct { const char *name;
@@ -17,6 +18,7 @@ static struct { { "resolveconflict", &advice_resolve_conflict }, { "implicitidentity", &advice_implicit_identity }, { "detachedhead", &advice_detached_head }, + { "commitwideencoding", &advice_commmit_wide_encoding }, }; void advise(const char *advice, ...)
diff --git a/advice.h b/advice.h
index e5d0af7..d913bdb 100644
--- a/advice.h
+++ b/advice.h@@ -9,6 +9,7 @@ extern int advice_commit_before_merge; extern int advice_resolve_conflict; extern int advice_implicit_identity; extern int advice_detached_head; +extern int advice_commmit_wide_encoding; int git_default_advice_config(const char *var, const char *value); void advise(const char *advice, ...);
diff --git a/commit.c b/commit.c
index d67b8c7..59e5bce 100644
--- a/commit.c
+++ b/commit.c@@ -855,6 +855,15 @@ int commit_tree(const char *msg, size_t msg_len, unsigned char *tree, assert_sha1_type(tree, OBJ_TREE); + if (memchr(msg, '\0', msg_len)) { + error(_("your commit message contains NUL characters.")); + if (advice_commmit_wide_encoding) { + advise(_("This is often caused by using wide encodings such as")); + advise(_("UTF-16. Please check your editor settings.")); + } + return -1; + } + /* Not having i18n.commitencoding is the same as having utf-8 */ encoding_is_utf8 = is_encoding_utf8(git_commit_encoding);
diff --git a/t/t3900-i18n-commit.sh b/t/t3900-i18n-commit.sh
index 1f62c15..d48a7c0 100755
--- a/t/t3900-i18n-commit.sh
+++ b/t/t3900-i18n-commit.sh@@ -34,6 +34,12 @@ test_expect_success 'no encoding header for base case' ' test z = "z$E" ' +test_expect_failure 'UTF-16 refused because of NULs' ' + echo UTF-16 >F && + git commit -a -F "$TEST_DIRECTORY"/t3900/UTF-16.txt +' + + for H in ISO8859-1 eucJP ISO-2022-JP do test_expect_success "$H setup" '
diff --git a/t/t3900/UTF-16.txt b/t/t3900/UTF-16.txt
new file mode 100644
index 0000000000000000000000000000000000000000..53296be684253f40964c0604be7fa7ff12e200cbGIT binary patch literal 32 mcmezOpWz6@X@-jo=NYasZ~@^#h9rjP3@HpR7}6Nh8Mpw;r3yp< literal 0 HcmV?d00001 -- 1.7.8.36.g69ee2