patch-manager 0.0.8__tar.gz → 0.0.10__tar.gz

{patch_manager-0.0.8 → patch_manager-0.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: patch-manager
-Version: 0.0.8
+Version: 0.0.10
 Summary: Create, check and email patch series, with Patchwork integration
 Author-email: Simon Glass <sjg@chromium.org>
 License-Expression: GPL-2.0-or-later
@@ -111,6 +111,13 @@ The suite is self-contained: a pinned ``checkpatch.pl`` and its helper files
 live in ``scripts/``, and the bundled ``u_boot_pylib`` package is vendored in
 the tree, so no surrounding U-Boot source is required.
 
+Build the documentation locally with::
+
+    pip install -r doc/requirements.txt
+    make -C doc html
+
+The rendered HTML is written to ``doc/_build/html``.
+
 License
 -------
 

{patch_manager-0.0.8 → patch_manager-0.0.10}/README.rst

@@ -74,6 +74,13 @@ The suite is self-contained: a pinned ``checkpatch.pl`` and its helper files
 live in ``scripts/``, and the bundled ``u_boot_pylib`` package is vendored in
 the tree, so no surrounding U-Boot source is required.
 
+Build the documentation locally with::
+
+    pip install -r doc/requirements.txt
+    make -C doc html
+
+The rendered HTML is written to ``doc/_build/html``.
+
 License
 -------
 

{patch_manager-0.0.8 → patch_manager-0.0.10}/patch_manager.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: patch-manager
-Version: 0.0.8
+Version: 0.0.10
 Summary: Create, check and email patch series, with Patchwork integration
 Author-email: Simon Glass <sjg@chromium.org>
 License-Expression: GPL-2.0-or-later
@@ -111,6 +111,13 @@ The suite is self-contained: a pinned ``checkpatch.pl`` and its helper files
 live in ``scripts/``, and the bundled ``u_boot_pylib`` package is vendored in
 the tree, so no surrounding U-Boot source is required.
 
+Build the documentation locally with::
+
+    pip install -r doc/requirements.txt
+    make -C doc html
+
+The rendered HTML is written to ``doc/_build/html``.
+
 License
 -------
 

{patch_manager-0.0.8 → patch_manager-0.0.10}/patman/cser_helper.py

@@ -651,7 +651,8 @@ class CseriesHelper:
             ser.name = name
         return ser
 
-    def _parse_series_and_version(self, in_name, in_version):
+    def _parse_series_and_version(self, in_name, in_version,
+                                  include_archived=False):
         """Parse name and version of a series, or detect from current branch
 
         Figures out the name from in_name, or if that is None, from the current
@@ -663,6 +664,7 @@ class CseriesHelper:
         Args:
             in_name (str or None): name of series
             in_version (str or None): version of series
+            include_archived (bool): True to also find archived series
 
         Return:
             tuple:
@@ -690,7 +692,7 @@ class CseriesHelper:
             version = 1
         if version > 99:
             raise ValueError(f"Version {version} exceeds 99")
-        ser = self.get_series_by_name(name)
+        ser = self.get_series_by_name(name, include_archived)
         if not ser:
             ser = Series()
             ser.name = name
@@ -833,7 +835,7 @@ class CseriesHelper:
         if not quiet:
             tout.info(
                 f'Checking out upstream commit {upstream_name}: '
-                f'{oid(commit.oid)}')
+                f'{oid(commit.id)}')
 
         old_head = repo.head
         if old_head.shorthand == name:
@@ -843,7 +845,7 @@ class CseriesHelper:
 
         if new_name:
             name = new_name
-        repo.set_head(commit.oid)
+        repo.set_head(commit.id)
 
         commits = []
         cmt = repo.get(branch.target)
@@ -879,7 +881,7 @@ class CseriesHelper:
 
         tree_id = repo.index.write_tree()
         cherry = repo.get(cmt.hash)
-        tout.detail(f"cherry {oid(cherry.oid)}")
+        tout.detail(f"cherry {oid(cherry.id)}")
         return tree_id, cherry
 
     def _finish_commit(self, repo, tree_id, commit, cur, msg=None):
@@ -927,12 +929,12 @@ class CseriesHelper:
         target = repo.revparse_single('HEAD')
         if not quiet:
             tout.info(f'Updating branch {name} from {oid(branch.target)} to '
-                      f'{str(target.oid)[:HASH_LEN]}')
+                      f'{str(target.id)[:HASH_LEN]}')
         if dry_run:
             if new_name:
                 repo.head.set_target(branch.target)
             else:
-                branch_oid = branch.peel(pygit2.enums.ObjectType.COMMIT).oid
+                branch_oid = branch.peel(pygit2.enums.ObjectType.COMMIT).id
                 repo.head.set_target(branch_oid)
             repo.head.set_target(branch.target)
             repo.set_head(branch.name)
@@ -989,7 +991,7 @@ class CseriesHelper:
             name, count, quiet=True)
         repo.checkout_tree(commit, strategy=CheckoutStrategy.FORCE |
                            CheckoutStrategy.RECREATE_MISSING)
-        repo.set_head(commit.oid)
+        repo.set_head(commit.id)
         for seq, cmt in enumerate(series.commits):
             if seq != seq_to_drop:
                 tree_id, cherry = self._pick_commit(repo, cmt)
@@ -1058,7 +1060,7 @@ class CseriesHelper:
             tout.info(f'- {info.ljust(max_len)} {rest}')
         target = self._finish_process(repo, branch, name, cur, old_head,
                                       new_name, switch, dry_run)
-        vals.oid = target.oid
+        vals.oid = target.id
 
     def _mark_series(self, name, series, dry_run=False):
         """Mark a series with Change-Id tags
@@ -1204,12 +1206,14 @@ class CseriesHelper:
         col_state = self.col.build(col, prefix + out, bright)
         return col_state, pad
 
-    def _get_patches(self, series, version):
+    def _get_patches(self, series, version, include_archived=False):
         """Get a Series object containing the patches in a series
 
         Args:
             series (str): Name of series to use, or None to use current branch
             version (int): Version number, or None to detect from name
+            include_archived (bool): True to also find archived series, reading
+                their patches from the archive tag rather than the branch
 
         Return: tuple:
             str: Name of branch, e.g. 'mary2'
@@ -1223,7 +1227,8 @@ class CseriesHelper:
             str: cover_id
             int: cover_num_comments
         """
-        ser, version = self._parse_series_and_version(series, version)
+        ser, version = self._parse_series_and_version(series, version,
+                                                      include_archived)
         if not ser.idnum:
             raise ValueError(f"Unknown series '{series}'")
         self._ensure_version(ser, version)
@@ -1232,7 +1237,10 @@ class CseriesHelper:
 
         count = len(pwc)
         branch = self._join_name_version(ser.name, version)
-        series = patchstream.get_metadata(branch, 0, count,
+        # An archived series has no branch; read its patches from the
+        # archive tag instead
+        ref = svinfo.archive_tag if svinfo.archive_tag else branch
+        series = patchstream.get_metadata(ref, 0, count,
                                           git_dir=self.gitdir)
         self._copy_db_fields_to(series, ser)
 
@@ -1389,14 +1397,24 @@ class CseriesHelper:
         if gather_tags:
             count = len(pwc)
             branch = self._join_name_version(series_name, version)
-            series = patchstream.get_metadata(branch, 0, count,
+            # An archived series has no branch: read its patches from the
+            # archive tag, and do not try to write gathered tags back into
+            # a branch that no longer exists
+            svrec = self.get_ser_ver_dict().get(svid)
+            archived = bool(svrec and svrec.archive_tag)
+            ref = svrec.archive_tag if archived else branch
+            series = patchstream.get_metadata(ref, 0, count,
                                               git_dir=self.gitdir)
 
             _, new_rtag_list = status.do_show_status(
                 series, cover, patches, show_comments, show_cover_comments,
                 self.col, warnings_on_stderr=False)
-            self.update_series(branch, series, version, None, dry_run,
-                                add_rtags=new_rtag_list)
+            if archived:
+                tout.info(f"Series '{series_name}' is archived: "
+                          'not updating commit tags')
+            else:
+                self.update_series(branch, series, version, None, dry_run,
+                                    add_rtags=new_rtag_list)
 
         updated = 0
         for seq, item in enumerate(pwc.values()):

{patch_manager-0.0.8 → patch_manager-0.0.10}/patman/cseries.py

@@ -212,7 +212,7 @@ class Cseries(cser_helper.CseriesHelper):
 
             del_name = f'{ser.name}{max_vers}'
             del_branch = repo.lookup_branch(del_name)
-            branch_oid = del_branch.peel(pygit2.enums.ObjectType.COMMIT).oid
+            branch_oid = del_branch.peel(pygit2.enums.ObjectType.COMMIT).id
             del_branch.delete()
             tout.info(f"Deleted branch '{del_name}' {oid(branch_oid)}")
 
@@ -1347,7 +1347,7 @@ class Cseries(cser_helper.CseriesHelper):
         repo = pygit2.Repository(self.gitdir)
         for _, (idnum, name, tag_name) in tag_info.items():
             commit = repo.revparse_single(name)
-            repo.create_tag(tag_name, commit.hex,
+            repo.create_tag(tag_name, str(commit.id),
                             pygit2.enums.ObjectType.COMMIT,
                             commit.author, commit.message)
 
@@ -1364,8 +1364,8 @@ class Cseries(cser_helper.CseriesHelper):
 
             # Detach HEAD from the branch if pointing to this branch
             commit = repo.revparse_single(name)
-            if repo.head.target == commit.oid:
-                repo.set_head(commit.oid)
+            if repo.head.target == commit.id:
+                repo.set_head(commit.id)
 
             repo.branches.delete(name)
 
@@ -1431,7 +1431,7 @@ class Cseries(cser_helper.CseriesHelper):
             show_cover_comments (bool): Show all comments on the cover letter
         """
         branch, series, version, _, _, link, _, _ = self._get_patches(
-            series, version)
+            series, version, include_archived=True)
         if not link:
             raise ValueError(
                 f"Series '{series.name}' v{version} has no patchwork link: "
@@ -1470,7 +1470,8 @@ class Cseries(cser_helper.CseriesHelper):
             gather_tags (bool): True to gather review/test tags
             dry_run (bool): True to do a dry run (database is not updated)
         """
-        ser, version = self._parse_series_and_version(series, version)
+        ser, version = self._parse_series_and_version(
+            series, version, include_archived=True)
         self._ensure_version(ser, version)
         svid, link = self._get_series_svid_link(ser.idnum, version)
         if not link:

{patch_manager-0.0.8 → patch_manager-0.0.10}/patman/func_test.py

@@ -393,7 +393,7 @@ Changes in v2:
         target = repo.lookup_reference('refs/heads/first')
         # pylint doesn't seem to find this
         # pylint: disable=E1101
-        self.repo.checkout(target, strategy=pygit2.GIT_CHECKOUT_FORCE)
+        self.repo.checkout(target, strategy=pygit2.enums.CheckoutStrategy.FORCE)
         control.setup()
         orig_dir = os.getcwd()
         try:
@@ -443,7 +443,7 @@ Changes in v2:
             cover_lines = cover.splitlines()
             sig_pos = cover_lines.index('-- ')
             base2 = repo.lookup_reference('refs/heads/second')
-            ref = base2.peel(pygit2.GIT_OBJ_COMMIT).parents[0].parents[0].id
+            ref = base2.peel(pygit2.enums.ObjectType.COMMIT).parents[0].parents[0].id
             self.assertEqual(f'base-commit: {ref}', cover_lines[sig_pos - 3])
             self.assertEqual('branch: second', cover_lines[sig_pos - 2])
         finally:
@@ -603,7 +603,7 @@ diff --git a/lib/efi_loader/efi_memory.c b/lib/efi_loader/efi_memory.c
         target = repo.lookup_reference('refs/heads/base')
         # pylint doesn't seem to find this
         # pylint: disable=E1101
-        self.repo.checkout(target, strategy=pygit2.GIT_CHECKOUT_FORCE)
+        self.repo.checkout(target, strategy=pygit2.enums.CheckoutStrategy.FORCE)
 
         # Check that it can detect the current branch
         orig_dir = os.getcwd()

{patch_manager-0.0.8 → patch_manager-0.0.10}/patman/patman.rst

@@ -25,8 +25,10 @@ It also has some Patchwork features:
 - List comments received on a series
 
 It is intended to automate patch creation and make it a less
-error-prone process. It is useful for U-Boot and Linux work so far,
-since they use the checkpatch.pl script.
+error-prone process. It works with any git project that sends patches
+by email. The checkpatch and get_maintainer steps follow the U-Boot
+and Linux kernel conventions and can be skipped for projects that do
+not use them.
 
 It is configured almost entirely by tags it finds in your commits.
 This means that you can work on a number of different branches at
@@ -51,8 +53,7 @@ You can install patman using::
 
 The name is chosen since patman conflicts with an existing package.
 
-If you are using patman within the U-Boot tree, it may be easiest to add a
-symlink from your local `~/.bin` directory to `/path/to/tools/patman/patman`.
+The source code is hosted at https://github.com/nxtboot/patman
 
 How to use this tool
 --------------------
@@ -75,17 +76,17 @@ This tool requires a certain way of working:
 How to configure it
 -------------------
 
-For most cases of using patman for U-Boot development, patman can use the
-file 'doc/git-mailrc' in your U-Boot directory to supply the email aliases
-you need. To make this work, tell git where to find the file by typing
-this once::
+If your project ships a git mail-alias file (U-Boot, for example,
+provides 'doc/git-mailrc'), patman can use it to supply the email
+aliases you need. To make this work, tell git where to find the file
+by typing this once::
 
     git config sendemail.aliasesfile doc/git-mailrc
 
-For both Linux and U-Boot the 'scripts/get_maintainer.pl' handles
-figuring out where to send patches pretty well. For other projects,
-you may want to specify a different script to be run, for example via
-a project-specific `.patman` file::
+Projects in the U-Boot and Linux kernel style provide a
+'scripts/get_maintainer.pl' that works out where to send patches. For
+other projects, you may want to specify a different script to be run,
+for example via a project-specific `.patman` file::
 
     # .patman configuration file at the root of some project
 
@@ -122,8 +123,9 @@ file take precedence over those of the "global" one.
 
 Aliases are recursive.
 
-The checkpatch.pl in the U-Boot tools/ subdirectory will be located and
-used. Failing that you can put it into your path or ~/bin/checkpatch.pl
+If the project provides a checkpatch.pl (in its 'scripts/' or 'tools/'
+directory, as U-Boot and Linux do) patman will locate and use it.
+Failing that you can put it into your path or ~/bin/checkpatch.pl
 
 If you want to avoid sending patches to email addresses that are picked up
 by patman but are known to bounce you can add a [bounces] section to your
@@ -162,39 +164,26 @@ First do a dry run:
 
 .. code-block:: bash
 
-    ./tools/patman/patman send -n
+    patman send -n
 
 If it can't detect the upstream branch, try telling it how many patches
 there are in your series
 
 .. code-block:: bash
 
-    ./tools/patman/patman -c5 send -n
+    patman -c5 send -n
 
 This will create patch files in your current directory and tell you who
 it is thinking of sending them to. Take a look at the patch files:
 
 .. code-block:: bash
 
-    ./tools/patman/patman -c5 -s1 send -n
+    patman -c5 -s1 send -n
 
 Similar to the above, but skip the first commit and take the next 5. This
 is useful if your top commit is for setting up testing.
 
 
-How to install it
------------------
-
-The most up to date version of patman can be found in the U-Boot sources.
-However to use it on other projects it may be more convenient to install it as
-a standalone application. A distutils installer is included, this can be used
-to install patman:
-
-.. code-block:: bash
-
-    cd tools/patman && python setup.py install
-
-
 How to add tags
 ---------------
 
@@ -1191,17 +1180,16 @@ them:
 
 .. code-block:: bash
 
-    $ tools/patman/patman test
+    $ patman test
 
-Note that since the test suite depends on data files only available in
-the git checkout, the `test` command is hidden unless `patman` is
-invoked from the U-Boot git repository.
+The `test` command is only shown when the test data files are present;
+they ship with the source checkout and the installed package.
 
 Alternatively, you can run the test suite via Pytest:
 
 .. code-block:: bash
 
-    $ cd tools/patman && pytest
+    $ pytest
 
 Error handling doesn't always produce friendly error messages - e.g.
 putting an incorrect tag in a commit may provide a confusing message.

{patch_manager-0.0.8 → patch_manager-0.0.10}/patman/status.py

@@ -191,10 +191,11 @@ def create_branch(series, new_rtag_list, branch, dest_branch, overwrite,
         parent = repo.branches.get(dest_branch)
         cherry = repo.revparse_single('%s~%d' % (branch, count - seq - 1))
 
-        repo.merge_base(cherry.oid, parent.target)
+        repo.merge_base(cherry.id, parent.target)
         base_tree = cherry.parents[0].tree
 
-        index = repo.merge_trees(base_tree, parent, cherry)
+        index = repo.merge_trees(
+            base_tree, repo[parent.target].tree, cherry.tree)
         tree_id = index.write_tree(repo)
 
         lines = []

{patch_manager-0.0.8 → patch_manager-0.0.10}/patman/test_common.py

@@ -177,7 +177,7 @@ better than before''')
         target = repo.revparse_single('HEAD~2')
         # pylint doesn't seem to find this
         # pylint: disable=E1101
-        repo.reset(target.oid, pygit2.enums.ResetMode.HARD)
+        repo.reset(target.id, pygit2.enums.ResetMode.HARD)
         self.make_commit_with_file('video: Some video improvements', '''
 Fix up the video so that
 it looks more purple. Purple is
@@ -247,9 +247,9 @@ and a little more''')
                                  'refs/heads/second')
 
         target = repo.lookup_reference('refs/heads/first')
-        repo.checkout(target, strategy=pygit2.GIT_CHECKOUT_FORCE)
+        repo.checkout(target, strategy=pygit2.enums.CheckoutStrategy.FORCE)
         target = repo.revparse_single('HEAD')
-        repo.reset(target.oid, pygit2.enums.ResetMode.HARD)
+        repo.reset(target.id, pygit2.enums.ResetMode.HARD)
 
         self.assertFalse(gitutil.check_dirty(self.gitdir, self.tmpdir))
         return repo

{patch_manager-0.0.8 → patch_manager-0.0.10}/patman/test_cseries.py

@@ -908,9 +908,9 @@ Tested-by: Mary Smith <msmith@wibble.com>   # yak
 
         repo = pygit2.init_repository(self.gitdir)
         first = repo.lookup_branch('first').peel(
-            pygit2.enums.ObjectType.COMMIT).oid
+            pygit2.enums.ObjectType.COMMIT).id
         base = repo.lookup_branch('base').peel(
-            pygit2.enums.ObjectType.COMMIT).oid
+            pygit2.enums.ObjectType.COMMIT).id
 
         gitutil.checkout('first', self.gitdir, work_tree=self.tmpdir,
                          force=True)
@@ -958,7 +958,7 @@ Tested-by: Mary Smith <msmith@wibble.com>   # yak
         # Check the original series was left alone
         self.assertEqual(
             first, repo.lookup_branch('first').peel(
-                pygit2.enums.ObjectType.COMMIT).oid)
+                pygit2.enums.ObjectType.COMMIT).id)
         count = 2
         series1 = patchstream.get_metadata_for_list('first', self.gitdir,
                                                     count)
@@ -968,7 +968,7 @@ Tested-by: Mary Smith <msmith@wibble.com>   # yak
         # Check that base is left alone
         self.assertEqual(
             base, repo.lookup_branch('base').peel(
-                pygit2.enums.ObjectType.COMMIT).oid)
+                pygit2.enums.ObjectType.COMMIT).id)
         series1 = patchstream.get_metadata_for_list('base', self.gitdir, count)
         self.assertFalse('links' in series1)
         self.assertFalse('version' in series1)
@@ -1534,8 +1534,8 @@ Tested-by: Mary Smith <msmith@wibble.com>   # yak
             # Make sure the branches have been restored
             branch1 = repo.branches['first']
             branch2 = repo.branches['first2']
-            self.assertEqual(expected_commit1.oid, branch1.target)
-            self.assertEqual(expected_commit2.oid, branch2.target)
+            self.assertEqual(expected_commit1.id, branch1.target)
+            self.assertEqual(expected_commit2.id, branch2.target)
 
             # Make sure the tags were deleted
             try:
@@ -1721,7 +1721,7 @@ Tested-by: Mary Smith <msmith@wibble.com>   # yak
         repo = pygit2.init_repository(self.gitdir)
         branch = repo.lookup_branch('first2')
         self.assertTrue(branch)
-        branch_oid = branch.peel(pygit2.enums.ObjectType.COMMIT).oid
+        branch_oid = branch.peel(pygit2.enums.ObjectType.COMMIT).id
 
         pclist = cser.get_pcommit_dict()
         self.assertEqual(4, len(pclist))
@@ -3560,7 +3560,7 @@ Date:   .*
         # Move off the branch and check for a sensible error
         commit = repo.revparse_single('first~')
         repo.checkout_tree(commit)
-        repo.set_head(commit.oid)
+        repo.set_head(commit.id)
 
         with self.assertRaises(ValueError) as exc:
             cser._parse_series_and_version(None, None)
@@ -3701,7 +3701,7 @@ Date:   .*
             'wip: Try out a new thing', 'Just checking', 'wibble.c',
             '''changes to wibble''')
         target = self.repo.revparse_single('HEAD')
-        self.repo.reset(target.oid, pygit2.enums.ResetMode.HARD)
+        self.repo.reset(target.id, pygit2.enums.ResetMode.HARD)
 
         # name = gitutil.get_branch(self.gitdir)
         # upstream_name = gitutil.get_upstream(self.gitdir, name)
@@ -3920,6 +3920,23 @@ Date:   .*
                             show_cover_comments=True)
             self._check_status(out, True, True)
 
+    def test_series_status_gather_archived(self):
+        """status and gather should still work on an archived series"""
+        cser, pwork = self.setup_second()
+        with terminal.capture():
+            cser.archive('second')
+
+        # status reads the patches from the archive tag, since archiving
+        # deletes the branch
+        with terminal.capture() as (out, _):
+            cser.status(pwork, 'second', 2, False)
+        self._check_status(out, False, False)
+
+        # gather works from patchwork and the database, with no branch
+        with terminal.capture() as (out, _):
+            cser.gather(pwork, 'second', 2, False, False, True, dry_run=True)
+        self.assertIn('updated', out.getvalue())
+
     def test_series_status_cmdline(self):
         """Test getting the status of a series, including comments"""
         cser, pwork = self.setup_second()

{patch_manager-0.0.8 → patch_manager-0.0.10}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "patch-manager"
-version = "0.0.8"
+version = "0.0.10"
 authors = [
   { name="Simon Glass", email="sjg@chromium.org" },
 ]