Skip to content

Commit 48adedc

Browse files
committed
Documents updated for 3.2.0 release
Signed-off-by: Chin Yeung Li <[email protected]>
1 parent 004139f commit 48adedc

File tree

4 files changed

+12
-8
lines changed

4 files changed

+12
-8
lines changed

REFERENCE.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,8 @@ Options
214214
This option requires 2 parameters:
215215
api_url - URL to the DJE License Library
216216
api_key - Hash key to authenticate yourself in the API.
217+
218+
In addition, the input needs to have the 'license_expression' field.
217219
(Please contact nexB to get the api_* value to use for this feature)
218220

219221
$ about gen --fetch-license 'api_url' 'api_key' LOCATION OUTPUT

docs/CHANGELOG.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
2018-xx-xx
1+
2018-10-16
22

33
Release 3.2.0
44

5+
* The 'license' field is now become 'license_key'
56
* Multiple licenses support
67
* No support for referenceing multuiple resources
7-
* Fix the incorrect boolean field behavior
8+
* Fix the incorrect boolean field behaviors
89
* Display number of errors/warnings in the error log
910

1011
2018-09-19

docs/UsingAboutCodetoDocumentYourSoftwareAssets.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ You should start with a software inventory of your codebase in spreadsheet forma
136136
<td>Optional</td>
137137
</tr>
138138
<tr>
139-
<td>license</td>
139+
<td>license_key</td>
140140
<td>DejaCode Enterprise license key for the component.</td>
141141
<td>Optional. gen will obtain license information from DejaCode Enterprise if the --fetch-license option is set, including the license text, in order to create and write the appropriate .LICENSE file in the .ABOUT file target directory.</td>
142142
</tr>
@@ -272,10 +272,11 @@ Review your generated AboutCode Toolkit files to determine if they meet your req
272272
version: v 7.2
273273
attribute: Y
274274
copyright: Copyright (c) RedHat, Inc.
275-
license: gpl-2.0
276275
license_expression: gpl-2.0
277-
license_name: GNU General Public License 2.0
278-
license_text_file: gpl-2.0.LICENSE
276+
licenses:
277+
- key: gpl-2.0
278+
name: GNU General Public License 2.0
279+
file: gpl-2.0.LICENSE
279280
owner: Red Hat
280281
redistribute: Y
281282

@@ -388,7 +389,7 @@ In summary, you can start with simple, cosmetic customizations to the default.ht
388389

389390
When your Product BOM (your filtered software inventory) is ready, you can save it as a .csv file, and use it as input to run attrib to generate your product attribution notice package. Note that attrib will use the "about_file_path" column in your software inventory to get all the fields that it needs from your previously generated AboutCode Toolkit files. The official attrib parameters are defined here:
390391

391-
* [https://github.com/nexB/aboutcode-toolkit/blob/develop/USAGE.rst](https://github.com/nexB/aboutcode-toolkit/blob/develop/USAGE.rst)
392+
* [https://github.com/nexB/aboutcode-toolkit/blob/develop/REFERENCE.rst](https://github.com/nexB/aboutcode-toolkit/blob/develop/REFERENCE.rst)
392393

393394
Here is an example of a attrib command:
394395

@@ -416,6 +417,6 @@ One of the major features of the ABOUT File specification is that the .ABOUT fil
416417

417418
If your organization adopts the practice of manually creating and maintaining AboutCode Toolkit files, you can easily re-create your software inventory from your codebase using inventory. The official inventory parameters are defined here:
418419

419-
* [https://github.com/nexB/aboutcode-toolkit/blob/develop/USAGE.rst](https://github.com/nexB/aboutcode-toolkit/blob/develop/USAGE.rst)
420+
* [https://github.com/nexB/aboutcode-toolkit/blob/develop/REFERENCE.rst](https://github.com/nexB/aboutcode-toolkit/blob/develop/REFERENCE.rst)
420421

421422
A successful execution of inventory will create a complete software inventory in .csv format or .json format based on defined format.
-14.7 KB
Binary file not shown.

0 commit comments

Comments
 (0)