From ad924b920628e442bb28154d1be18e71d553cb4d Mon Sep 17 00:00:00 2001 From: "E. Lynette Rayle" Date: Tue, 17 Jan 2023 09:33:29 -0500 Subject: [PATCH] add documentation for license extraction utility --- cmd/doc.go | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 cmd/doc.go diff --git a/cmd/doc.go b/cmd/doc.go new file mode 100644 index 0000000..d20ae72 --- /dev/null +++ b/cmd/doc.go @@ -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