Skip to content

Commit 9e032f5

Browse files
committed
Fixed #320 - Update USAGE doc
Signed-off-by: Chin Yeung Li <[email protected]>
1 parent e0f8bee commit 9e032f5

File tree

1 file changed

+41
-16
lines changed

1 file changed

+41
-16
lines changed

USAGE.rst

Lines changed: 41 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,12 @@ attrib
4343
--inventory PATH Path to an inventory file.
4444
--mapping Use for mapping between the input keys and the ABOUT field.
4545
names - mapping.config
46-
--show-all Show all the errors and warning
46+
--mapping-file Use a custom mapping file with mapping between input
47+
keys and ABOUT field names.
48+
--verbose Show all the errors and warning.
4749
--template PATH Path to a custom attribution template.
4850
-q, --quiet Do not print any error/warning.
49-
--help Show this message and exit.
51+
-h, --help Show this message and exit.
5052

5153
Purpose
5254
-------
@@ -82,7 +84,13 @@ Options
8284

8385
See mapping.config for details
8486

85-
--show-all
87+
--mapping-file
88+
89+
Same behavior as `--mapping` but with custom mapping file
90+
91+
$ about attrib --mapping-file CUSTOM_MAPPING_FILE_PATH LOCATION OUTPUT
92+
93+
--verbose
8694

8795
This option tells the tool to show all errors found.
8896
The default behavior will only show 'CRITICAL', 'ERROR', and 'WARNING'
@@ -119,8 +127,8 @@ check
119127

120128
::
121129

122-
--show-all Show all the errors and warning
123-
--help Show this message and exit.
130+
--verbose Show all the errors and warning
131+
-h, --help Show this message and exit.
124132

125133
Purpose
126134
-------
@@ -131,12 +139,12 @@ Options
131139

132140
::
133141

134-
--show-all
142+
--verbose
135143

136144
This option tells the tool to show all errors found.
137145
The default behavior will only show 'CRITICAL', 'ERROR', and 'WARNING'
138146

139-
$ about check --show-all /home/project/about_files/
147+
$ about check --verbose /home/project/about_files/
140148

141149

142150
gen
@@ -155,7 +163,7 @@ gen
155163

156164
::
157165

158-
--fetch-license TEXT... Fetch licenses text from a DejaCode API. and
166+
--fetch-license KEY Fetch licenses text from a DejaCode API. and
159167
create <license>.LICENSE side-by-side
160168
with the generated .ABOUT file using data
161169
fetched from a DejaCode License Library. The
@@ -169,12 +177,14 @@ gen
169177

170178
about gen --fetch-license 'api_url' 'api_key'
171179
--license-notice-text-location PATH Copy the 'license_file' from the directory to
172-
the generated location
180+
the generated location.
173181
--mapping Use for mapping between the input keys and
174182
the ABOUT field names - mapping.config
175-
--show-all Show all the errors and warning
183+
--mapping-file Use a custom mapping file with mapping between input
184+
keys and ABOUT field names.
185+
--verbose Show all the errors and warning.
176186
-q, --quiet Do not print any error/warning.
177-
--help Show this message and exit.
187+
-h, --help Show this message and exit.
178188

179189
Purpose
180190
-------
@@ -213,7 +223,13 @@ Options
213223

214224
See mapping.config for details
215225

216-
--show-all
226+
--mapping-file
227+
228+
Same behavior as `--mapping` but with custom mapping file
229+
230+
$ about attrib --mapping-file CUSTOM_MAPPING_FILE_PATH LOCATION OUTPUT
231+
232+
--verbose
217233

218234
This option tells the tool to show all errors found.
219235
The default behavior will only show 'CRITICAL', 'ERROR', and 'WARNING'
@@ -237,9 +253,11 @@ inventory
237253

238254
-f, --format [json|csv] Set OUTPUT file format. [default: csv]
239255
--mapping Use file mapping.config to collect the defined not supported fields in ABOUT files.
240-
--show-all Show all the errors and warning
256+
--mapping-file Use a custom mapping file with mapping between input
257+
keys and ABOUT field names.
258+
--verbose Show all the errors and warning.
241259
-q, --quiet Do not print any error/warning.
242-
--help Show this message and exit.
260+
-h, --help Show this message and exit.
243261

244262
Purpose
245263
-------
@@ -254,13 +272,20 @@ Options
254272
255273
Set OUTPUT file format. [default: csv]
256274

275+
$ about inventory -f json LOCATION OUTPUT
276+
257277
--mapping
258278

259279
See mapping.config for details
260280

261-
--show-all
281+
--mapping-file
282+
283+
Same behavior as `--mapping` but with custom mapping file
284+
285+
$ about attrib --mapping-file CUSTOM_MAPPING_FILE_PATH LOCATION OUTPUT
286+
287+
--verbose
262288

263289
This option tells the tool to show all errors found.
264290
The default behavior will only show 'CRITICAL', 'ERROR', and 'WARNING'
265291

266-
$ about inventory -f json [OPTIONS] LOCATION OUTPUT

0 commit comments

Comments
 (0)