From c83b50536635fccbb6262c6012c71b707e3348b7 Mon Sep 17 00:00:00 2001 From: Peter Willendrup Date: Mon, 5 Aug 2024 12:35:58 +0200 Subject: [PATCH] Add basic .md.in for mcviewtest doc --- tools/Python/mctest/mcviewtest.md.in | 59 ++++++++++++++++++++++++++++ tools/Python/mctest/mcviewtest.py | 2 +- 2 files changed, 60 insertions(+), 1 deletion(-) create mode 100644 tools/Python/mctest/mcviewtest.md.in diff --git a/tools/Python/mctest/mcviewtest.md.in b/tools/Python/mctest/mcviewtest.md.in new file mode 100644 index 000000000..c9fe61781 --- /dev/null +++ b/tools/Python/mctest/mcviewtest.md.in @@ -0,0 +1,59 @@ +% @MCCODE_PREFIX@TEST(1) +% @FLAVOR_UPPER@ @MCCODE_PARTICLE@ Ray Tracing Team +% @MCCODE_DATE@ + +# NAME + +**@MCCODE_PREFIX@viewtest** - View results from one or more runs of +the @MCCODE_PREFIX@test toool, testing the @MCCODE_NAME@ installation + +# SYNOPSIS + +**@MCCODE_PREFIX@viewtest** [-h] [--reflabel [REFLABEL]] [--testroot [TESTROOT]] [--verbose] [--nobrowse] [testdir] + +# DESCRIPTION + +The tool **@MCCODE_PREFIX@viewtest** is a program visualise testesults +from the current @MCCODE_NAME@ installation. + +# OPTIONS + +**-h, --help** +: show this help message and exit + +**--reflabel REFLABEL** + Reference label name for comparison between + multiple test runs (oldest subfolder in PWD is + used if unset) + +**--testroot [TESTROOT]** + test root folder for test result management + +**--verbose** + output excessive information for debug purposes + +**--nobrowse** + Do not spawn browser on exit + +**testdir** + Indicate location of result directories + (PWD is used if unset) + +# FILES + +/usr/share/@FLAVOR@/resources +/usr/share/@FLAVOR@/tools/Python/mccodelib/mccode_config.json +~/.@FLAVOR@/mccode_config.json +http://www.@FLAVOR@.org + +# EXAMPLES + +`@MCCODE_PREFIX@viewtest` + +# AUTHORS + +@MCCODE_NAME@ Team (@FLAVOR@.org) + +# SEE ALSO + +@FLAVOR@(1), @MCCODE_PREFIX@test(1), @MCCODE_PREFIX@doc(1), @MCCODE_PREFIX@plot(1), @MCCODE_PREFIX@run(1), @MCCODE_PREFIX@gui(1), @MCCODE_PREFIX@display(1) diff --git a/tools/Python/mctest/mcviewtest.py b/tools/Python/mctest/mcviewtest.py index 40a120f54..a034904c5 100755 --- a/tools/Python/mctest/mcviewtest.py +++ b/tools/Python/mctest/mcviewtest.py @@ -282,7 +282,7 @@ def main(args): if __name__ == '__main__': parser = argparse.ArgumentParser(description=__doc__) parser.add_argument('testdir', nargs="?", help='test data is drawn from this root folder') - parser.add_argument('--reflabel', nargs="?", help='reference label name') + parser.add_argument('--reflabel', nargs="?", help='Reference label name for comparison between multiple test runs (oldest subfolder in PWD is used if unset)') parser.add_argument('--testroot', nargs="?", help='test root folder for test result management') parser.add_argument('--verbose', action='store_true', help='output excessive information for debug purposes') parser.add_argument('--nobrowse', action='store_true', help='Do not spawn browser on exit')