You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/general.rst
+8-12Lines changed: 8 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ AboutCode Toolkit is a tool for your software development team to document your
26
26
27
27
Additional AboutCode Toolkit information is available at:
28
28
29
-
- http://www.aboutcode.org/ for an overview and a link to the ABOUT File specification.
29
+
- See :ref:`specification` for an overview and a link to the ABOUT File specification.
30
30
31
31
- https://github.com/nexB/aboutcode-toolkit/ for the AboutCode Toolkit tools.
32
32
@@ -220,15 +220,15 @@ For instance with this configuration, the target file will not contain the "type
220
220
Run gen to Generate AboutCode Toolkit Files
221
221
-------------------------------------------
222
222
223
-
When your software inventory is ready, you can save it as a .csv or .json file, and use it as input to run gen to generate your AboutCode Toolkit files. The official gen parameters are defined here:
When your software inventory is ready, you can save it as a .csv or .json file, and use it as input to run gen to generate your AboutCode Toolkit files. The official gen parameters are defined here: :ref:`reference`
226
224
227
225
Here is an example of a gen command:
228
226
229
-
about gen --fetch-license {{your license library api}} {{your license library api key}} --reference /Users/harrypotter/myAboutFiles/ /Users/harrypotter/myAboutFiles/myProject-bom.csv /Users/harrypotter/myAboutFiles/
227
+
.. code-block:: none
228
+
229
+
about gen --fetch-license {{your license library api key}} --reference /Users/harrypotter/myAboutFiles/ /Users/harrypotter/myAboutFiles/myProject-bom.csv /Users/harrypotter/myAboutFiles/
230
230
231
-
Note that this example gen command does the following:
231
+
This gen example command does the following:
232
232
233
233
- Activates the --fetch-license option to get license text.
234
234
@@ -378,9 +378,7 @@ In summary, you can start with simple, cosmetic customizations to the default_ht
378
378
Run attrib to Generate a Product Attribution Notice Package
When you have generated the AboutCode Toolkit files by gen, you can then run attrib to generate your product attribution notice package. The official attrib parameters are defined here:
When you have generated the AboutCode Toolkit files by gen, you can then run attrib to generate your product attribution notice package. The official attrib parameters are defined here: :ref:`reference`
384
382
385
383
Here is an example of a attrib command:
386
384
@@ -404,9 +402,7 @@ Generate a Software Inventory of Your Codebase from AboutCode Toolkit Files
404
402
405
403
One of the major features of the ABOUT File specification is that the .ABOUT files are very simple text files that can be created, viewed and edited using any standard text editor. Your software development and maintenance processes may require or encourage your software developers to maintain .ABOUT files and/or associated text files manually. For example, when a developer addresses a software licensing issue with a component, it is appropriate to adjust the associated AboutCode Toolkit files manually.
406
404
407
-
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:
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: :ref:`reference`
410
406
411
407
A successful execution of inventory will create a complete software inventory in .csv format or .json format based on defined format.
0 commit comments