By default patman generates a combined changelog for the cover letter. This may not always be desireable.
Many patches may have the same changes. These can be coalesced with "Series-process-log: uniq", but this is imperfect. First, this cannot be used when there are multi-line changes. In addition, 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 sens 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 make it easier to get a good feel for what has changed, without making it difficult to wade through every change in the whole series.
For these reasons, this patch adds an option to disable the automatic changelog.
Signed-off-by: Sean Anderson seanga2@gmail.com ---
tools/patman/func_test.py | 2 +- tools/patman/patchstream.py | 7 ++++--- tools/patman/patman.py | 6 +++++- 3 files changed, 10 insertions(+), 5 deletions(-)
diff --git a/tools/patman/func_test.py b/tools/patman/func_test.py index 0a8dc9b661..65eccceb74 100644 --- a/tools/patman/func_test.py +++ b/tools/patman/func_test.py @@ -151,7 +151,7 @@ class TestFunctional(unittest.TestCase): with capture() as out: patchstream.FixPatches(series, args, False) if cover_fname and series.get('cover'): - patchstream.InsertCoverLetter(cover_fname, series, count) + patchstream.InsertCoverLetter(cover_fname, series, count, True) series.DoChecks() cc_file = series.MakeCcFile(process_tags, cover_fname, not ignore_bad_tags, add_maintainers, diff --git a/tools/patman/patchstream.py b/tools/patman/patchstream.py index 3d83ed6adb..1cc9bce00c 100644 --- a/tools/patman/patchstream.py +++ b/tools/patman/patchstream.py @@ -551,7 +551,7 @@ def FixPatches(series, fnames, empty_changes): count += 1 print('Cleaned %d patches' % count)
-def InsertCoverLetter(fname, series, count): +def InsertCoverLetter(fname, series, count, changelog): """Inserts a cover letter with the required info into patch 0
Args: @@ -581,7 +581,8 @@ def InsertCoverLetter(fname, series, count): line += '\n'.join(series.notes) + '\n'
# Now the change list - out = series.MakeChangeLog(None) - line += '\n' + '\n'.join(out) + if changelog: + out = series.MakeChangeLog(None, False) + line += '\n' + '\n'.join(out) fd.write(line) fd.close() diff --git a/tools/patman/patman.py b/tools/patman/patman.py index 6f92c5b7f3..aa123c18c2 100755 --- a/tools/patman/patman.py +++ b/tools/patman/patman.py @@ -62,6 +62,9 @@ parser.add_option('--no-check', action='store_false', dest='check_patch', 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 aliases") +parser.add_option('--no-changelog', action = 'store_false', dest='changelog', + default=True, + help="Don't create a changelog in the cover letter") parser.add_option('--no-empty-changes', action = 'store_false', dest='empty_changes', default=True, help="Suppress empty change entries in patch changelogs") @@ -151,7 +154,8 @@ else: # Fix up the patch files to our liking, and insert the cover letter patchstream.FixPatches(series, args, options.empty_changes) if cover_fname and series.get('cover'): - patchstream.InsertCoverLetter(cover_fname, series, options.count) + patchstream.InsertCoverLetter(cover_fname, series, options.count, + options.changelog)
# Do a few checks on the series series.DoChecks()