public inbox for u-boot@lists.denx.de
 help / color / mirror / Atom feed
* [PATCH 0/6] patman: Small fixes plus remove --no-tree from checkpatch for linux
@ 2022-06-30 21:08 Douglas Anderson
  2022-06-30 21:08 ` [PATCH 1/6] patman: Fix updating argument defaults from settings Douglas Anderson
                   ` (6 more replies)
  0 siblings, 7 replies; 10+ messages in thread
From: Douglas Anderson @ 2022-06-30 21:08 UTC (permalink / raw)
  To: sjg; +Cc: briannorris, amstan, mka, Douglas Anderson, u-boot

The whole point of this series is really to make it so that when we're
using patman for sending Linux patches that we don't pass "--no-tree"
to checkpatch. While doing that, though, I found a number of bugs
including an explanation about why recent version of patman have been
yelling about "tags" when used with Linux even though Linux is
supposed to have "process_tags" defaulted to False.


Douglas Anderson (6):
  patman: Fix updating argument defaults from settings
  patman: Fix implicit command inserting
  patman: Don't look at sys.argv when parsing settings
  patman: Make most bool arguments BooleanOptionalAction
  patman: By default don't pass "--no-tree" to checkpatch for linux
  patman: Take project defaults into account for --help

 tools/patman/checkpatch.py | 11 +++---
 tools/patman/control.py    |  7 ++--
 tools/patman/main.py       | 72 ++++++++++++++++++++++----------------
 tools/patman/settings.py   | 46 +++++++++++++-----------
 4 files changed, 78 insertions(+), 58 deletions(-)

-- 
2.37.0.rc0.161.g10f37bed90-goog


^ permalink raw reply	[flat|nested] 10+ messages in thread

* [PATCH 1/6] patman: Fix updating argument defaults from settings
  2022-06-30 21:08 [PATCH 0/6] patman: Small fixes plus remove --no-tree from checkpatch for linux Douglas Anderson
@ 2022-06-30 21:08 ` Douglas Anderson
  2022-06-30 21:08 ` [PATCH 2/6] patman: Fix implicit command inserting Douglas Anderson
                   ` (5 subsequent siblings)
  6 siblings, 0 replies; 10+ messages in thread
From: Douglas Anderson @ 2022-06-30 21:08 UTC (permalink / raw)
  To: sjg; +Cc: briannorris, amstan, mka, Douglas Anderson, u-boot

Ever since commit 4600767d294d ("patman: Refactor how the default
subcommand works"), when I use patman on the Linux tree I get grumbles
about unknown tags. This is because the Linux default making
process_tags be False wasn't working anymore.

It appears that the comment claiming that the defaults propagates
through all subparsers no longer works for some reason.

We're already looking at all the subparsers anyway. Let's just update
each one.

Fixes: 4600767d294d ("patman: Refactor how the default subcommand works")
Signed-off-by: Douglas Anderson <dianders@chromium.org>
---

 tools/patman/settings.py | 41 +++++++++++++++++++++-------------------
 1 file changed, 22 insertions(+), 19 deletions(-)

diff --git a/tools/patman/settings.py b/tools/patman/settings.py
index 7c2b5c196c06..5eefe3d1f55e 100644
--- a/tools/patman/settings.py
+++ b/tools/patman/settings.py
@@ -244,28 +244,31 @@ def _UpdateDefaults(main_parser, config):
                   if isinstance(action, argparse._SubParsersAction)
                   for _, subparser in action.choices.items()]
 
+    unknown_settings = set(name for name, val in config.items('settings'))
+
     # Collect the defaults from each parser
-    defaults = {}
     for parser in parsers:
         pdefs = parser.parse_known_args()[0]
-        defaults.update(vars(pdefs))
-
-    # Go through the settings and collect defaults
-    for name, val in config.items('settings'):
-        if name in defaults:
-            default_val = defaults[name]
-            if isinstance(default_val, bool):
-                val = config.getboolean('settings', name)
-            elif isinstance(default_val, int):
-                val = config.getint('settings', name)
-            elif isinstance(default_val, str):
-                val = config.get('settings', name)
-            defaults[name] = val
-        else:
-            print("WARNING: Unknown setting %s" % name)
-
-    # Set all the defaults (this propagates through all subparsers)
-    main_parser.set_defaults(**defaults)
+        defaults = dict(vars(pdefs))
+
+        # Go through the settings and collect defaults
+        for name, val in config.items('settings'):
+            if name in defaults:
+                default_val = defaults[name]
+                if isinstance(default_val, bool):
+                    val = config.getboolean('settings', name)
+                elif isinstance(default_val, int):
+                    val = config.getint('settings', name)
+                elif isinstance(default_val, str):
+                    val = config.get('settings', name)
+                defaults[name] = val
+                unknown_settings.discard(name)
+
+        # Set all the defaults
+        parser.set_defaults(**defaults)
+
+    for name in sorted(unknown_settings):
+        print("WARNING: Unknown setting %s" % name)
 
 def _ReadAliasFile(fname):
     """Read in the U-Boot git alias file if it exists.
-- 
2.37.0.rc0.161.g10f37bed90-goog


^ permalink raw reply related	[flat|nested] 10+ messages in thread

* [PATCH 2/6] patman: Fix implicit command inserting
  2022-06-30 21:08 [PATCH 0/6] patman: Small fixes plus remove --no-tree from checkpatch for linux Douglas Anderson
  2022-06-30 21:08 ` [PATCH 1/6] patman: Fix updating argument defaults from settings Douglas Anderson
@ 2022-06-30 21:08 ` Douglas Anderson
  2022-06-30 21:08 ` [PATCH 3/6] patman: Don't look at sys.argv when parsing settings Douglas Anderson
                   ` (4 subsequent siblings)
  6 siblings, 0 replies; 10+ messages in thread
From: Douglas Anderson @ 2022-06-30 21:08 UTC (permalink / raw)
  To: sjg; +Cc: briannorris, amstan, mka, Douglas Anderson, u-boot

The logic to insert an implicit command has always been a bit broken
but it was masked by another bug fixed in the patch ("patman: Don't
look at sys.argv when parsing settings"). Specifically, imagine that
you're just calling patman like this:

  patman -c1

After the parse_known_args() command then the "-c1" will have been
parsed and we'll have no command. The "rest" variable will be an empty
list. Going into the logic you can see that nargs = 0. The implicit
insertion of send ideally would create an argument list of:
  ['-c1', 'send']
...but it doesn't because argv[:-0] is the same as argv[:0] and that's
an empty list.

Let's fix this little glitch.

Signed-off-by: Douglas Anderson <dianders@chromium.org>
---

 tools/patman/main.py | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/tools/patman/main.py b/tools/patman/main.py
index 2a2ac4570931..336f4e439aa9 100755
--- a/tools/patman/main.py
+++ b/tools/patman/main.py
@@ -120,7 +120,9 @@ else:
     # No command, so insert it after the known arguments and before the ones
     # that presumably relate to the 'send' subcommand
     nargs = len(rest)
-    argv = argv[:-nargs] + ['send'] + rest
+    if nargs:
+        argv = argv[:-nargs]
+    argv = argv + ['send'] + rest
     args = parser.parse_args(argv)
 
 if __name__ != "__main__":
-- 
2.37.0.rc0.161.g10f37bed90-goog


^ permalink raw reply related	[flat|nested] 10+ messages in thread

* [PATCH 3/6] patman: Don't look at sys.argv when parsing settings
  2022-06-30 21:08 [PATCH 0/6] patman: Small fixes plus remove --no-tree from checkpatch for linux Douglas Anderson
  2022-06-30 21:08 ` [PATCH 1/6] patman: Fix updating argument defaults from settings Douglas Anderson
  2022-06-30 21:08 ` [PATCH 2/6] patman: Fix implicit command inserting Douglas Anderson
@ 2022-06-30 21:08 ` Douglas Anderson
  2022-06-30 21:08 ` [PATCH 4/6] patman: Make most bool arguments BooleanOptionalAction Douglas Anderson
                   ` (3 subsequent siblings)
  6 siblings, 0 replies; 10+ messages in thread
From: Douglas Anderson @ 2022-06-30 21:08 UTC (permalink / raw)
  To: sjg; +Cc: briannorris, amstan, mka, Douglas Anderson, u-boot

If you call the parser and tell it to parse but don't pass arguments
in then it will default to looking at sys.argv. This isn't really what
was intended and seems to have some side effects. Let's not do it.

NOTE: to see some of the side effects, note that this patch breaks
"patman -c1" if you don't have the patch ("patman: Fix implicit
command inserting") before it.

Signed-off-by: Douglas Anderson <dianders@chromium.org>
---

 tools/patman/settings.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tools/patman/settings.py b/tools/patman/settings.py
index 5eefe3d1f55e..92d82d5e8682 100644
--- a/tools/patman/settings.py
+++ b/tools/patman/settings.py
@@ -248,7 +248,7 @@ def _UpdateDefaults(main_parser, config):
 
     # Collect the defaults from each parser
     for parser in parsers:
-        pdefs = parser.parse_known_args()[0]
+        pdefs = parser.parse_known_args([])[0]
         defaults = dict(vars(pdefs))
 
         # Go through the settings and collect defaults
-- 
2.37.0.rc0.161.g10f37bed90-goog


^ permalink raw reply related	[flat|nested] 10+ messages in thread

* [PATCH 4/6] patman: Make most bool arguments BooleanOptionalAction
  2022-06-30 21:08 [PATCH 0/6] patman: Small fixes plus remove --no-tree from checkpatch for linux Douglas Anderson
                   ` (2 preceding siblings ...)
  2022-06-30 21:08 ` [PATCH 3/6] patman: Don't look at sys.argv when parsing settings Douglas Anderson
@ 2022-06-30 21:08 ` Douglas Anderson
  2022-06-30 21:30   ` Brian Norris
  2022-06-30 21:08 ` [PATCH 5/6] patman: By default don't pass "--no-tree" to checkpatch for linux Douglas Anderson
                   ` (2 subsequent siblings)
  6 siblings, 1 reply; 10+ messages in thread
From: Douglas Anderson @ 2022-06-30 21:08 UTC (permalink / raw)
  To: sjg; +Cc: briannorris, amstan, mka, Douglas Anderson, u-boot

For boolean arguments it's convenient to be able to specify both the
argument and its opposite on the command line. This is especially
convenient because you can change the default via the settings file
and being able express the opposite can be the only way to override
things.

Luckily python handles this well--we just need to specify things with
BooleanOptionalAction. We'll do that for all options except
"full-help" (where it feels silly). This uglifies the help text a
little bit but does give maximum flexibility.

Signed-off-by: Douglas Anderson <dianders@chromium.org>
---

 tools/patman/main.py | 52 +++++++++++++++++++++++---------------------
 1 file changed, 27 insertions(+), 25 deletions(-)

diff --git a/tools/patman/main.py b/tools/patman/main.py
index 336f4e439aa9..9684300c022c 100755
--- a/tools/patman/main.py
+++ b/tools/patman/main.py
@@ -6,7 +6,7 @@
 
 """See README for more information"""
 
-from argparse import ArgumentParser
+from argparse import ArgumentParser, BooleanOptionalAction
 import os
 import re
 import shutil
@@ -40,7 +40,7 @@ parser.add_argument('-c', '--count', dest='count', type=int,
     default=-1, help='Automatically create patches from top n commits')
 parser.add_argument('-e', '--end', type=int, default=0,
     help='Commits to skip at end of patch list')
-parser.add_argument('-D', '--debug', action='store_true',
+parser.add_argument('-D', '--debug', action=BooleanOptionalAction,
     help='Enabling debugging (provides a full traceback on error)')
 parser.add_argument('-p', '--project', default=project.detect_project(),
                     help="Project name; affects default option values and "
@@ -50,42 +50,44 @@ parser.add_argument('-P', '--patchwork-url',
                     help='URL of patchwork server [default: %(default)s]')
 parser.add_argument('-s', '--start', dest='start', type=int,
     default=0, help='Commit to start creating patches from (0 = HEAD)')
-parser.add_argument('-v', '--verbose', action='store_true', dest='verbose',
-                    default=False, help='Verbose output of errors and warnings')
+parser.add_argument('-v', '--verbose', action=BooleanOptionalAction,
+                    dest='verbose', default=False,
+                    help='Verbose output of errors and warnings')
 parser.add_argument('-H', '--full-help', action='store_true', dest='full_help',
                     default=False, help='Display the README file')
 
 subparsers = parser.add_subparsers(dest='cmd')
 send = subparsers.add_parser('send')
-send.add_argument('-i', '--ignore-errors', action='store_true',
-       dest='ignore_errors', default=False,
-       help='Send patches email even if patch errors are found')
+send.add_argument('-i', '--ignore-errors', action=BooleanOptionalAction,
+                  dest='ignore_errors', default=False,
+                  help='Send patches email even if patch errors are found')
 send.add_argument('-l', '--limit-cc', dest='limit', type=int, default=None,
        help='Limit the cc list to LIMIT entries [default: %(default)s]')
-send.add_argument('-m', '--no-maintainers', action='store_false',
-       dest='add_maintainers', default=True,
-       help="Don't cc the file maintainers automatically")
-send.add_argument('-n', '--dry-run', action='store_true', dest='dry_run',
-       default=False, help="Do a dry run (create but don't email patches)")
+send.add_argument('-m', '--maintainers', action=BooleanOptionalAction,
+                  dest='add_maintainers', default=True,
+                  help="cc the file maintainers automatically")
+send.add_argument('-n', '--dry-run', action=BooleanOptionalAction,
+                  dest='dry_run', default=False,
+                  help="Do a dry run (create but don't email patches)")
 send.add_argument('-r', '--in-reply-to', type=str, action='store',
                   help="Message ID that this series is in reply to")
-send.add_argument('-t', '--ignore-bad-tags', action='store_true',
+send.add_argument('-t', '--ignore-bad-tags', action=BooleanOptionalAction,
                   default=False,
                   help='Ignore bad tags / aliases (default=warn)')
-send.add_argument('-T', '--thread', action='store_true', dest='thread',
+send.add_argument('-T', '--thread', action=BooleanOptionalAction, dest='thread',
                   default=False, help='Create patches as a single thread')
 send.add_argument('--cc-cmd', dest='cc_cmd', type=str, action='store',
        default=None, help='Output cc list for patch file (used by git)')
-send.add_argument('--no-binary', action='store_true', dest='ignore_binary',
-                  default=False,
-                  help="Do not output contents of changes in binary files")
-send.add_argument('--no-check', action='store_false', dest='check_patch',
+send.add_argument('--binary', action=BooleanOptionalAction,
+                  dest='ignore_binary', default=False,
+                  help="Output contents of changes in binary files")
+send.add_argument('--check', action=BooleanOptionalAction, dest='check_patch',
                   default=True,
-                  help="Don't check for patch compliance")
-send.add_argument('--no-tags', action='store_false', dest='process_tags',
-                  default=True, help="Don't process subject tags as aliases")
-send.add_argument('--no-signoff', action='store_false', dest='add_signoff',
-                  default=True, help="Don't add Signed-off-by to patches")
+                  help="Check for patch compliance")
+send.add_argument('--tags', action=BooleanOptionalAction, dest='process_tags',
+                  default=True, help="Process subject tags as aliases")
+send.add_argument('--signoff', action=BooleanOptionalAction, dest='add_signoff',
+                  default=True, help="Add Signed-off-by to patches")
 send.add_argument('--smtp-server', type=str,
                   help="Specify the SMTP server to 'git send-email'")
 
@@ -97,11 +99,11 @@ test_parser.add_argument('testname', type=str, default=None, nargs='?',
 
 status = subparsers.add_parser('status',
                                help='Check status of patches in patchwork')
-status.add_argument('-C', '--show-comments', action='store_true',
+status.add_argument('-C', '--show-comments', action=BooleanOptionalAction,
                     help='Show comments from each patch')
 status.add_argument('-d', '--dest-branch', type=str,
                     help='Name of branch to create with collected responses')
-status.add_argument('-f', '--force', action='store_true',
+status.add_argument('-f', '--force', action=BooleanOptionalAction,
                     help='Force overwriting an existing branch')
 
 # Parse options twice: first to get the project and second to handle
-- 
2.37.0.rc0.161.g10f37bed90-goog


^ permalink raw reply related	[flat|nested] 10+ messages in thread

* [PATCH 5/6] patman: By default don't pass "--no-tree" to checkpatch for linux
  2022-06-30 21:08 [PATCH 0/6] patman: Small fixes plus remove --no-tree from checkpatch for linux Douglas Anderson
                   ` (3 preceding siblings ...)
  2022-06-30 21:08 ` [PATCH 4/6] patman: Make most bool arguments BooleanOptionalAction Douglas Anderson
@ 2022-06-30 21:08 ` Douglas Anderson
  2022-06-30 21:08 ` [PATCH 6/6] patman: Take project defaults into account for --help Douglas Anderson
  2022-06-30 22:18 ` [PATCH 0/6] patman: Small fixes plus remove --no-tree from checkpatch for linux Brian Norris
  6 siblings, 0 replies; 10+ messages in thread
From: Douglas Anderson @ 2022-06-30 21:08 UTC (permalink / raw)
  To: sjg; +Cc: briannorris, amstan, mka, Douglas Anderson, u-boot

When you pass "--no-tree" to checkpatch it disables some extra checks
that are important for Linux. Specifically I want checks like:

  warning: DT compatible string "boogie,woogie" appears un-documented
  check ./Documentation/devicetree/bindings/

Let's make the default for Linux to _not_ pass --no-tree. We'll have a
config option and command line flag to override.

Signed-off-by: Douglas Anderson <dianders@chromium.org>
---

 tools/patman/checkpatch.py | 11 +++++++----
 tools/patman/control.py    |  7 ++++---
 tools/patman/main.py       |  3 +++
 tools/patman/settings.py   |  3 ++-
 4 files changed, 16 insertions(+), 8 deletions(-)

diff --git a/tools/patman/checkpatch.py b/tools/patman/checkpatch.py
index 70ba561c2686..d1b902dd9627 100644
--- a/tools/patman/checkpatch.py
+++ b/tools/patman/checkpatch.py
@@ -186,7 +186,7 @@ def check_patch_parse(checkpatch_output, verbose=False):
     return result
 
 
-def check_patch(fname, verbose=False, show_types=False):
+def check_patch(fname, verbose=False, show_types=False, use_tree=False):
     """Run checkpatch.pl on a file and parse the results.
 
     Args:
@@ -194,6 +194,7 @@ def check_patch(fname, verbose=False, show_types=False):
         verbose: True to print out every line of the checkpatch output as it is
             parsed
         show_types: Tell checkpatch to show the type (number) of each message
+        use_tree (bool): If False we'll pass '--no-tree' to checkpatch.
 
     Returns:
         namedtuple containing:
@@ -210,7 +211,9 @@ def check_patch(fname, verbose=False, show_types=False):
             stdout: Full output of checkpatch
     """
     chk = find_check_patch()
-    args = [chk, '--no-tree']
+    args = [chk]
+    if not use_tree:
+        args.append('--no-tree')
     if show_types:
         args.append('--show-types')
     output = command.output(*args, fname, raise_on_error=False)
@@ -236,13 +239,13 @@ def get_warning_msg(col, msg_type, fname, line, msg):
     line_str = '' if line is None else '%d' % line
     return '%s:%s: %s: %s\n' % (fname, line_str, msg_type, msg)
 
-def check_patches(verbose, args):
+def check_patches(verbose, args, use_tree):
     '''Run the checkpatch.pl script on each patch'''
     error_count, warning_count, check_count = 0, 0, 0
     col = terminal.Color()
 
     for fname in args:
-        result = check_patch(fname, verbose)
+        result = check_patch(fname, verbose, use_tree=use_tree)
         if not result.ok:
             error_count += result.errors
             warning_count += result.warnings
diff --git a/tools/patman/control.py b/tools/patman/control.py
index b40382388e07..bf426cf7bcf4 100644
--- a/tools/patman/control.py
+++ b/tools/patman/control.py
@@ -64,7 +64,7 @@ def prepare_patches(col, branch, count, start, end, ignore_binary, signoff):
         patchstream.insert_cover_letter(cover_fname, series, to_do)
     return series, cover_fname, patch_files
 
-def check_patches(series, patch_files, run_checkpatch, verbose):
+def check_patches(series, patch_files, run_checkpatch, verbose, use_tree):
     """Run some checks on a set of patches
 
     This santiy-checks the patman tags like Series-version and runs the patches
@@ -77,6 +77,7 @@ def check_patches(series, patch_files, run_checkpatch, verbose):
         run_checkpatch (bool): True to run checkpatch.pl
         verbose (bool): True to print out every line of the checkpatch output as
             it is parsed
+        use_tree (bool): If False we'll pass '--no-tree' to checkpatch.
 
     Returns:
         bool: True if the patches had no errors, False if they did
@@ -86,7 +87,7 @@ def check_patches(series, patch_files, run_checkpatch, verbose):
 
     # Check the patches, and run them through 'git am' just to be sure
     if run_checkpatch:
-        ok = checkpatch.check_patches(verbose, patch_files)
+        ok = checkpatch.check_patches(verbose, patch_files, use_tree)
     else:
         ok = True
     return ok
@@ -165,7 +166,7 @@ def send(args):
         col, args.branch, args.count, args.start, args.end,
         args.ignore_binary, args.add_signoff)
     ok = check_patches(series, patch_files, args.check_patch,
-                       args.verbose)
+                       args.verbose, args.check_patch_use_tree)
 
     ok = ok and gitutil.check_suppress_cc_config()
 
diff --git a/tools/patman/main.py b/tools/patman/main.py
index 9684300c022c..1ee44feab192 100755
--- a/tools/patman/main.py
+++ b/tools/patman/main.py
@@ -84,6 +84,9 @@ send.add_argument('--binary', action=BooleanOptionalAction,
 send.add_argument('--check', action=BooleanOptionalAction, dest='check_patch',
                   default=True,
                   help="Check for patch compliance")
+send.add_argument('--tree', action=BooleanOptionalAction,
+                  dest='check_patch_use_tree', default=False,
+                  help="If False, pass '--no-tree' to checkpatch")
 send.add_argument('--tags', action=BooleanOptionalAction, dest='process_tags',
                   default=True, help="Process subject tags as aliases")
 send.add_argument('--signoff', action=BooleanOptionalAction, dest='add_signoff',
diff --git a/tools/patman/settings.py b/tools/patman/settings.py
index 92d82d5e8682..bbf271066cec 100644
--- a/tools/patman/settings.py
+++ b/tools/patman/settings.py
@@ -23,6 +23,7 @@ _default_settings = {
     "u-boot": {},
     "linux": {
         "process_tags": "False",
+        "check_patch_use_tree": "True",
     },
     "gcc": {
         "process_tags": "False",
@@ -71,7 +72,7 @@ class _ProjectConfigParser(ConfigParser.SafeConfigParser):
     >>> config = _ProjectConfigParser("linux")
     >>> config.readfp(StringIO(sample_config))
     >>> sorted((str(a), str(b)) for (a, b) in config.items("settings"))
-    [('am_hero', 'True'), ('process_tags', 'False')]
+    [('am_hero', 'True'), ('check_patch_use_tree', 'True'), ('process_tags', 'False')]
 
     # Check to make sure that settings works with unknown project.
     >>> config = _ProjectConfigParser("unknown")
-- 
2.37.0.rc0.161.g10f37bed90-goog


^ permalink raw reply related	[flat|nested] 10+ messages in thread

* [PATCH 6/6] patman: Take project defaults into account for --help
  2022-06-30 21:08 [PATCH 0/6] patman: Small fixes plus remove --no-tree from checkpatch for linux Douglas Anderson
                   ` (4 preceding siblings ...)
  2022-06-30 21:08 ` [PATCH 5/6] patman: By default don't pass "--no-tree" to checkpatch for linux Douglas Anderson
@ 2022-06-30 21:08 ` Douglas Anderson
  2022-06-30 22:15   ` Brian Norris
  2022-06-30 22:18 ` [PATCH 0/6] patman: Small fixes plus remove --no-tree from checkpatch for linux Brian Norris
  6 siblings, 1 reply; 10+ messages in thread
From: Douglas Anderson @ 2022-06-30 21:08 UTC (permalink / raw)
  To: sjg; +Cc: briannorris, amstan, mka, Douglas Anderson, u-boot

I'd like it so that when you do "patman send --help" and you're using
Linux that it show it the proper defaults for Linux.

Signed-off-by: Douglas Anderson <dianders@chromium.org>
---

 tools/patman/main.py | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/tools/patman/main.py b/tools/patman/main.py
index 1ee44feab192..a0b0ad3bad9d 100755
--- a/tools/patman/main.py
+++ b/tools/patman/main.py
@@ -109,14 +109,19 @@ status.add_argument('-d', '--dest-branch', type=str,
 status.add_argument('-f', '--force', action=BooleanOptionalAction,
                     help='Force overwriting an existing branch')
 
-# Parse options twice: first to get the project and second to handle
-# defaults properly (which depends on project)
+# Parse options several times:
+# - first to get the project and second to handle defaults properly (which
+#   depends on project).
+# - second to handle --help after we've accounted for project defaults.
+# - finally after we have added an implicit command if necessary.
+#
 # Use parse_known_args() in case 'cmd' is omitted
+argv = [arg for arg in sys.argv[1:] if arg not in ('-h', '--help')]
+args, _ = parser.parse_known_args(argv)
 argv = sys.argv[1:]
-args, rest = parser.parse_known_args(argv)
 if hasattr(args, 'project'):
     settings.Setup(gitutil, parser, args.project, '')
-    args, rest = parser.parse_known_args(argv)
+args, rest = parser.parse_known_args(argv)
 
 # If we have a command, it is safe to parse all arguments
 if args.cmd:
-- 
2.37.0.rc0.161.g10f37bed90-goog


^ permalink raw reply related	[flat|nested] 10+ messages in thread

* Re: [PATCH 4/6] patman: Make most bool arguments BooleanOptionalAction
  2022-06-30 21:08 ` [PATCH 4/6] patman: Make most bool arguments BooleanOptionalAction Douglas Anderson
@ 2022-06-30 21:30   ` Brian Norris
  0 siblings, 0 replies; 10+ messages in thread
From: Brian Norris @ 2022-06-30 21:30 UTC (permalink / raw)
  To: Douglas Anderson; +Cc: sjg, amstan, mka, u-boot

On Thu, Jun 30, 2022 at 02:08:07PM -0700, Doug Anderson wrote:
> For boolean arguments it's convenient to be able to specify both the
> argument and its opposite on the command line. This is especially
> convenient because you can change the default via the settings file
> and being able express the opposite can be the only way to override
> things.
> 
> Luckily python handles this well--we just need to specify things with
> BooleanOptionalAction. We'll do that for all options except
> "full-help" (where it feels silly). This uglifies the help text a
> little bit but does give maximum flexibility.
> 
> Signed-off-by: Douglas Anderson <dianders@chromium.org>
> ---
> 
>  tools/patman/main.py | 52 +++++++++++++++++++++++---------------------
>  1 file changed, 27 insertions(+), 25 deletions(-)
> 
> diff --git a/tools/patman/main.py b/tools/patman/main.py
> index 336f4e439aa9..9684300c022c 100755
> --- a/tools/patman/main.py
> +++ b/tools/patman/main.py

> -send.add_argument('-t', '--ignore-bad-tags', action='store_true',
> +send.add_argument('-t', '--ignore-bad-tags', action=BooleanOptionalAction,
>                    default=False,
>                    help='Ignore bad tags / aliases (default=warn)')

I know you mentioned --help ugliness, but this one ends up looking like:

  (default=warn) (default: False)

Perhaps we should drop the baked-in "(default=warn)" text?

Otherwise:

Reviewed-by: Brian Norris <briannorris@chromium.org>
Tested-by: Brian Norris <briannorris@chromium.org>

^ permalink raw reply	[flat|nested] 10+ messages in thread

* Re: [PATCH 6/6] patman: Take project defaults into account for --help
  2022-06-30 21:08 ` [PATCH 6/6] patman: Take project defaults into account for --help Douglas Anderson
@ 2022-06-30 22:15   ` Brian Norris
  0 siblings, 0 replies; 10+ messages in thread
From: Brian Norris @ 2022-06-30 22:15 UTC (permalink / raw)
  To: Douglas Anderson; +Cc: sjg, amstan, mka, u-boot

On Thu, Jun 30, 2022 at 02:08:09PM -0700, Doug Anderson wrote:
> I'd like it so that when you do "patman send --help" and you're using
> Linux that it show it the proper defaults for Linux.
> 
> Signed-off-by: Douglas Anderson <dianders@chromium.org>
> ---
> 
>  tools/patman/main.py | 13 +++++++++----
>  1 file changed, 9 insertions(+), 4 deletions(-)
> 
> diff --git a/tools/patman/main.py b/tools/patman/main.py
> index 1ee44feab192..a0b0ad3bad9d 100755
> --- a/tools/patman/main.py
> +++ b/tools/patman/main.py
> @@ -109,14 +109,19 @@ status.add_argument('-d', '--dest-branch', type=str,
>  status.add_argument('-f', '--force', action=BooleanOptionalAction,
>                      help='Force overwriting an existing branch')
>  
> -# Parse options twice: first to get the project and second to handle
> -# defaults properly (which depends on project)
> +# Parse options several times:
> +# - first to get the project and second to handle defaults properly (which
> +#   depends on project).
> +# - second to handle --help after we've accounted for project defaults.

The previous bullet has a "second", and so does this one. Are those
different meanings, or are we counting wrong?

This might be a good place to say that this multiple passes on argparse
is very confusing to me. That's not to say that you need to explain it
for me, but just to say I'm probably not the best reviewer on this one.

Brian

> +# - finally after we have added an implicit command if necessary.
> +#
>  # Use parse_known_args() in case 'cmd' is omitted
> +argv = [arg for arg in sys.argv[1:] if arg not in ('-h', '--help')]
> +args, _ = parser.parse_known_args(argv)
>  argv = sys.argv[1:]
> -args, rest = parser.parse_known_args(argv)
>  if hasattr(args, 'project'):
>      settings.Setup(gitutil, parser, args.project, '')
> -    args, rest = parser.parse_known_args(argv)
> +args, rest = parser.parse_known_args(argv)
>  
>  # If we have a command, it is safe to parse all arguments
>  if args.cmd:
> -- 
> 2.37.0.rc0.161.g10f37bed90-goog
> 

^ permalink raw reply	[flat|nested] 10+ messages in thread

* Re: [PATCH 0/6] patman: Small fixes plus remove --no-tree from checkpatch for linux
  2022-06-30 21:08 [PATCH 0/6] patman: Small fixes plus remove --no-tree from checkpatch for linux Douglas Anderson
                   ` (5 preceding siblings ...)
  2022-06-30 21:08 ` [PATCH 6/6] patman: Take project defaults into account for --help Douglas Anderson
@ 2022-06-30 22:18 ` Brian Norris
  6 siblings, 0 replies; 10+ messages in thread
From: Brian Norris @ 2022-06-30 22:18 UTC (permalink / raw)
  To: Douglas Anderson; +Cc: sjg, amstan, mka, u-boot

On Thu, Jun 30, 2022 at 02:08:03PM -0700, Doug Anderson wrote:
> The whole point of this series is really to make it so that when we're
> using patman for sending Linux patches that we don't pass "--no-tree"
> to checkpatch. While doing that, though, I found a number of bugs
> including an explanation about why recent version of patman have been
> yelling about "tags" when used with Linux even though Linux is
> supposed to have "process_tags" defaulted to False.

Awesome, I've been annoyed by the 'tags' thing, and just go used to
using --no-tags. Glad to see you're fixing it.

For the whole series:

Tested-by: Brian Norris <briannorris@chromium.org>

As noted, my brain isn't working so well on patch 6. But for patches 1-5
(modulo a small nit on 4):

Reviewed-by: Brian Norris <briannorris@chromium.org>

^ permalink raw reply	[flat|nested] 10+ messages in thread

end of thread, other threads:[~2022-06-30 22:18 UTC | newest]

Thread overview: 10+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-06-30 21:08 [PATCH 0/6] patman: Small fixes plus remove --no-tree from checkpatch for linux Douglas Anderson
2022-06-30 21:08 ` [PATCH 1/6] patman: Fix updating argument defaults from settings Douglas Anderson
2022-06-30 21:08 ` [PATCH 2/6] patman: Fix implicit command inserting Douglas Anderson
2022-06-30 21:08 ` [PATCH 3/6] patman: Don't look at sys.argv when parsing settings Douglas Anderson
2022-06-30 21:08 ` [PATCH 4/6] patman: Make most bool arguments BooleanOptionalAction Douglas Anderson
2022-06-30 21:30   ` Brian Norris
2022-06-30 21:08 ` [PATCH 5/6] patman: By default don't pass "--no-tree" to checkpatch for linux Douglas Anderson
2022-06-30 21:08 ` [PATCH 6/6] patman: Take project defaults into account for --help Douglas Anderson
2022-06-30 22:15   ` Brian Norris
2022-06-30 22:18 ` [PATCH 0/6] patman: Small fixes plus remove --no-tree from checkpatch for linux Brian Norris

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox