patch にコメントを含める

興味がなかったのだが、他の人が自分パッチを使う事になって初めて、コメントを含めたくなった。
で、コメントをどう書くのか調べた。

正確には、 unified format 上で¹だけど。

$ touch foo.txt
$ echo contents > bar.txt
$ (echo COMMENT ; diff -up foo.txt bar.txt ; echo COMMENT )> df.patch
$ patch -o test < df.patch
$ cat test
contents

$ cat df.patch
COMMENT
--- foo.txt     2017-01-05 13:29:21.230815000 +0900
+++ bar.txt     2017-01-05 13:28:22.497441800 +0900
@@ -0,0 +1 @@
+contents
COMMENT

patch が満足に動くコメント

ただ、これが保証された動作かどうか知らない。単に実装の隙かもしれない。

• ヘッダ行の上は、空白行込であろうがなんであろうが、コメントが書ける²
• 文末からのは、インデント無の文章しか書けない。
  • インデント無の文章を任意の場所に含める事を許容する実装もあるらしい。実際に確かめたわけではない。

---

1. 従って GNU patch が対象 ↩

2. 書くまでもない事だが、行頭からの --- だの +++ だのは避ける。 ↩