Skip to content

Commit 4fa06f0

Browse files
committed
Fixed #120 - Update doc wording
Signed-off-by: Chin Yeung Li <[email protected]>
1 parent c930f26 commit 4fa06f0

File tree

1 file changed

+8
-12
lines changed

1 file changed

+8
-12
lines changed

docs/source/general.rst

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ AboutCode Toolkit is a tool for your software development team to document your
2626

2727
Additional AboutCode Toolkit information is available at:
2828

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.
3030

3131
- https://github.com/nexB/aboutcode-toolkit/ for the AboutCode Toolkit tools.
3232

@@ -220,15 +220,15 @@ For instance with this configuration, the target file will not contain the "type
220220
Run gen to Generate AboutCode Toolkit Files
221221
-------------------------------------------
222222

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:
224-
225-
- https://github.com/nexB/aboutcode-toolkit/blob/develop/REFERENCE.rst
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: :ref:`reference`
226224

227225
Here is an example of a gen command:
228226

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/
230230
231-
Note that this example gen command does the following:
231+
This gen example command does the following:
232232

233233
- Activates the --fetch-license option to get license text.
234234

@@ -378,9 +378,7 @@ In summary, you can start with simple, cosmetic customizations to the default_ht
378378
Run attrib to Generate a Product Attribution Notice Package
379379
-----------------------------------------------------------
380380

381-
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:
382-
383-
https://github.com/nexB/aboutcode-toolkit/blob/develop/REFERENCE.rst
381+
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`
384382

385383
Here is an example of a attrib command:
386384

@@ -404,9 +402,7 @@ Generate a Software Inventory of Your Codebase from AboutCode Toolkit Files
404402

405403
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.
406404

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:
408-
409-
https://github.com/nexB/aboutcode-toolkit/blob/develop/REFERENCE.rst
405+
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`
410406

411407
A successful execution of inventory will create a complete software inventory in .csv format or .json format based on defined format.
412408

0 commit comments

Comments
 (0)