[U-Boot] [PATCH v2] patman: add Commit-notes tag and section

[Simon Glass]

Applied to u-boot-x86 branch buildpatman, thank you.

(I added a little note to the README to describe your excellent new feature)



On Tue, Nov 12, 2013 at 3:14 AM, Albert ARIBAUD
<albert.u.boot at aribaud.net>wrote:

> Sometimes a commit should have notes enclosed with it rather
> than withing the cover letter -- possibly even because there
> is no cover letter. Add a 'Commit-notes' tag, similar to the
> 'Series-notes' one; lines between this tag and the next END
> line are inserted in the patch right after the '---' commit
> delimiter.
>
> Signed-off-by: Albert ARIBAUD <albert.u.boot at aribaud.net>
> ---
> Yes, I am writing this note through the very feature that
> this patch intends to add. If you can read it just below the
> commit delimiter line ('---') then the feature works.
>
> Well, at least, it works in this very case. :)
>
> Changes in v2:
> - changed tag name from 'Series-commit-notes' to 'Commit-notes'
>
>  tools/patman/README         |  2 +-
>  tools/patman/commit.py      |  2 ++
>  tools/patman/patchstream.py | 43
> ++++++++++++++++++++++++++++++++++++-------
>  3 files changed, 39 insertions(+), 8 deletions(-)
>
> diff --git a/tools/patman/README b/tools/patman/README
> index e6d3070..626dc86 100644
> --- a/tools/patman/README
> +++ b/tools/patman/README
> @@ -227,7 +227,7 @@ TEST=...
>  Change-Id:
>  Review URL:
>  Reviewed-on:
> -
> +Commit-xxxx: (except Commit-notes)
>
>  Exercise for the reader: Try adding some tags to one of your current
>  patch series and see how the patches turn out.
> diff --git a/tools/patman/commit.py b/tools/patman/commit.py
> index 900cfb3..89cce7f 100644
> --- a/tools/patman/commit.py
> +++ b/tools/patman/commit.py
> @@ -21,6 +21,7 @@ class Commit:
>          changes: Dict containing a list of changes (single line strings).
>              The dict is indexed by change version (an integer)
>          cc_list: List of people to aliases/emails to cc on this commit
> +        notes: List of lines in the commit (not series) notes
>      """
>      def __init__(self, hash):
>          self.hash = hash
> @@ -28,6 +29,7 @@ class Commit:
>          self.tags = []
>          self.changes = {}
>          self.cc_list = []
> +        self.notes = []
>
>      def AddChange(self, version, info):
>          """Add a new change line to the change list for a version.
> diff --git a/tools/patman/patchstream.py b/tools/patman/patchstream.py
> index c204523..684204c 100644
> --- a/tools/patman/patchstream.py
> +++ b/tools/patman/patchstream.py
> @@ -30,7 +30,10 @@ re_cover = re.compile('^Cover-letter:')
>  re_cover_cc = re.compile('^Cover-letter-cc: *(.*)')
>
>  # Patch series tag
> -re_series = re.compile('^Series-([a-z-]*): *(.*)')
> +re_series_tag = re.compile('^Series-([a-z-]*): *(.*)')
> +
> +# Commit series tag
> +re_commit_tag = re.compile('^Commit-([a-z-]*): *(.*)')
>
>  # Commit tags that we want to collect and keep
>  re_tag = re.compile('^(Tested-by|Acked-by|Reviewed-by|Cc): (.*)')
> @@ -90,6 +93,20 @@ class PatchStream:
>          if self.is_log:
>              self.series.AddTag(self.commit, line, name, value)
>
> +    def AddToCommit(self, line, name, value):
> +        """Add a new Commit-xxx tag.
> +
> +        When a Commit-xxx tag is detected, we come here to record it.
> +
> +        Args:
> +            line: Source line containing tag (useful for debug/error
> messages)
> +            name: Tag name (part after 'Commit-')
> +            value: Tag value (part after 'Commit-xxx: ')
> +        """
> +        if name == 'notes':
> +            self.in_section = 'commit-' + name
> +            self.skip_blank = False
> +
>      def CloseCommit(self):
>          """Save the current commit into our commit list, and reset our
> state"""
>          if self.commit and self.is_log:
> @@ -138,7 +155,8 @@ class PatchStream:
>                  line = line[4:]
>
>          # Handle state transition and skipping blank lines
> -        series_match = re_series.match(line)
> +        series_tag_match = re_series_tag.match(line)
> +        commit_tag_match = re_commit_tag.match(line)
>          commit_match = re_commit.match(line) if self.is_log else None
>          cover_cc_match = re_cover_cc.match(line)
>          tag_match = None
> @@ -165,6 +183,9 @@ class PatchStream:
>                  elif self.in_section == 'notes':
>                      if self.is_log:
>                          self.series.notes += self.section
> +                elif self.in_section == 'commit-notes':
> +                    if self.is_log:
> +                        self.commit.notes += self.section
>                  else:
>                      self.warn.append("Unknown section '%s'" %
> self.in_section)
>                  self.in_section = None
> @@ -178,7 +199,7 @@ class PatchStream:
>              self.commit.subject = line
>
>          # Detect the tags we want to remove, and skip blank lines
> -        elif re_remove.match(line):
> +        elif re_remove.match(line) and not commit_tag_match:
>              self.skip_blank = True
>
>              # TEST= should be the last thing in the commit, so remove
> @@ -211,9 +232,9 @@ class PatchStream:
>              self.skip_blank = False
>
>          # Detect Series-xxx tags
> -        elif series_match:
> -            name = series_match.group(1)
> -            value = series_match.group(2)
> +        elif series_tag_match:
> +            name = series_tag_match.group(1)
> +            value = series_tag_match.group(2)
>              if name == 'changes':
>                  # value is the version number: e.g. 1, or 2
>                  try:
> @@ -226,6 +247,14 @@ class PatchStream:
>                  self.AddToSeries(line, name, value)
>                  self.skip_blank = True
>
> +        # Detect Commit-xxx tags
> +        elif commit_tag_match:
> +            name = commit_tag_match.group(1)
> +            value = commit_tag_match.group(2)
> +            if name == 'notes':
> +                self.AddToCommit(line, name, value)
> +                self.skip_blank = True
> +
>          # Detect the start of a new commit
>          elif commit_match:
>              self.CloseCommit()
> @@ -276,7 +305,7 @@ class PatchStream:
>                  out = []
>                  log = self.series.MakeChangeLog(self.commit)
>                  out += self.FormatTags(self.tags)
> -                out += [line] + log
> +                out += [line] + self.commit.notes + [''] + log
>              elif self.found_test:
>                  if not re_allowed_after_test.match(line):
>                      self.lines_after_test += 1
> --
> 1.8.3.2
>
>