Merge pull request #2835 from vkarak/enhancement/fix-help-msg-detect-host-topology

vkarak · web-flow · commit 2ce9b2e571ae · 2023-03-28T13:30:08.000+02:00
[enhancement] Improve help message of `--detect-host-topology` option
diff --git a/reframe/frontend/cli.py b/reframe/frontend/cli.py
@@ -515,8 +515,10 @@ def main():
         envvar='RFM_CONFIG_FILES :'
     )
     misc_options.add_argument(
-        '--detect-host-topology', action='store', nargs='?', const='-',
-        help='Detect the local host topology and exit'
+        '--detect-host-topology', metavar='FILE', action='store',
+        nargs='?', const='-',
+        help=('Detect the local host topology and exit, '
+              'optionally saving it in FILE')
     )
     misc_options.add_argument(
         '--failure-stats', action='store_true', help='Print failure statistics'

Original file line number	Diff line number	Diff line change
`@@ -515,8 +515,10 @@ def main():`
`515`	`515`	`envvar='RFM_CONFIG_FILES :'`
`516`	`516`	`)`
`517`	`517`	`misc_options.add_argument(`
`518`		`- '--detect-host-topology', action='store', nargs='?', const='-',`
`519`		`- help='Detect the local host topology and exit'`
	`518`	`+ '--detect-host-topology', metavar='FILE', action='store',`
	`519`	`+ nargs='?', const='-',`
	`520`	`+ help=('Detect the local host topology and exit, '`
	`521`	`+ 'optionally saving it in FILE')`
`520`	`522`	`)`
`521`	`523`	`misc_options.add_argument(`
`522`	`524`	`'--failure-stats', action='store_true', help='Print failure statistics'`