Skip to content

Commit 006b366

Browse files
committed
Remove trailing whitespace
Signed-off-by: Chin Yeung Li <[email protected]>
1 parent eb36916 commit 006b366

File tree

3 files changed

+58
-58
lines changed

3 files changed

+58
-58
lines changed

docs/source/general.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,12 +86,12 @@ You should start with a software inventory of your codebase in spreadsheet or JS
8686
- License name for the component.
8787
- Optional. This field will be generated if the --fetch-license or --fetch-license-djc option is set.
8888
* - license file
89-
- license file name
89+
- license file name
9090
- Optional. gen will look for the file name (if a directory is specified in the --reference option) to copy that file to the .ABOUT file target directory.
91-
* - license_url
91+
* - license_url
9292
- URL to the license text for the component
9393
- Optional
94-
* - spdx_license_key
94+
* - spdx_license_key
9595
- The ScanCode LicenseDB spdx_license_key defined for the license at https://scancode-licensedb.aboutcode.org/index.html
9696
- Optional
9797
* - copyright
@@ -327,13 +327,13 @@ After the table of contents, this example customized template continues with the
327327
328328
{% for group in abouts | groupby('confirmed_license') %}
329329
{% for confirmed_license in group.grouper.value %}
330-
330+
331331
<div id="group_{{ loop.index0 }}">
332332
<h3>{{ confirmed_license }}</h3>
333333
<p>This product contains the following open source software packages licensed under the terms of the license: {{confirmed_license}}</p>
334-
334+
335335
<div class="oss-component" id="component_{{ loop.index0 }}">
336-
{%for about_object in group.list %}
336+
{%for about_object in group.list %}
337337
{% if loop.first %}
338338
{% if about_object.license_url.value %}
339339
{% for lic_url in about_object.license_url.value %}
@@ -343,7 +343,7 @@ After the table of contents, this example customized template continues with the
343343
{% endif %}
344344
{% endif %}
345345
<li>
346-
{{ about_object.name.value }}{% if about_object.version.value %} - Version
346+
{{ about_object.name.value }}{% if about_object.version.value %} - Version
347347
{{ about_object.version.value }}{% endif %}
348348
</li>
349349
{% if about_object.copyright.value %}<pre>{{about_object.copyright.value}}</pre>{% endif %}

docs/source/reference.rst

Lines changed: 49 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Assume the following:
8888
8989
'/home/about_files/' contains all the ABOUT files [INPUT]
9090
'/home/project/inventory.csv' is a BOM inventory [INPUT]
91-
'/home/project/scancode-detection.json' is a detection output from scancode-toolkit[INPUT]
91+
'/home/project/scancode-detection.json' is a detection output from scancode-toolkit[INPUT]
9292
'/home/project/licenses/' contains all the license/notice file references
9393
'/home/attribution/attribution.html' is the user's output path [OUTPUT]
9494
@@ -135,15 +135,15 @@ Details
135135
This option allows you to use your own template for attribution generation.
136136
For instance, if you have a custom template located at:
137137
/home/custom_template/template.html
138-
138+
139139
$ about attrib --template /home/custom_template/template.html INPUT OUTPUT
140-
140+
141141
--vartext
142-
142+
143143
This option allow you to pass variable texts to the attribution template
144-
144+
145145
$ about attrib --vartext "title=Attribution Notice" --vartext "header=Product 101" LOCATION OUTPUT
146-
146+
147147
Users can use the following in the template to get the vartext:
148148
{{ vartext['title'] }}
149149
{{ vartext['header'] }}
@@ -231,10 +231,10 @@ Syntax
231231
.. code-block:: none
232232
233233
about collect_redist_src [OPTIONS] LOCATION OUTPUT
234-
234+
235235
LOCATION: Path to a directory containing sources that need to be copied
236236
(and containing ABOUT files if `inventory` is not provided)
237-
237+
238238
OUTPUT: Path to a directory or a zip file where sources will be copied to.
239239
240240
Options
@@ -262,37 +262,37 @@ Details
262262
.. code-block:: none
263263
264264
--from-inventory
265-
265+
266266
Provide an inventory CSV/JSON file with the 'redistribute' field filled as
267267
the indication of which files/sources need to be copied.
268-
268+
269269
$ about collect_redist_src --from-inventory 'path to the inventory' LOCATION OUTPUT
270-
270+
271271
--with-structures
272-
272+
273273
Copy the file(s) along with its parent directories
274-
274+
275275
For instance, assuming we want to copy the following file:
276276
/project/work/hello/foo.c
277-
277+
278278
OUTPUT: /output/
279-
279+
280280
$ about collect_redist_src --with-structure /project/ /output/
281-
281+
282282
OUTPUT: /output/work/hello/foo.c
283-
283+
284284
$ about collect_redist_src /project/ /output/
285-
285+
286286
OUTPUT: /output/foo.c
287-
287+
288288
--zip
289-
289+
290290
Zip the copied sources to the output location
291-
291+
292292
$ about collect_redist_src --zip /project/ /output/output.zip
293-
293+
294294
--verbose
295-
295+
296296
This option tells the tool to show all errors found.
297297
The default behavior will only show 'CRITICAL', 'ERROR', and 'WARNING'
298298
@@ -305,7 +305,7 @@ Syntax
305305
.. code-block:: none
306306
307307
about gen [OPTIONS] LOCATION OUTPUT
308-
308+
309309
LOCATION: Path to a JSON/CSV/XLSX inventory file.
310310
OUTPUT: Path to a directory where ABOUT files are generated.
311311
@@ -436,7 +436,7 @@ Details
436436
437437
--djc
438438
439-
Fetch licenses text from a DejaCode API, and create <license>.LICENSE to the
439+
Fetch licenses text from a DejaCode API, and create <license>.LICENSE to the
440440
OUTPUT Location using the data fetched from the DejaCode License Library.
441441
442442
This option requires 2 parameters:
@@ -472,7 +472,7 @@ Syntax
472472
.. code-block:: none
473473
474474
about inventory [OPTIONS] LOCATION OUTPUT
475-
475+
476476
LOCATION: Path to an ABOUT file or a directory with ABOUT files.
477477
OUTPUT: Path to the CSV/JSON/XLSX inventory file to create.
478478
@@ -497,13 +497,13 @@ Details
497497
.. code-block:: none
498498
499499
-f, --format [json|csv|excel]
500-
500+
501501
Set OUTPUT file format. [default: csv]
502-
502+
503503
$ about inventory -f json LOCATION OUTPUT
504-
504+
505505
--verbose
506-
506+
507507
This option tells the tool to show all errors found.
508508
The default behavior will only show 'CRITICAL', 'ERROR', and 'WARNING'
509509
@@ -571,7 +571,7 @@ Syntax
571571
.. code-block:: none
572572
573573
about transform [OPTIONS] LOCATION OUTPUT
574-
574+
575575
LOCATION: Path to a CSV/JSON/XLSX file.
576576
OUTPUT: Path to CSV/JSON/XLSX inventory file to create.
577577
@@ -598,22 +598,22 @@ Details
598598
.. code-block:: none
599599
600600
-c, --configuration
601-
601+
602602
Path to an optional YAML configuration file. See--help-format for format help.
603-
603+
604604
$ about transform -c 'path to the YAML configuration file' LOCATION OUTPUT
605-
605+
606606
--help-format
607-
607+
608608
Show configuration file format help and exit.
609609
This option will print out examples of the the YAML configuration file.
610-
610+
611611
Keys configuration are: `field_renamings`, `required_fields` and `field_filters`
612-
612+
613613
$ about transform --help-format
614-
614+
615615
--verbose
616-
616+
617617
This option tells the tool to show all errors found.
618618
The default behavior will only show 'CRITICAL', 'ERROR', and 'WARNING'
619619
@@ -625,55 +625,55 @@ Details
625625
A transform configuration file is used to describe which transformations and
626626
validations to apply to a source CSV file. This is a simple text file using YAML
627627
format, using the same format as an .ABOUT file.
628-
628+
629629
The attributes that can be set in a configuration file are:
630-
630+
631631
* field_renamings:
632632
An optional map of source CSV or JSON field name to target CSV/JSON new field name that
633633
is used to rename CSV fields.
634-
634+
635635
For instance with this configuration the fields "Directory/Location" will be
636636
renamed to "about_resource" and "foo" to "bar":
637637
field_renamings:
638638
about_resource : 'Directory/Location'
639639
bar : foo
640-
640+
641641
The renaming is always applied first before other transforms and checks. All
642642
other field names referenced below are these that exist AFTER the renamings
643643
have been applied to the existing field names.
644-
644+
645645
* required_fields:
646646
An optional list of required field names that must have a value, beyond the
647647
standard fields names. If a source CSV/JSON does not have such a field or a row is
648648
missing a value for a required field, an error is reported.
649-
649+
650650
For instance with this configuration an error will be reported if the fields
651651
"name" and "version" are missing or if any row does not have a value set for
652652
these fields:
653653
required_fields:
654654
- name
655655
- version
656-
656+
657657
* field_filters:
658658
An optional list of field names that should be kept in the transformed CSV/JSON. If
659659
this list is provided, all the fields from the source CSV/JSON that should be kept
660660
in the target CSV/JSON must be listed regardless of either standard or required
661661
fields. If this list is not provided, all source CSV/JSON fields are kept in the
662662
transformed target CSV/JSON.
663-
663+
664664
For instance with this configuration the target CSV/JSON will only contains the "name"
665665
and "version" fields and no other field:
666666
field_filters:
667667
- name
668668
- version
669-
669+
670670
* exclude_fields:
671671
An optional list of field names that should be excluded in the transformed CSV/JSON. If
672672
this list is provided, all the fields from the source CSV/JSON that should be excluded
673673
in the target CSV/JSON must be listed. Excluding standard or required fields will cause
674674
an error. If this list is not provided, all source CSV/JSON fields are kept in the
675675
transformed target CSV/JSON.
676-
676+
677677
For instance with this configuration the target CSV/JSON will not contain the "type"
678678
and "temp" fields:
679679
exclude_fields:

docs/source/type_of_errors.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _type_of_errors:
22

33
==============
4-
Type of Errors
4+
Type of Errors
55
==============
66

77
We have 6 type of errors as describe below:
@@ -90,4 +90,4 @@ Trigger:
9090

9191
.. note::
9292
If `--verbose` is set, all the detected errors will be reported.
93-
Otherwise, only "CRITICAL", "ERROR" and 'WARNING" will be reported.
93+
Otherwise, only "CRITICAL", "ERROR" and 'WARNING" will be reported.

0 commit comments

Comments
 (0)