Skip to content

ovmerge: Change argument parser from custom parser to argparse #221

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelwell merged 1 commit into from
Oct 26, 2026
Merged

ovmerge: Change argument parser from custom parser to argparse #221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 30 additions & 19 deletions ovmerge/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,34 @@ Install the prerequisites with "sudo apt install cmake" - you need at least vers
**Usage**

```
Usage: ovmerge <options> <ovspec>
where <ovspec> is the name of an overlay, optionally followed by
a comma-separated list of parameters, each with optional '=<value>'
assignments. The presence of any parameters, or a comma followed by
no parameters, removes the parameter declarations from the merged
overlay to avoid a potential name clash.
and <options> are any of:
-b <branch> Read files from specified git branch
-c Include 'redo' comment with command line (c.f. '-r')
-e Expand mode - list non-skipped lines in order of inclusion
-h Display this help info
-i Show include hierarchy for each file
-l Like expand mode, but labels each line with source file
-n No .dts file header (just parsing .dtsi files)
-p Emulate Pi firmware manipulation
-r Redo command comment in named files (c.f. '-c')
-s Sort nodes and properties (for easy comparison)
-t Trace
-w Show warnings
usage: ovmerge [-h] [-b branch] [-B token] [-c] [-e] [-f] [-i] [-l] [-n] [-N] [-p] [-q] [-r] [-s] [-S n] [-t] [-T] [-w] [ovspec ...]

Merge DT overlay source files, flatten and sort .dts files, or display the include tree.

positional arguments:
ovspec The name of an overlay, optionally followed by a comma-separated
list of parameters, each with optional '=<value>' assignments.
The presence of any parameters, or a comma followed by no
parameters, removes the parameter declarations from the merged
overlay to avoid a potential name clash.

options:
-h, --help show this help message and exit
-b branch Read files from specified git branch
-B token Set a debug breakpoint on the specified token number
-c Include 'redo' comment with command line (c.f. '-r')
-e Expand mode - list non-skipped lines in order of inclusion
-f Force some errors to be ignored
-i Show include hierarchy for each file
-l Like expand mode, but labels each line with source file
-n No .dts file header (just parsing .dtsi files)
-N Don't renumber overlay fragments (not guaranteed to work)
-p Emulate Pi firmware manipulation
-q Query mode (no output, just the success/failure return code)
-r Redo command comment in named files (c.f. '-c')
-s Sort nodes and properties (for easy comparison)
-S n Instead of tabs, use 'n' spaces for indentation
-t Trace the tree changes
-T Trace the parsing process
-w Show warnings
```
165 changes: 74 additions & 91 deletions ovmerge/ovmerge
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
# Python port of the Perl ovmerge tool. CLI wrapper - the DT tokeniser,
# parser, and merge/apply engine live in ovmerge_engine.py.

import argparse
import re
import sys

Expand All @@ -46,72 +47,81 @@ from ovmerge_engine import (
# Main
# ---------------------------------------------------------------------------

def usage():
w = sys.stderr.write
w("Usage: ovmerge <options> <ovspec>\n")
w(" where <ovspec> is the name of an overlay, optionally followed by\n")
w(" a comma-separated list of parameters, each with optional '=<value>'\n")
w(" assignments. The presence of any parameters, or a comma followed by\n")
w(" no parameters, removes the parameter declarations from the merged\n")
w(" overlay to avoid a potential name clash.\n")
w(" and <options> are any of:\n")
w(" -b <branch> Read files from specified git branch\n")
w(" -B <token numer> Set a debug breakpoint on the specified token number\n")
w(" -c Include 'redo' comment with command line (c.f. '-r')\n")
w(" -e Expand mode - list non-skipped lines in order of inclusion\n")
w(" -f Force some errors to be ignored\n")
w(" -h Display this help info\n")
w(" -i Show include hierarchy for each file\n")
w(" -l Like expand mode, but labels each line with source file\n")
w(" -n No .dts file header (just parsing .dtsi files)\n")
w(" -N Don't renumber overlay fragments (not guaranteed to work)\n")
w(" -p Emulate Pi firmware manipulation\n")
w(" -q Query mode (no output, just the success/failure return code)\n")
w(" -r Redo command comment in named files (c.f. '-c')\n")
w(" -s Sort nodes and properties (for easy comparison)\n")
w(" -S <n> Instead of tabs, use 'n' spaces for indentation\n")
w(" -t Trace the tree changes\n")
w(" -T Trace the parsing process\n")
w(" -w Show warnings\n")
sys.exit(1)
class RedoAction(argparse.Action):
def __call__(self, parser, namespace, values, option_string=None):
cmdline = getattr(namespace, 'cmdline', [])
cmdline.append(option_string)
cmdline.extend(values if isinstance(values, list) else [values])
setattr(namespace, 'cmdline', cmdline)
setattr(namespace, self.dest, True if self.nargs == 0 else values)


def run(argv):
args = list(argv)
parser = argparse.ArgumentParser(
description="Merge DT overlay source files, flatten and sort .dts files, "
"or display the include tree.",
argument_default=argparse.SUPPRESS,
)
parser.add_argument('-b', dest='branch', action=RedoAction, metavar='branch',
help="Read files from specified git branch")
parser.add_argument('-B', dest='bkpt', type=int, metavar='token',
help="Set a debug breakpoint on the specified token number")
parser.add_argument('-c', dest='comment', action='store_true',
help="Include 'redo' comment with command line (c.f. '-r')")
parser.add_argument('-e', dest='expand', action='store_true',
help="Expand mode - list non-skipped lines in order of inclusion")
parser.add_argument('-f', dest='force', action='store_true',
help="Force some errors to be ignored")
parser.add_argument('-i', dest='show_includes', action='store_true',
help="Show include hierarchy for each file")
parser.add_argument('-l', dest='expand_label', action='store_true',
help="Like expand mode, but labels each line with source file")
parser.add_argument('-n', dest='no_dts', action='store_true',
help="No .dts file header (just parsing .dtsi files)")
parser.add_argument('-N', dest='no_renumber', action='store_true',
help="Don't renumber overlay fragments (not guaranteed to work)")
parser.add_argument('-p', dest='pi_extras', action=RedoAction, nargs=0,
help="Emulate Pi firmware manipulation")
parser.add_argument('-q', dest='query', action='store_true',
help="Query mode (no output, just the success/failure return code)")
parser.add_argument('-r', dest='redo', action='store_true',
help="Redo command comment in named files (c.f. '-c')")
parser.add_argument('-s', dest='sort', action=RedoAction, nargs=0,
help="Sort nodes and properties (for easy comparison)")
parser.add_argument('-S', dest='indent_spaces', action=RedoAction, metavar='n',
help="Instead of tabs, use 'n' spaces for indentation")
parser.add_argument('-t', dest='trace_tree', action='store_true',
help="Trace the tree changes")
parser.add_argument('-T', dest='trace_parse', action='store_true',
help="Trace the parsing process")
parser.add_argument('-w', dest='warnings', action='store_true',
help="Show warnings")
parser.add_argument('overlays', nargs='*', metavar='ovspec',
help="The name of an overlay, optionally followed by a comma-separated "
"list of parameters, each with optional '=<value>' assignments. The "
"presence of any parameters, or a comma followed by no parameters, "
"removes the parameter declarations from the merged overlay to avoid "
"a potential name clash.")

cmdline = []
redo_comments = []

while args and args[0].startswith('-') and args[0] != '-':
arg = args.pop(0)

if arg == '-b':
if not args:
print("* Branch parameter missing", file=sys.stderr)
usage()
S.branch = args.pop(0)
cmdline += [arg, S.branch]
elif arg == '-B':
if not args:
print("* Breakpoint number missing", file=sys.stderr)
usage()
S.bkpt = int(args.pop(0))
elif arg == '-c':
S.comment = True
elif arg == '-e':
S.expand = True
elif arg == '-h':
usage()
elif arg == '-i':
S.show_includes = True
elif arg == '-l':
while True:
options = vars(parser.parse_args(argv))
cmdline.extend(options.pop('cmdline', []))
args = options.pop('overlays', [])
redo = options.pop('redo', False)
indent_spaces = options.pop('indent_spaces', None)
if indent_spaces is not None:
if not re.fullmatch(r'\d+', indent_spaces):
parser.error("argument -S: expected a non-negative integer")
indent_spaces = int(indent_spaces)
S.indent_str = ' ' * indent_spaces
for name, value in options.items():
setattr(S, name, value)
if S.expand_label:
S.expand = True
S.expand_label = True
elif arg == '-n':
S.no_dts = True
elif arg == '-p':
S.pi_extras = True
cmdline.append(arg)
elif arg == '-r':

if redo:
if args:
lines = open_source_lines(args[0])
else:
Expand All @@ -120,45 +130,18 @@ def run(argv):
firstline = next(it, '')
m = re.match(r'^// redo: ovmerge (.*)', firstline)
if not m:
print("* Redo but input has no 'redo:' comment", file=sys.stderr)
usage()
args = re.split(r'\s+', m.group(1).strip())
parser.error("Redo but input has no 'redo:' comment")
argv = re.split(r'\s+', m.group(1).strip())
Comment thread
chewi marked this conversation as resolved.
Resolved
for line in it:
line = line.rstrip('\n')
if re.match(r'^/dts-v1/', line):
break
redo_comments.append(line)
elif arg == '-s':
S.sort = True
cmdline.append(arg)
elif arg == '-t':
S.trace_tree = True
elif arg == '-T':
S.trace_parse = True
elif arg == '-w':
S.warnings = True
elif arg == '-q':
S.query = True
elif arg == '-f':
S.force = True
elif arg == '-N':
S.no_renumber = True
elif arg == '-S':
if not args:
print("* Spaces count parameter missing", file=sys.stderr)
usage()
indent_spaces = args.pop(0)
if not re.fullmatch(r'\d+', indent_spaces):
print("* Invalid spaces count parameter. Expected an integer.", file=sys.stderr)
usage()
S.indent_str = ' ' * int(indent_spaces)
cmdline += [arg, indent_spaces]
else:
print(f"* Unknown option '{arg}'", file=sys.stderr)
usage()
break

if not args:
usage()
parser.error("At least one ovspec is required")

cmdline += args

Expand Down
Loading