Skip to contentSkip to conversation

patman: Add changelog customization options

PATCH New Sean Anderson 2 participants 6 messages May 4, 2020 – May 6, 2020

lore
Share & tools
lore
#0 lore raw

v4 cover patman: Add changelog customization options

This series adds a few changes I have been using locally as new tags for patman. This series has itself been developed using these patches, and the unprocessed commits can be viewed at [1].

[1] https://github.com/Forty-Bot/u-boot/tree/patman

Changes in v4:
- Document ParseVersion
- Fix need_blank not always reflecting the need for a blank
- Refactor newest_version logic
- Reorder commits so tests get added last

Changes in v3:
- Document empty changelog suppression in README
- Fix KeyError when running tests
- Fix some corner cases for no changes messages
- Modify tests for new behavior
- Update commit subjects

Changes in v2:
- Add a note when there are no changes in the current revision
- Add documentation for new tags
- Add patch for multi-line changes in changelogs
- Switch to using commit tags for changelog control, instead of command-line options

Sean Anderson (4):
patman: Suppress empty changelog entries
patman: Add new tags for finer-grained changelog control
patman: Support multi-line changes in changelogs
patman: Modify functional tests for new behavior

 tools/patman/README                           |  48 +++++++-
 tools/patman/func_test.py                     |  58 ++++++++--
 tools/patman/main.py                          |   2 +-
 tools/patman/patchstream.py                   | 104 ++++++++++++------
 tools/patman/series.py                        |  54 +++++++--
 .../0001-pci-Correct-cast-for-sandbox.patch   |   3 +
 ...-for-sandbox-in-fdtdec_setup_mem_siz.patch |  12 +-
 tools/patman/test/test01.txt                  |  15 ++-
 8 files changed, 241 insertions(+), 55 deletions(-)
Signature · 1 line
2.26.2
#1 lore raw

PATCH v4 1/4 patman: Suppress empty changelog entries

Patman outputs a line for every edition of the series in every patch, regardless of whether any changes were made. This can result in many redundant lines in patch changelogs, especially when a patch did not exist before a certain revision. For example, the existing behaviour could result in a changelog of

Changes in v7: None
Changes in v6: None
Changes in v5:
- Make a change

Changes in v4: None

Changes in v3:
- New

Changes in v2: None

With this patch applied and with --no-empty-changes, the same patch would look like

(no changes since v5)

Changes in v5:
- Make a change

Changes in v3:
- New

This is entirely aesthetic, but I think it reduces clutter, especially for patches added later on in a series.

---

Changes in v4:
- Fix need_blank not always reflecting the need for a blank
- Refactor newest_version logic

Changes in v3:
- Document empty changelog suppression in README
- Fix KeyError when running tests
- Fix no changes message being output for revision 1
- Fix no changes message sometimes being output before every non-newest-revision change
- Make the newest_version logic more robust (and ugly)
- Update commit subject

Changes in v2:
- Add a note when there are no changes in the current revision
- Make this the default behaviour, and remove the option

 tools/patman/README    | 21 +++++++++++++++++++++
 tools/patman/series.py | 43 ++++++++++++++++++++++++++++++------------
 2 files changed, 52 insertions(+), 12 deletions(-)
tools/patman/README +21 -0
index 02d5829744..d1d9891c4c 100644
@@ -474,6 +474,27 @@ print out the command line patman would have used.
 not later when you can't remember which patch you changed. You can always
 go back and change or remove logs from commits.
 
+7. Patches will have no changelog entries for revisions where they did not
+change. For clarity, if there are no changes for this patch in the most
+recent revision of the series, a note will be added. For example, a patch
+with the following tags in the commit
+
+    Series-version: 5
+    Series-changes: 2
+    - Some change
+
+    Series-changes: 4
+    - Another change
+
+would have a changelog of
+
+    (no changes since v4)
+
+    Changes in v4:
+    - Another change
+
+    Changes in v2:
+    - Some change
 
 Other thoughts
 ==============
tools/patman/series.py +31 -12

69 lines not on this page · raw message

Signature · 1 line
2.26.2
#2 lore raw

PATCH v4 2/4 patman: Add new tags for finer-grained changelog control

In reply to Sean Anderson

By default patman generates a combined changelog for the cover letter. This may not always be desirable.

Many patches may have the same changes. These can be coalesced with "Series-process-log: uniq", but this is imperfect. Similar changes like "Move foo to patch 7" will not be merged with the similar "Move foo to this patch from patch 6".

Changes may not make sense outside of the patch they are written for. For example, a change line of "Add check for bar" does not make sense outside of the context in which bar might be checked for. Some changes like "New" or "Lint" may be repeated many times throughout different change logs, but carry no useful information in a summary.

Lastly, I like to summarize the broad strokes of the changes I have made in the cover letter, while documenting all the details in the appropriate patches. I think this makes it easier to get a good feel for what has changed, without making it difficult to wade through every change in the whole series.

This patch adds two new tags to add changelog entries which only appear in the cover letter, or only appear in the commit. Changes documented with "Commit-changes" will only appear in the commit, and will not appear in the cover letter. Changes documented with "Cover-changes" will not appear in any commit, and will only appear in the cover letter.

---

Changes in v4:
- Document ParseVersion
- Fix typos in commit message

Changes in v2:
- Add documentation for new tags
- Switch to using commit tags for changelog control, instead of command-line options

 tools/patman/README         | 17 ++++++++
 tools/patman/main.py        |  2 +-
 tools/patman/patchstream.py | 81 ++++++++++++++++++++++++-------------
 tools/patman/series.py      | 15 ++++++-
 4 files changed, 83 insertions(+), 32 deletions(-)
tools/patman/README +17 -0
index d1d9891c4c..5a67a49e88 100644
@@ -247,6 +247,23 @@ Series-changes: n
 	to update the log there and then, knowing that the script will
 	do the rest.
 
+Commit-changes: n
+- This line will not appear in the cover-letter changelog
+<blank line>
+	This tag is like Series-changes, except changes in this changelog will
+	only appear in the changelog of the commit this tag is in. This is
+	useful when you want to add notes which may not make sense in the cover
+	letter. For example, you can have short changes such as "New" or
+	"Lint".
+
+Cover-changes: n
+- This line will only appear in the cover letter
+<blank line>
+	This tag is like Series-changes, except changes in this changelog will
+	only appear in the cover-letter changelog. This is useful to summarize
+	changes made with Commit-changes, or to add additional context to
+	changes.
+
 Patch-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
tools/patman/main.py +1 -1
index f3d9c0c434..2c21a3130e 100755
@@ -62,7 +62,7 @@ parser.add_option('--no-check', action='store_false', dest='check_patch',
                   default=True,
                   help="Don't check for patch compliance")
 parser.add_option('--no-tags', action='store_false', dest='process_tags',
-                  default=True, help="Don't process subject tags as aliaes")
+                  default=True, help="Don't process subject tags as aliases")
 parser.add_option('--smtp-server', type='str',
                   help="Specify the SMTP server to 'git send-email'")
 parser.add_option('-T', '--thread', action='store_true', dest='thread',
tools/patman/patchstream.py +52 -29

157 lines not on this page · raw message

tools/patman/series.py +13 -2
index be6f061122..ca7ca556dc 100644
@@ -2,6 +2,9 @@
 # Copyright (c) 2011 The Chromium OS Authors.
 #
 
+from __future__ import print_function
+
+import collections
 import itertools
 import os
 
@@ -156,7 +159,15 @@ class Series(dict):
             - Fix the widget
             - Jog the dial
         """
-        versions = sorted(self.changes, reverse=True)
+        # Collect changes from the series and this commit
+        changes = collections.defaultdict(list)
+        for version, changelist in self.changes.items():
+            changes[version] += changelist
+        if commit:
+            for version, changelist in commit.changes.items():
+                changes[version] += [[commit, text] for text in changelist]
+
+        versions = sorted(changes, reverse=True)
         newest_version = 1
         if 'version' in self:
             newest_version = max(newest_version, int(self.version))
@@ -169,7 +180,7 @@ class Series(dict):
         need_blank = False
         for version in versions:
             out = []
-            for this_commit, text in self.changes[version]:
+            for this_commit, text in changes[version]:
                 if commit and this_commit != commit:
                     continue
                 if 'uniq' not in process_it or text not in out:
Signature · 1 line
2.26.2
#3 lore raw

PATCH v4 3/4 patman: Support multi-line changes in changelogs

In reply to Sean Anderson

This patch adds support to multi-line changes. That is, if one has a line in a changelog like
- Do a thing but
it spans multiple lines
Using Series-process-log sort would sort as if those lines were unrelated. With this patch, any change line starting with whitespace will be considered part of the change before it.

---

(no changes since v2)

Changes in v2:
- New

 tools/patman/README         | 10 ++++++++--
 tools/patman/patchstream.py | 35 +++++++++++++++++++++++++++--------
 2 files changed, 35 insertions(+), 10 deletions(-)
tools/patman/README +8 -2
index 5a67a49e88..155736568c 100644
@@ -270,8 +270,14 @@ Patch-cc: Their Name <email>
 	interpreted by git send-email if you use it.
 
 Series-process-log: sort, uniq
-	This tells patman to sort and/or uniq the change logs. It is
-	assumed that each change log entry is only a single line long.
+	This tells patman to sort and/or uniq the change logs. Changes may be
+	multiple lines long, as long as each subsequent line of a change begins
+	with a whitespace character. For example,
+
+- This change
+  continues onto the next line
+- But this change is separate
+
 	Use 'sort' to sort the entries, and 'uniq' to include only
 	unique entries. If omitted, no change log processing is done.
 	Separate each tag with a comma.
tools/patman/patchstream.py +27 -8
index 871c66aeb1..4fe465e9ab 100644
@@ -45,6 +45,9 @@ re_commit = re.compile('^commit ([0-9a-f]*)$')
 # We detect these since checkpatch doesn't always do it
 re_space_before_tab = re.compile('^[+].* \t')
 
+# Match indented lines for changes
+re_leading_whitespace = re.compile('^\s')
+
 # States we can be in - can we use range() and still have comments?
 STATE_MSG_HEADER = 0        # Still in the message header
 STATE_PATCH_SUBJECT = 1     # In patch subject (first line of log for a commit)
@@ -72,6 +75,7 @@ class PatchStream:
         self.is_log = is_log             # True if indent like git log
         self.in_change = None            # Name of the change list we are in
         self.change_version = 0          # Non-zero if we are in a change list
+        self.change_lines = []           # Lines of the current change
         self.blank_count = 0             # Number of blank lines stored up
         self.state = STATE_MSG_HEADER    # What state are we in?
         self.signoff = []                # Contents of signoff line
@@ -138,6 +142,20 @@ class PatchStream:
             raise ValueError("%s: Cannot decode version info '%s'" %
                 (self.commit.hash, line))
 
+    def FinalizeChange(self):
+        """Finalize a (multi-line) change and add it to the series or commit"""
+        if not self.change_lines:
+            return
+        change = '\n'.join(self.change_lines)
+
+        if self.in_change == 'Series':
+            self.series.AddChange(self.change_version, self.commit, change)
+        elif self.in_change == 'Cover':
+            self.series.AddChange(self.change_version, None, change)
+        elif self.in_change == 'Commit':
+            self.commit.AddChange(self.change_version, change)
+        self.change_lines = []
+
     def ProcessLine(self, line):
         """Process a single line of a patch file or commit log
 
@@ -178,6 +196,7 @@ class PatchStream:
         commit_tag_match = re_commit_tag.match(line)
         cover_match = re_cover.match(line)
         signoff_match = re_signoff.match(line)
+        leading_whitespace_match = re_leading_whitespace.match(line)
         tag_match = None
         if self.state == STATE_PATCH_HEADER:
             tag_match = re_tag.match(line)
@@ -218,6 +237,7 @@ class PatchStream:
             # is missing, fix it up.
             if self.in_change:
                 self.warn.append("Missing 'blank line' in section '%s-changes'" % self.in_change)
+                self.FinalizeChange()
                 self.in_change = None
                 self.change_version = 0
 
@@ -272,20 +292,18 @@ class PatchStream:
         elif self.in_change:
             if is_blank:
                 # Blank line ends this change list
+                self.FinalizeChange()
                 self.in_change = None
                 self.change_version = 0
             elif line == '---':
+                self.FinalizeChange()
                 self.in_change = None
                 self.change_version = 0
                 out = self.ProcessLine(line)
-            else:
-                if self.is_log:
-                    if self.in_change == 'Series':
-                        self.series.AddChange(self.change_version, self.commit, line)
-                    elif self.in_change == 'Cover':
-                        self.series.AddChange(self.change_version, None, line)
-                    elif self.in_change == 'Commit':
-                        self.commit.AddChange(self.change_version, line)
+            elif self.is_log:
+                if not leading_whitespace_match:
+                    self.FinalizeChange()
+                self.change_lines.append(line)
             self.skip_blank = False
 
         # Detect Series-xxx tags
@@ -378,6 +396,7 @@ class PatchStream:
 
     def Finalize(self):
         """Close out processing of this patch stream"""
+        self.FinalizeChange()
         self.CloseCommit()
         if self.lines_after_test:
             self.warn.append('Found %d lines after TEST=' %
Signature · 1 line
2.26.2
#4 lore raw

PATCH v4 4/4 patman: Modify functional tests for new behavior

In reply to Sean Anderson

This patch adds or modifies functional tests for the Cover-changes, Commit-changes, and Series-process-log tags in order to account for new behavior added in the previous few patches. The '(no changes since v1)' case is not tested for, since that would need an additional commit to test in addition to testing the existing code paths.

---

(no changes since v3)

Changes in v3:
- New

 tools/patman/func_test.py                     | 58 ++++++++++++++++---
 .../0001-pci-Correct-cast-for-sandbox.patch   |  3 +
 ...-for-sandbox-in-fdtdec_setup_mem_siz.patch | 12 +++-
 tools/patman/test/test01.txt                  | 15 ++++-
 4 files changed, 79 insertions(+), 9 deletions(-)
tools/patman/func_test.py +51 -7
index b7e2825de8..dc30078cce 100644
@@ -82,19 +82,33 @@ class TestFunctional(unittest.TestCase):
             Series-prefix: RFC
             Series-cc: Stefan Br?ns <[email protected]>
             Cover-letter-cc: Lord M?lchett <[email protected]>
-            Series-version: 2
+            Series-version: 3
+            Patch-cc: fred
+            Series-process-log: sort, uniq
             Series-changes: 4
             - Some changes
+            - Multi
+              line
+              change
+
+            Commit-changes: 2
+            - Changes only for this commit
+
+            Cover-changes: 4
+            - Some notes for the cover letter
 
             Cover-letter:
             test: A test patch series
             This is a test of how the cover
-            leter
+            letter
             works
             END
 
         and this in the first commit:
 
+            Commit-changes: 2
+            - second revision change
+
             Series-notes:
             some notes
             about some things
@@ -202,7 +216,7 @@ class TestFunctional(unittest.TestCase):
 
         expected = '''
 This is a test of how the cover
-leter
+letter
 works
 
 some notes
@@ -210,7 +224,11 @@ about some things
 from the first commit
 
 Changes in v4:
+- Multi
+  line
+  change
 - Some changes
+- Some notes for the cover letter
 
 Simon Glass (2):
   pci: Correct cast for sandbox
@@ -237,8 +255,34 @@ Simon Glass (2):
             subject = [line for line in lines if line.startswith('Subject')]
             self.assertEqual('Subject: [RFC %d/%d]' % (i + 1, count),
                              subject[0][:18])
+
+            # Check that we got our commit notes
+            start = 0
+            expected = ''
+
             if i == 0:
-                # Check that we got our commit notes
-                self.assertEqual('---', lines[17])
-                self.assertEqual('Some notes about', lines[18])
-                self.assertEqual('the first commit', lines[19])
+                start = 17
+                expected = '''---
+Some notes about
+the first commit
+
+(no changes since v2)
+
+Changes in v2:
+- second revision change'''
+            elif i == 1:
+                start = 17
+                expected = '''---
+
+Changes in v4:
+- Multi
+  line
+  change
+- Some changes
+
+Changes in v2:
+- Changes only for this commit'''
+
+            if expected:
+                expected = expected.splitlines()
+                self.assertEqual(expected, lines[start:(start+len(expected))])
tools/patman/test/0001-pci-Correct-cast-for-sandbox.patch +3 -0
index 7191176f75..038943c2c9 100644
@@ -15,6 +15,9 @@ cmd/pci.c:152:11: warning: format ?%llx? expects argument of type
 Fix it with a cast.
 
 Signed-off-by: Simon Glass <[email protected]>
+Commit-changes: 2
+- Changes only for this commit
+
 Series-notes:
 some notes
 about some things
tools/patman/test/0002-fdt-Correct-cast-for-sandbox-in-fdtdec_setup_mem_siz.patch +11 -1
index 702c0306ff..56278a6ce9 100644
@@ -21,13 +21,23 @@ Series-cc: Stefan Br?ns <[email protected]>
 Cover-letter-cc: Lord M?lchett <[email protected]>
 Series-version: 3
 Patch-cc: fred
+Series-process-log: sort, uniq
 Series-changes: 4
 - Some changes
+- Multi
+  line
+  change
+
+Commit-changes: 2
+- Changes only for this commit
+
+Cover-changes: 4
+- Some notes for the cover letter
 
 Cover-letter:
 test: A test patch series
 This is a test of how the cover
-leter
+letter
 works
 END
 ---
tools/patman/test/test01.txt +14 -1
index 478ea93674..b238a8b4ba 100644
@@ -13,6 +13,9 @@ Date:   Sat Apr 15 15:39:08 2017 -0600
     Fix it with a cast.
     
     Signed-off-by: Simon Glass <[email protected]>
+    Commit-changes: 2
+    - second revision change
+
     Series-notes:
     some notes
     about some things
@@ -45,12 +48,22 @@ Date:   Sat Apr 15 15:39:08 2017 -0600
     Cover-letter-cc: Lord M?lchett <[email protected]>
     Series-version: 3
     Patch-cc: fred
+    Series-process-log: sort, uniq
     Series-changes: 4
     - Some changes
+    - Multi
+      line
+      change
+
+    Commit-changes: 2
+    - Changes only for this commit
+
+    Cover-changes: 4
+    - Some notes for the cover letter
     
     Cover-letter:
     test: A test patch series
     This is a test of how the cover
-    leter
+    letter
     works
     END
Signature · 1 line
2.26.2
#5 lore raw

PATCH v4 4/4 patman: Modify functional tests for new behavior

Quoted 12 lines · Sean Anderson

This patch adds or modifies functional tests for the Cover-changes, Commit-changes, and Series-process-log tags in order to account for new behavior added in the previous few patches. The '(no changes since v1)' case is not tested for, since that would need an additional commit to test in addition to testing the existing code paths.

---

(no changes since v3)

Quoted 8 lines

Changes in v3:
- New

 tools/patman/func_test.py                     | 58 ++++++++++++++++---
 .../0001-pci-Correct-cast-for-sandbox.patch   |  3 +
 ...-for-sandbox-in-fdtdec_setup_mem_siz.patch | 12 +++-
 tools/patman/test/test01.txt                  | 15 ++++-
 4 files changed, 79 insertions(+), 9 deletions(-)