mirror of
git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2025-09-04 20:19:47 +08:00
scripts: test_doc_build.py: regroup and rename arguments
The script now have lots or arguments. Better organize and name them, for it to be a little bit more intuitive. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/acf5e1db38ca6a713c44ceca9db5cdd7d3079c92.1750571906.git.mchehab+huawei@kernel.org
This commit is contained in:
Mauro Carvalho Chehab
Jonathan Corbet
parent
61aeda1e5c
commit
bb4c5c50ae
@ -269,7 +269,7 @@ class SphinxVenv:
|
||||
|
||||
ver = ".".join(map(str, cur_ver))
|
||||
|
||||
if not self.first_run and args.wait_input and args.make:
|
||||
if not self.first_run and args.wait_input and args.build:
|
||||
ret = input("Press Enter to continue or 'a' to abort: ").strip().lower()
|
||||
if ret == "a":
|
||||
print("Aborted.")
|
||||
@ -300,11 +300,11 @@ class SphinxVenv:
|
||||
result = await cmd.run([pip, "freeze"], verbose=False, check=True)
|
||||
|
||||
# Pip install succeeded. Write requirements file
|
||||
if args.write:
|
||||
if args.req_file:
|
||||
with open(req_file, "w", encoding="utf-8") as fp:
|
||||
fp.write(result.stdout)
|
||||
|
||||
if args.make:
|
||||
if args.build:
|
||||
start_time = time.time()
|
||||
|
||||
# Prepare a venv environment
|
||||
@ -317,7 +317,16 @@ class SphinxVenv:
|
||||
|
||||
# Test doc build
|
||||
await cmd.run(["make", "cleandocs"], env=env, check=True)
|
||||
make = ["make"] + args.make_args + ["htmldocs"]
|
||||
make = ["make"]
|
||||
|
||||
if args.output:
|
||||
sphinx_build = os.path.realpath(f"{bin_dir}/sphinx-build")
|
||||
make += [f"O={args.output}", f"SPHINXBUILD={sphinx_build}"]
|
||||
|
||||
if args.make_args:
|
||||
make += args.make_args
|
||||
|
||||
make += args.targets
|
||||
|
||||
if args.verbose:
|
||||
cmd.log(f". {bin_dir}/activate", verbose=True)
|
||||
@ -380,7 +389,7 @@ class SphinxVenv:
|
||||
await self._handle_version(args, fp, cur_ver, cur_requirements,
|
||||
python_bin)
|
||||
|
||||
if args.make:
|
||||
if args.build:
|
||||
cmd = AsyncCommands(fp)
|
||||
cmd.log("\nSummary:", verbose=True)
|
||||
for ver, elapsed_time in sorted(self.built_time.items()):
|
||||
@ -407,7 +416,7 @@ This tool allows creating Python virtual environments for different
|
||||
Sphinx versions that are supported by the Linux Kernel build system.
|
||||
|
||||
Besides creating the virtual environment, it can also test building
|
||||
the documentation using "make htmldocs".
|
||||
the documentation using "make htmldocs" (and/or other doc targets).
|
||||
|
||||
If called without "--versions" argument, it covers the versions shipped
|
||||
on major distros, plus the lowest supported version:
|
||||
@ -418,8 +427,8 @@ A typical usage is to run:
|
||||
|
||||
{SCRIPT} -m -l sphinx_builds.log
|
||||
|
||||
This will create one virtual env for the default version set and do a
|
||||
full htmldocs build for each version, creating a log file with the
|
||||
This will create one virtual env for the default version set and run
|
||||
"make htmldocs" for each version, creating a log file with the
|
||||
excecuted commands on it.
|
||||
|
||||
NOTE: The build time can be very long, specially on old versions. Also, there
|
||||
@ -433,6 +442,15 @@ reduce the number of threads from "-jauto" to, for instance, "-j4":
|
||||
|
||||
"""
|
||||
|
||||
MAKE_TARGETS = [
|
||||
"htmldocs",
|
||||
"texinfodocs",
|
||||
"infodocs",
|
||||
"latexdocs",
|
||||
"pdfdocs",
|
||||
"epubdocs",
|
||||
"xmldocs",
|
||||
]
|
||||
|
||||
async def main():
|
||||
"""Main program"""
|
||||
@ -440,32 +458,41 @@ async def main():
|
||||
parser = argparse.ArgumentParser(description=DESCRIPTION,
|
||||
formatter_class=argparse.RawDescriptionHelpFormatter)
|
||||
|
||||
parser.add_argument('-V', '--versions', help='Sphinx versions to test',
|
||||
nargs="*", default=DEFAULT_VERSIONS_TO_TEST,
|
||||
type=parse_version)
|
||||
parser.add_argument('--min-version', "--min", help='Sphinx minimal version',
|
||||
type=parse_version)
|
||||
parser.add_argument('--max-version', "--max", help='Sphinx maximum version',
|
||||
type=parse_version)
|
||||
parser.add_argument('-a', '--make_args',
|
||||
help='extra arguments for make htmldocs, like SPHINXDIRS=netlink/specs',
|
||||
nargs="*")
|
||||
parser.add_argument('-w', '--write', help='write a requirements.txt file',
|
||||
action='store_true')
|
||||
parser.add_argument('-m', '--make',
|
||||
help='Make documentation',
|
||||
action='store_true')
|
||||
parser.add_argument('-f', '--full',
|
||||
help='Add all (major,minor,latest_patch) version to the version list',
|
||||
action='store_true')
|
||||
parser.add_argument('-i', '--wait-input',
|
||||
help='Wait for an enter before going to the next version',
|
||||
action='store_true')
|
||||
parser.add_argument('-v', '--verbose',
|
||||
help='Verbose all commands',
|
||||
action='store_true')
|
||||
parser.add_argument('-l', '--log',
|
||||
help='Log command output on a file')
|
||||
ver_group = parser.add_argument_group("Version range options")
|
||||
|
||||
ver_group.add_argument('-V', '--versions', nargs="*",
|
||||
default=DEFAULT_VERSIONS_TO_TEST,type=parse_version,
|
||||
help='Sphinx versions to test')
|
||||
ver_group.add_argument('--min-version', "--min", type=parse_version,
|
||||
help='Sphinx minimal version')
|
||||
ver_group.add_argument('--max-version', "--max", type=parse_version,
|
||||
help='Sphinx maximum version')
|
||||
ver_group.add_argument('-f', '--full', action='store_true',
|
||||
help='Add all Sphinx (major,minor) supported versions to the version range')
|
||||
|
||||
build_group = parser.add_argument_group("Build options")
|
||||
|
||||
build_group.add_argument('-b', '--build', action='store_true',
|
||||
help='Build documentation')
|
||||
build_group.add_argument('-a', '--make-args', nargs="*",
|
||||
help='extra arguments for make, like SPHINXDIRS=netlink/specs',
|
||||
)
|
||||
build_group.add_argument('-t', '--targets', nargs="+", choices=MAKE_TARGETS,
|
||||
default=[MAKE_TARGETS[0]],
|
||||
help="make build targets. Default: htmldocs.")
|
||||
build_group.add_argument("-o", '--output',
|
||||
help="output directory for the make O=OUTPUT")
|
||||
|
||||
other_group = parser.add_argument_group("Other options")
|
||||
|
||||
other_group.add_argument('-r', '--req-file', action='store_true',
|
||||
help='write a requirements.txt file')
|
||||
other_group.add_argument('-l', '--log',
|
||||
help='Log command output on a file')
|
||||
other_group.add_argument('-v', '--verbose', action='store_true',
|
||||
help='Verbose all commands')
|
||||
other_group.add_argument('-i', '--wait-input', action='store_true',
|
||||
help='Wait for an enter before going to the next version')
|
||||
|
||||
args = parser.parse_args()
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user