From 4afffa73690491e2d97650cfb042b4df0c6ca1d4 Mon Sep 17 00:00:00 2001 From: Pawel Wodkowski Date: Mon, 26 Nov 2018 15:17:45 +0100 Subject: [PATCH] test: add help message to config_filter.py It is good to know what can be done using this tool. Change-Id: I372d3c6f7c1bdd3dc89e45aadbcde2cc4e608d7d Signed-off-by: Pawel Wodkowski Reviewed-on: https://review.gerrithub.io/c/434886 Tested-by: SPDK CI Jenkins Chandler-Test-Pool: SPDK Automated Test System Reviewed-by: Darek Stojaczyk Reviewed-by: Pawel Kaminski Reviewed-by: Ben Walker Reviewed-by: Jim Harris Reviewed-by: Karol Latecki --- test/json_config/config_filter.py | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/test/json_config/config_filter.py b/test/json_config/config_filter.py index f797a66d2..e6bfb3a93 100755 --- a/test/json_config/config_filter.py +++ b/test/json_config/config_filter.py @@ -53,8 +53,16 @@ def filter_methods(do_remove_global_rpcs): if __name__ == "__main__": - parser = argparse.ArgumentParser() - parser.add_argument('-method', dest='method') + parser = argparse.ArgumentParser(formatter_class=argparse.RawTextHelpFormatter) + parser.add_argument('-method', dest='method', default=None, + help="""One of the methods: +delete_global_parameters + remove pre-init configuration (pre start_subsystem_init RPC methods) +delete_configs + remove post-init configuration (post start_subsystem_init RPC methods) +sort + remove nothing - just sort JSON objects (and subobjects but not arrays) + in lexicographical order. This can be used to do plain text diff.""") args = parser.parse_args() if args.method == "delete_global_parameters": @@ -67,4 +75,4 @@ if __name__ == "__main__": o = json.loads('{ "the_object": ' + sys.stdin.read() + ' }') print(json.dumps(sort_json_object(o)['the_object'], indent=2)) else: - raise ValueError("Invalid method '{}'".format(args.method)) + raise ValueError("Invalid method '{}'\n\n{}".format(args.method, parser.format_help()))