stable-rt-tools 1.5__tar.gz → 2.0__tar.gz

stable_rt_tools-2.0/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.4
+Name: stable-rt-tools
+Version: 2.0
+Summary: Support out of tree patch workflows
+Author-email: Daniel Wagner <dwagner@suse.de>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/igaw/stable-rt-tools
+Project-URL: Documentation, https://stable-rt-tools.readthedocs.io
+Project-URL: Source, https://github.com/igaw/stable-rt-tools.git
+Keywords: Linux,PREEMPT_RT,stable,quilt
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.12
+Description-Content-Type: text/x-rst
+Provides-Extra: test
+Requires-Dist: pytest>=8; extra == "test"
+Provides-Extra: lint
+Requires-Dist: ruff>=0.6; extra == "lint"
+Requires-Dist: mypy>=1.13; extra == "lint"
+Provides-Extra: docs
+Requires-Dist: sphinx>=7; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=2; extra == "docs"
+Requires-Dist: sphinx-argparse>=0.4; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: stable-rt-tools[docs,lint,test]; extra == "dev"
+Requires-Dist: build; extra == "dev"
+
+srt maintains out-of-tree patch series on top of upstream releases, e.g.
+on top of the stable kernel releases. It started as the release tool of the
+stable PREEMPT_RT trees (hence the name) and is used for other patch series
+as well.
+
+See the `stable-rt-tools documentation <https://stable-rt-tools.readthedocs.io>`_ for further details.

stable_rt_tools-2.0/README.rst

@@ -0,0 +1,6 @@
+srt maintains out-of-tree patch series on top of upstream releases, e.g.
+on top of the stable kernel releases. It started as the release tool of the
+stable PREEMPT_RT trees (hence the name) and is used for other patch series
+as well.
+
+See the `stable-rt-tools documentation <https://stable-rt-tools.readthedocs.io>`_ for further details.

stable_rt_tools-2.0/pyproject.toml

@@ -0,0 +1,89 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "stable-rt-tools"
+dynamic = ["version"]
+description = "Support out of tree patch workflows"
+readme = "README.rst"
+license = "MIT"
+requires-python = ">=3.12"
+authors = [{ name = "Daniel Wagner", email = "dwagner@suse.de" }]
+keywords = ["Linux", "PREEMPT_RT", "stable", "quilt"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Build Tools",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = []
+
+[project.optional-dependencies]
+test = ["pytest>=8"]
+lint = ["ruff>=0.6", "mypy>=1.13"]
+docs = ["sphinx>=7", "sphinx-rtd-theme>=2", "sphinx-argparse>=0.4"]
+dev = ["stable-rt-tools[test,lint,docs]", "build"]
+
+[project.scripts]
+srt = "stable_rt_tools.srt:main"
+
+[project.urls]
+Homepage = "https://github.com/igaw/stable-rt-tools"
+Documentation = "https://stable-rt-tools.readthedocs.io"
+Source = "https://github.com/igaw/stable-rt-tools.git"
+
+[tool.setuptools.dynamic]
+version = { attr = "stable_rt_tools.about.__version__" }
+
+[tool.setuptools]
+# only what package-data lists, not everything git or egg-info knows
+include-package-data = false
+
+[tool.setuptools.packages.find]
+include = ["stable_rt_tools"]
+
+[tool.setuptools.package-data]
+stable_rt_tools = ["*.txt", "py.typed"]
+
+[tool.pytest.ini_options]
+testpaths = ["stable_rt_tools/tests"]
+addopts = "-ra"
+
+[tool.ruff]
+line-length = 79
+
+[tool.ruff.lint]
+select = [
+    "E", "W", "F",  # pycodestyle, pyflakes
+    "B",            # bugbear
+    "UP",           # pyupgrade
+    "I",            # import order
+    "SIM", "C4",    # simplifications, comprehensions
+    "RUF",
+]
+ignore = [
+    "RUF005",  # [*a, b] instead of a + [b]
+    "SIM108",  # ternary instead of if/else
+]
+
+[tool.ruff.lint.per-file-ignores]
+# nested mock.patch() blocks read better than one long with statement
+"stable_rt_tools/tests/*" = ["SIM117"]
+
+[tool.mypy]
+files = ["stable_rt_tools"]
+strict = true
+
+[[tool.mypy.overrides]]
+# the tests are checked, but need no annotations
+module = "stable_rt_tools.tests.*"
+disallow_untyped_defs = false
+disallow_incomplete_defs = false
+disallow_untyped_calls = false
+disallow_any_generics = false
+check_untyped_defs = true

stable_rt_tools-1.5/stable_rt_tools/srt_git_filter.py → stable_rt_tools-2.0/stable_rt_tools/about.py

@@ -1,8 +1,6 @@
-#!/usr/bin/env python3
+# stable-rt-tools - support out of tree patch workflows
 #
-# srt - stable rt tooling
-#
-# Copyright (c) Siemens AG, 2018
+# Copyright (c) Daniel Wagner <dwagner@suse.de>
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -20,22 +18,7 @@
 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE
-
-
-import os
-import sys
-
-review_tag = os.environ['SRT_REVIEW_TAG']
-message = sys.stdin.readlines()
-
-msg = """\
-{} stable review patch.
-If anyone has any objections, please let me know.
-
------------
-""".format(review_tag)
+# SOFTWARE.
+"""The stable-rt-tools version, the single source for pyproject.toml."""
 
-print(message[0])
-print(msg)
-print(''.join(message[1:]))
+__version__ = '2.0'

stable_rt_tools-2.0/stable_rt_tools/announce-srt-rc.txt

@@ -0,0 +1,29 @@
+Dear RT Folks,
+
+This is the RT stable review cycle of patch {new_version}.
+
+Please scream at me if I messed something up. Please test the patches
+too.
+
+The -rc release is also available on kernel.org
+
+  https://git.kernel.org/pub/scm/linux/kernel/git/rt/linux-stable-rt.git
+
+on the v{major}.{minor}-rt-next branch.
+
+If all goes well, this patch will be converted to the next main
+release on {release_date}.
+
+Signing key fingerprint:
+
+  {gpg_key_fingerprint}
+
+All keys used for the above files and repositories can be found on the
+following git repository:
+
+   https://git.kernel.org/pub/scm/docs/kernel/pgpkeys.git
+
+Enjoy!
+{name}
+
+Changes from v{old_version}:

stable_rt_tools-2.0/stable_rt_tools/announce-srt.txt

@@ -0,0 +1,39 @@
+From: {sender}
+Subject: [ANNOUNCE] {new_version}
+Date: {date}
+Message-ID: {message_id}
+To: {mail_to}
+
+Hello RT-list!
+
+I'm pleased to announce the {new_version} stable release.
+
+You can get this release via the git tree at:
+
+  https://git.kernel.org/pub/scm/linux/kernel/git/rt/linux-stable-rt.git
+
+  branch: {branch_name}
+  Head SHA1: {branch_head}
+
+Or to build {new_version} directly, the following patches should be applied:
+
+  https://www.kernel.org/pub/linux/kernel/v{major}.x/linux-{major}.{minor}.tar.xz
+
+  https://www.kernel.org/pub/linux/kernel/v{major}.x/patch-{major}.{minor}.{patch}.xz
+
+  https://www.kernel.org{prj_dir}/older/patch-{new_version}.patch.xz
+
+Signing key fingerprint:
+
+  {gpg_key_fingerprint}
+
+All keys used for the above files and repositories can be found on the
+following git repository:
+
+   https://git.kernel.org/pub/scm/docs/kernel/pgpkeys.git
+
+Enjoy!
+{name}
+
+Changes from v{old_version}:
+---

stable_rt_tools-2.0/stable_rt_tools/commit-tmpl.txt

@@ -0,0 +1,34 @@
+[ANNOUNCE] {new_version}
+
+Hello RT-list!
+
+I'm pleased to announce the {new_version} stable release.
+
+Changes since {old_version}:
+
+{series_changes}
+You can get this release via the git tree at:
+
+  https://git.kernel.org/pub/scm/linux/kernel/git/rt/linux-stable-rt.git {release_tag}
+
+  branch: {branch_name}
+
+Or to build {new_version} directly, the following patches should be applied:
+
+  https://www.kernel.org/pub/linux/kernel/v{major}.x/linux-{major}.{minor}.tar.xz
+
+  https://www.kernel.org/pub/linux/kernel/v{major}.x/patch-{major}.{minor}.{patch}.xz
+
+  https://www.kernel.org{prj_dir}/older/patch-{new_version}.patch.xz
+
+Signing key fingerprint:
+
+  {gpg_key_fingerprint}
+
+All keys used for the above files and repositories can be found on the
+following git repository:
+
+   https://git.kernel.org/pub/scm/docs/kernel/pgpkeys.git
+
+Enjoy!
+{name}

{stable_rt_tools-1.5 → stable_rt_tools-2.0}/stable_rt_tools/srt.py

@@ -26,11 +26,24 @@ import argparse
 import logging
 import sys
 
-from stable_rt_tools import (srt_announce, srt_commit, srt_create, srt_push,
-                             srt_sign, srt_tag, srt_upload, srt_patches,
-                             srt_prep, about)
+from stable_rt_tools import (
+    about,
+    srt_announce,
+    srt_commit,
+    srt_create,
+    srt_prep,
+    srt_push,
+    srt_quilt,
+    srt_setup,
+    srt_sign,
+    srt_status,
+    srt_tag,
+    srt_upload,
+)
+from stable_rt_tools.srt_config import convert_config_files
 
 sub_cmd = {
+    'setup': srt_setup,
     'prep': srt_prep,
     'commit': srt_commit,
     'tag': srt_tag,
@@ -39,12 +52,15 @@ sub_cmd = {
     'upload': srt_upload,
     'push': srt_push,
     'announce': srt_announce,
-    'patches': srt_patches,
+    'quilt': srt_quilt,
+    'status': srt_status,
 }
 
 
-def srt_get_argparser():
-    parser = argparse.ArgumentParser(description='srt - stable -rt tool')
+def srt_get_argparser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        description='srt - maintain out-of-tree patch series on top of '
+        'upstream releases')
     parser.add_argument('-d', '--debug',
                         action='store_true',
                         help='Enable debug logging')
@@ -60,11 +76,11 @@ def srt_get_argparser():
     return parser
 
 
-def main():
+def main() -> None:
     parser = srt_get_argparser()
     args = parser.parse_args(sys.argv[1:])
     if args.version:
-        print('stable-rt-tools version {}'.format(about.__version__))
+        print(f'stable-rt-tools version {about.__version__}')
         return
 
     if args.debug:
@@ -72,8 +88,11 @@ def main():
     else:
         logging.getLogger().setLevel(logging.INFO)
 
-    if args.cmd in sub_cmd:
-        sub_cmd[args.cmd].execute(args)
+    if args.cmd not in sub_cmd:
+        parser.print_help(sys.stderr)
+        sys.exit(2)
+    convert_config_files()
+    sub_cmd[args.cmd].execute(args)
 
 
 if __name__ == "__main__":

{stable_rt_tools-1.5 → stable_rt_tools-2.0}/stable_rt_tools/srt_announce.py

@@ -23,24 +23,28 @@
 # SOFTWARE
 
 
-import os
+import argparse
+import re
 from datetime import date, timedelta
 from email.utils import make_msgid
 from time import gmtime, strftime
 
-try:
-    import importlib.resources as pkg_resources
-except ImportError:
-    import importlib_resources as pkg_resources
-
-from stable_rt_tools.srt_util import (check_context, cmd, confirm, get_config,
-                                      get_gpg_fingerprint,
-                                      get_local_branch_name,
-                                      get_remote_branch_name)
+from stable_rt_tools.srt_util import (
+    Config,
+    SubParsers,
+    check_context,
+    cmd,
+    confirm,
+    get_config,
+    get_gpg_fingerprint,
+    get_remote_branch_name,
+    get_suffix,
+    get_template_path,
+)
 from stable_rt_tools.srt_util_context import SrtContext
 
 
-def find_starting_ref(ctx):
+def find_starting_ref(ctx: SrtContext) -> str:
     # find starting point. first check for stable update only
     ref = cmd(['git', 'log', '--pretty=format:%H', '--merges', '-n', '1'])
 
@@ -54,29 +58,36 @@ def find_starting_ref(ctx):
     return ref
 
 
-def create_rc_patches(config, ctx):
-    branch_name = get_local_branch_name()
-    cmd(['git', 'checkout', '-b', 'next-tmp'])
+REVIEW_TEXT = """\
+{tag} stable review patch.
+If anyone has any objections, please let me know.
 
-    srt_env = os.environ.copy()
-    srt_env['SRT_REVIEW_TAG'] = str(ctx.new_tag)
-    srt_env['FILTER_BRANCH_SQUELCH_WARNING'] = str(1)
-    srt_path = os.path.dirname(os.path.realpath(__file__))
+-----------
+
+"""
 
-    ref = find_starting_ref(ctx)
-    cmd(['git', 'filter-branch', '-f', '--msg-filter',
-         srt_path + '/srt_git_filter.py', str(ref) + '..'],
-        env=srt_env)
 
-    cmd(['git', 'format-patch', str(ref) + '..',
-         '-o', ctx.new_dir_mails, '--subject-prefix', 'PATCH RT',
-         '--cover-letter'])
+def add_review_text(path: str, tag: str) -> None:
+    """Put the review note at the top of the body of a patch mail."""
+    with open(path) as f:
+        headers, sep, body = f.read().partition('\n\n')
+    with open(path, 'w') as f:
+        f.write(headers + sep + REVIEW_TEXT.format(tag=tag) + body)
 
-    cmd(['git', 'checkout', branch_name])
-    cmd(['git', 'branch', '-D', 'next-tmp'])
+
+def create_rc_patches(config: Config, ctx: SrtContext) -> None:
+    ref = find_starting_ref(ctx)
+    mails = cmd(['git', 'format-patch', f'{ref}..',
+                 '-o', ctx.new_dir_mails, '--subject-prefix',
+                 f'PATCH {get_suffix(config).upper()}',
+                 '--cover-letter']).splitlines()
+    for mail in mails:
+        if not mail.endswith('/0000-cover-letter.patch'):
+            add_review_text(mail, str(ctx.new_tag))
 
 
-def cover_letter_replacements(config, ctx):
+def cover_letter_replacements(config: Config,
+                              ctx: SrtContext) -> dict[str, object]:
     r = {
         "mail_to": config['MAIL_TO'],
         "major": ctx.new_tag.major,
@@ -88,7 +99,9 @@ def cover_letter_replacements(config, ctx):
         "message_id": make_msgid(),
         "sender": config['SENDER'],
         "name": config['NAME'],
-        "new_tag_rt": ctx.new_tag.rt,
+        # new_tag_rt: the name templates know from before 2.0
+        "new_tag_rt": ctx.new_tag.number,
+        "new_tag_number": ctx.new_tag.number,
         "gpg_key_fingerprint": get_gpg_fingerprint(config),
     }
     if ctx.is_rc:
@@ -96,15 +109,15 @@ def cover_letter_replacements(config, ctx):
     return r
 
 
-def write_rc_cover_letter(config, ctx):
-    with open(ctx.new_dir_mails + '/0000-cover-letter.patch', 'r') as f:
+def write_rc_cover_letter(config: Config, ctx: SrtContext) -> None:
+    with open(ctx.new_dir_mails + '/0000-cover-letter.patch') as f:
         coverletter = f.read()
 
     coverletter = coverletter.replace('*** SUBJECT HERE ***',
                                       'Linux ' + str(ctx.new_tag))
 
     rc_text = ''
-    with open(get_rc_templ_path(config), 'r') as f:
+    with open(get_rc_templ_path(config)) as f:
         rc_text = f.read()
 
     r = cover_letter_replacements(config, ctx)
@@ -122,11 +135,13 @@ def write_rc_cover_letter(config, ctx):
         f.write(coverletter)
 
 
-def send_rc_patches(config, ctx, args):
+def send_rc_patches(config: Config, ctx: SrtContext,
+                    args: argparse.Namespace) -> None:
     gmd = ['git', 'send-email', '--confirm=never']
     if args.suppress_cc:
         gmd += ['--suppress-cc=all']
-    gmd += ['--to="{}"'.format(t) for t in config['MAIL_TO'].split(',')]
+    # an argument list, no shell: quotes would end up in the address
+    gmd += [f'--to={t.strip()}' for t in config['MAIL_TO'].split(',')]
     gmd += [ctx.new_dir_mails]
 
     print('Dry run')
@@ -137,32 +152,33 @@ def send_rc_patches(config, ctx, args):
         cmd(gmd)
 
 
-def announce_rc(config, ctx, args):
+def announce_rc(config: Config, ctx: SrtContext,
+                args: argparse.Namespace) -> None:
     create_rc_patches(config, ctx)
     write_rc_cover_letter(config, ctx)
     send_rc_patches(config, ctx, args)
 
 
-def get_announce_tmpl_path(config):
-    if 'ANNOUNCE' in config:
-        return config['ANNOUNCE']
+def get_announce_tmpl_path(config: Config) -> str:
+    return get_template_path(config, 'ANNOUNCE', 'announce-srt.txt')
 
-    # Use importlib.resources.files for modern resource access
-    return str(
-        pkg_resources.files('stable_rt_tools').joinpath('announce-srt.txt')
-    )
 
+def get_rc_templ_path(config: Config) -> str:
+    return get_template_path(config, 'RC_TEXT', 'announce-srt-rc.txt')
 
-def get_rc_templ_path(config):
-    if 'RC_TEXT' in config:
-        return config['RC_TEXT']
 
-    return str(
-        pkg_resources.files('stable_rt_tools').joinpath('announce-srt-rc.txt')
-    )
+def strip_trailers(msg: str) -> str:
+    """Remove the trailer block (Signed-off-by: ...) of a commit message."""
+    paragraphs = msg.rstrip().split('\n\n')
+    last = paragraphs[-1].splitlines()
+    if len(paragraphs) > 1 and all(
+            re.match(r'^[A-Za-z][A-Za-z0-9-]*: ', line) for line in last):
+        paragraphs = paragraphs[:-1]
+    return '\n\n'.join(paragraphs)
 
 
-def announce(config, ctx, args):
+def announce(config: Config, ctx: SrtContext,
+             args: argparse.Namespace) -> None:
     from stable_rt_tools.srt_util import is_quilt_workflow
     if ctx.is_rc:
         announce_rc(config, ctx, args)
@@ -181,6 +197,7 @@ def announce(config, ctx, args):
                 msg = '\n'.join(lines[1:]).lstrip('\n')
             else:
                 pass
+            msg = strip_trailers(msg)
             timestamp = strftime('%a, %d %b %Y %H:%M:%S -0000', gmtime())
             sender = config.get('SENDER', '')
             mail_to = config.get('MAIL_TO', '')
@@ -198,7 +215,7 @@ def announce(config, ctx, args):
     timestamp = strftime('%a, %d %b %Y %H:%M:%S -0000', gmtime())
 
     stable_rt_text = ''
-    with open(get_announce_tmpl_path(config), 'r') as f:
+    with open(get_announce_tmpl_path(config)) as f:
         stable_rt_text = f.read()
 
     r = cover_letter_replacements(config, ctx)
@@ -210,21 +227,19 @@ def announce(config, ctx, args):
     print(stable_rt_text.format(**r))
 
     ref = find_starting_ref(ctx)
-    print(cmd(['git', '--no-pager', 'shortlog', '{0}..{1}'.
-               format(ref, ctx.new_tag)]))
+    print(cmd(['git', '--no-pager', 'shortlog', f'{ref}..{ctx.new_tag}']))
 
     print('---')
 
-    print(cmd(['git', '--no-pager', 'diff', '--stat', '{0}..{1}'.
-               format(ref, ctx.new_tag)]))
+    print(cmd(['git', '--no-pager', 'diff', '--stat',
+               f'{ref}..{ctx.new_tag}']))
 
     print('---')
 
-    print(cmd(['git', '--no-pager', 'diff', '{0}..{1}'.
-               format(ref, ctx.new_tag)]))
+    print(cmd(['git', '--no-pager', 'diff', f'{ref}..{ctx.new_tag}']))
 
 
-def add_argparser(parser):
+def add_argparser(parser: SubParsers) -> argparse.ArgumentParser:
     prs = parser.add_parser('announce')
     prs.add_argument('OLD_TAG', nargs='?')
     prs.add_argument('NEW_TAG', nargs='?')
@@ -233,7 +248,7 @@ def add_argparser(parser):
     return prs
 
 
-def execute(args):
+def execute(args: argparse.Namespace) -> None:
     ctx = SrtContext(args)
     check_context(ctx)