@@ -42,6 +42,13 @@ def main():
42
42
# Read command-line arguments
43
43
parser = argparse .ArgumentParser (
44
44
description = "Code Base Investigator " + str (version ),
45
+ add_help = False ,
46
+ )
47
+ parser .add_argument (
48
+ "-h" ,
49
+ "--help" ,
50
+ action = "help" ,
51
+ help = "Display help message and exit." ,
45
52
)
46
53
parser .add_argument (
47
54
"--version" ,
@@ -54,58 +61,59 @@ def main():
54
61
"-r" ,
55
62
"--rootdir" ,
56
63
dest = "rootdir" ,
57
- metavar = "DIR " ,
64
+ metavar = "<dir> " ,
58
65
default = None ,
59
- help = "Set working root directory (default .)" ,
66
+ help = "Set working root directory. "
67
+ + "Defaults to current working directory." ,
60
68
)
61
69
deprecated_args .add_argument (
62
70
"-c" ,
63
71
"--config" ,
64
72
dest = "config_file" ,
65
73
metavar = "<config-file>" ,
66
74
action = "store" ,
67
- help = "Configuration YAML file. " + "Defaults to config.yaml" ,
75
+ help = "Configuration YAML file. " + "Defaults to config.yaml. " ,
68
76
)
69
77
parser .add_argument (
70
78
"-v" ,
71
79
"--verbose" ,
72
80
dest = "verbose" ,
73
81
action = "count" ,
74
82
default = 0 ,
75
- help = "increase verbosity level" ,
83
+ help = "Increase verbosity level. " ,
76
84
)
77
85
parser .add_argument (
78
86
"-q" ,
79
87
"--quiet" ,
80
88
dest = "quiet" ,
81
89
action = "count" ,
82
90
default = 0 ,
83
- help = "decrease verbosity level" ,
91
+ help = "Decrease verbosity level. " ,
84
92
)
85
93
parser .add_argument (
86
94
"-R" ,
87
95
"--report" ,
88
96
dest = "reports" ,
89
- metavar = "REPORT " ,
97
+ metavar = "<report> " ,
90
98
default = ["all" ],
91
99
choices = ["all" , "summary" , "clustering" ],
92
100
nargs = "+" ,
93
- help = "desired output reports (default: all) " ,
101
+ help = "Generate a report of the specified type. " ,
94
102
)
95
103
deprecated_args .add_argument (
96
104
"-d" ,
97
105
"--dump" ,
98
106
dest = "dump" ,
99
107
metavar = "<file.json>" ,
100
108
action = "store" ,
101
- help = "dump out annotated platform/parsing tree to <file.json>" ,
109
+ help = "Dump out annotated platform/parsing tree to <file.json>. " ,
102
110
)
103
111
deprecated_args .add_argument (
104
112
"--batchmode" ,
105
113
dest = "batchmode" ,
106
114
action = "store_true" ,
107
115
default = False ,
108
- help = "Set batch mode ( additional output for bulk operation.) " ,
116
+ help = "Enable additional output for bulk operation." ,
109
117
)
110
118
parser .add_argument (
111
119
"-x" ,
@@ -133,7 +141,7 @@ def main():
133
141
"analysis_file" ,
134
142
metavar = "<analysis-file>" ,
135
143
nargs = "?" ,
136
- help = "TOML file describing the analysis to be performed,"
144
+ help = "TOML file describing the analysis to be performed, "
137
145
+ "including the codebase and platform descriptions." ,
138
146
)
139
147
0 commit comments