When a patch is added to a series after the initial version, there are no changes to note except that it is new. This is typically done to suppress the "(no changes in vN)" message. It's also nice to add a change to the cover letter so reviewers know there is an additional patch. Add a tag to automate this process a bit.
There are two nits with the current approach:
- It favors '-' as a bullet point, but some people may prefer '*' (or something else) - Tags (e.g. 'patman: ' in 'patman: foo bar') are not stripped. They are probably just noise in most series, but they may be useful for treewide series to distinguish 'gpio: frobnicate' from 'reset: frobnicate', so I've left them in.
Suggestions for the above appreciated.
Suggested-by: Douglas Anderson dianders@chromium.org Signed-off-by: Sean Anderson seanga2@gmail.com ---
tools/patman/func_test.py | 2 ++ tools/patman/patchstream.py | 5 +++++ tools/patman/patman.rst | 13 +++++++++++++ ...t-cast-for-sandbox-in-fdtdec_setup_mem_siz.patch | 1 + tools/patman/test/test01.txt | 1 + 5 files changed, 22 insertions(+)
diff --git a/tools/patman/func_test.py b/tools/patman/func_test.py index 3b4c9448882..af6c025a441 100644 --- a/tools/patman/func_test.py +++ b/tools/patman/func_test.py @@ -293,6 +293,7 @@ Changes in v4: change - Some changes - Some notes for the cover letter +- fdt: Correct cast for sandbox in fdtdec_setup_mem_size_base()
Simon Glass (2): pci: Correct cast for sandbox @@ -342,6 +343,7 @@ Changes in v4: - Multi line change +- New - Some changes
Changes in v2: diff --git a/tools/patman/patchstream.py b/tools/patman/patchstream.py index ec1ca874fb2..a09ae9c7371 100644 --- a/tools/patman/patchstream.py +++ b/tools/patman/patchstream.py @@ -477,6 +477,11 @@ class PatchStream: self.change_version = self._parse_version(value, line) elif name == 'cc': self.commit.add_cc(value.split(',')) + elif name == 'added-in': + version = self._parse_version(value, line) + self.commit.add_change(version, '- New') + self.series.AddChange(version, None, '- %s' % + self.commit.subject) else: self._add_warn('Line %d: Ignoring Commit-%s' % (self.linenum, name)) diff --git a/tools/patman/patman.rst b/tools/patman/patman.rst index 9971fa8c0fd..63b95a6b161 100644 --- a/tools/patman/patman.rst +++ b/tools/patman/patman.rst @@ -350,6 +350,19 @@ Cover-changes: n - This line will only appear in the cover letter <blank line>
+Commit-added-in: n + Add a change noting the version this commit was added in. This is + equivalent to:: + + Commit-changes: n + - New + + Cover-changes: n + - <commit subject> + + It is a convenient shorthand for suppressing the '(no changes in vN)' + message. + Patch-cc / Commit-cc: Their Name <email> This copies a single patch to another email address. Note that the Cc: used by git send-email is ignored by patman, but will be diff --git a/tools/patman/test/0002-fdt-Correct-cast-for-sandbox-in-fdtdec_setup_mem_siz.patch b/tools/patman/test/0002-fdt-Correct-cast-for-sandbox-in-fdtdec_setup_mem_siz.patch index 55a0d6756aa..48ea1793b47 100644 --- a/tools/patman/test/0002-fdt-Correct-cast-for-sandbox-in-fdtdec_setup_mem_siz.patch +++ b/tools/patman/test/0002-fdt-Correct-cast-for-sandbox-in-fdtdec_setup_mem_siz.patch @@ -23,6 +23,7 @@ Series-version: 3 Patch-cc: fred Commit-cc: joe Series-process-log: sort, uniq +Commit-added-in: 4 Series-changes: 4 - Some changes - Multi diff --git a/tools/patman/test/test01.txt b/tools/patman/test/test01.txt index 271d9bf043f..b2d73c5972c 100644 --- a/tools/patman/test/test01.txt +++ b/tools/patman/test/test01.txt @@ -51,6 +51,7 @@ Date: Sat Apr 15 15:39:08 2017 -0600 Patch-cc: fred Commit-cc: joe Series-process-log: sort, uniq + Commit-added-in: 4 Series-changes: 4 - Some changes - Multi