Skip to content

Commit 426243f

Browse files
committed
Some update on the general doc section
Signed-off-by: Chin Yeung Li <[email protected]>
1 parent 65f0ad9 commit 426243f

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/source/general.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,17 @@ AboutCode Toolkit is a tool for your software development team to document your
1111

1212
- **attrib**: Generate a Product Attribution notice document from your ABOUT file(s), JSON, CSV or XLSX. You can also generate documents for other purposes (such as a License Reference) by varying your input control file and your template.
1313

14-
- **check**: A simple command to validate the ABOUT file(s) and output errors/warnings if any on the terminal.
14+
- **check**: A simple command to validate the ABOUT file(s) and output errors/warnings on the terminal.
1515

16-
- **collect_redist_src**: A command to collect and copy sources that have 'redistribute' flagged as 'True' in ABOUT file(s) or from an inventory.
16+
- **collect_redist_src**: A command to collect and copy sources that have the 'redistribute' flagged as 'True' in ABOUT file(s) or from an inventory.
1717

1818
- **gen**: Create ABOUT file(s) from a Software Inventory file (.csv, .json or .xlsx format) which is typically created from a software audit, and insert these AboutCode Toolkit files into your codebase. You can regenerate the AboutCode Toolkit files from a new Software Inventory file whenever you make changes.
1919

2020
- **gen_license**: Fetch licenses in the license_expression field and save to the output location.
2121

2222
- **inventory**: Generate a Software Inventory list (.csv, .json or .xlsx format) from your codebase based on ABOUT file(s). Note that this Software Inventory will only include components that have AboutCode Toolkit data. In another word, if you do not create AboutCode Toolkit files for your own original software components, these components will not show up in the generated inventory.
2323

24-
- **transform**: A command to transform an input CSV/JSON/XLSX by applying renaming and/or filtering and then output to a new CSV/JSON/Excel file.
24+
- **transform**: A command to transform an input CSV/JSON/XLSX by applying renaming and/or filtering and then output to a new CSV/JSON/XLSX file.
2525

2626
Additional AboutCode Toolkit information is available at:
2727

@@ -228,7 +228,7 @@ Here is an example of a gen command:
228228

229229
.. code-block:: none
230230
231-
about gen --fetch-license --reference /Users/harrypotter/myAboutFiles/ /Users/harrypotter/myAboutFiles/myProject-bom.csv /Users/harrypotter/myAboutFiles/
231+
about gen --fetch-license --reference /Users/harrypotter/myLicenseNoticeFiles/ /Users/harrypotter/myAboutFiles/myProject-bom.csv /Users/harrypotter/myAboutFiles/
232232
233233
This gen example command does the following:
234234

@@ -264,16 +264,16 @@ You can make appropriate changes to your input software inventory and then run g
264264
Using attrib to Generate a Product Attribution Notice Package
265265
=============================================================
266266

267-
Prepare an Attribution Template to Use as Input to attrib
268-
---------------------------------------------------------
267+
Prepare an Attribution Template to Use
268+
--------------------------------------
269269

270-
You can run attrib using the default_html.template (or default_json.template if want JSON output) provided with the AboutCode Toolkit tools:
270+
You can run attrib using the default_html.template (or default_json.template) provided with the AboutCode Toolkit tools:
271271

272272
https://github.com/nexB/aboutcode-toolkit/blob/develop/templates/default_html.template
273273

274274
If you choose to do that, you will most likely want to edit the generated .html file to provide header information about your own organization and product.
275275

276-
Running attrib with the default_html.template file is probably your best choice when you are still testing your AboutCode Toolkit process. Once you have a good understanding of the generated output, you can customize the template to provide the standard text that you want to see whenever you generate product attribution for your organization. You can also create alternative versions of the template to use attrib to generate other kinds of documents, such as a License Reference.
276+
Running attrib with the default_html.template file is probably your best choice when you are still testing your AboutCode Toolkit process. Once you have a good understanding of the generated output, you can customize the template to provide the standard text that serve your needs. You can also create alternative versions of the template to use attrib to generate other kinds of documents, such as a License Reference.
277277

278278
Use jinja2 Features to Customize Your Attribution Template
279279
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -306,7 +306,7 @@ If you would prefer something other than a simple space between the component na
306306
307307
The ``if about_object.version.value`` is checking for a component version, and if one exists it generates output text that is either a space followed by the actual version value, or, as in this customized template, it generates output text as " - Version ", followed by the actual version value. You will, of course, want to test your output to get exactly the results that you need.
308308

309-
Note that you can actually use attrib to generate an AboutCode Toolkit-sourced document of any kind for varying business purposes, and you may want to change the grouping/ordering of the data for different reporting purposes. (Here we get into somewhat more complex usage of jinja2 features, and you may wish to consult the jinja2 documentation to reach a more comprehensive understanding of the syntax and features.) The default ordering is by component, but In the following example, which is intended to support a "license reference" rather than an attribution document, the customized template modifies the data grouping to use a custom field called "confirmed license":
309+
Note that you can actually use attrib to generate an AboutCode Toolkit-sourced document of any kind for varying business purposes, and you may want to change the grouping/ordering of the data for different reporting purposes. (Here we get into somewhat more complex usage of jinja2 features, and you may wish to consult the jinja2 documentation to reach a more comprehensive understanding of the syntax and features.) The default ordering is by component, but In the following example, which is intended to support a "license reference" rather than an attribution document, the customized template modifies the data grouping to use a custom field called "confirmed_license":
310310

311311
.. code-block:: none
312312
@@ -367,7 +367,7 @@ In summary, you can start with simple, cosmetic customizations to the default_ht
367367
Run attrib to Generate a Product Attribution Notice Package
368368
-----------------------------------------------------------
369369

370-
When you have generated ABOUT file(s) by gen, you can then run attrib to generate your product attribution notice package. The official attrib parameters are defined here: :ref:`reference`
370+
You can then run the attrib to generate your product attribution notice package from the generated ABOUT file(s) or from an inventory (.csv/.json/.xlsx). The official attrib parameters are defined here: :ref:`reference`
371371

372372
Here is an example of a attrib command:
373373

0 commit comments

Comments
 (0)