Skip to content

Commit

Permalink
Merge pull request #35 from github/elr/cmd-doc
Browse files Browse the repository at this point in the history
add documentation for license extraction utility
  • Loading branch information
elrayle authored Jan 17, 2023
2 parents 9edaf20 + ad924b9 commit 9f1f925
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions cmd/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/*
Extracts license, deprecation, and exception ids from the official spdx license list data.
The source data needs to be manually updated by copying the licenses.json file from
https://github.com/spdx/license-list-data/blob/main/json/licenses.json and exceptions.json
file from https://github.com/spdx/license-list-data/blob/main/json/exceptions.json.
After running the extract command, the license_ids.json, deprecated_ids.json, and exception_ids.json
files will be overwritten with the extracted ids. These license ids can then be used to update the
spdxexp/license.go file.
Command to run all extractions (run command from the /cmd directory):
go run . extract -l -e
Usage options:
-h: prints this help message
-l: Extract license ids
-e: Extract exception ids
*/
package main

0 comments on commit 9f1f925

Please sign in to comment.