Skip to content

Commit 7146e34

Browse files
committed
Update doc for multiple licenses format
Signed-off-by: Chin Yeung Li <[email protected]>
1 parent b9c1d98 commit 7146e34

File tree

2 files changed

+34
-4
lines changed

2 files changed

+34
-4
lines changed

REFERENCE.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -325,3 +325,30 @@ Options
325325
This option tells the tool to show all errors found.
326326
The default behavior will only show 'CRITICAL', 'ERROR', and 'WARNING'
327327

328+
329+
Special Notes
330+
=============
331+
Multiple licenses support format
332+
--------------------------------
333+
The multiple licenses support format for a CSV file is separated by a line break
334+
335+
+----------------+------+-----------------+----------------------+
336+
| about_resource | name | license_key | license_file |
337+
+----------------+------+-----------------+----------------------+
338+
| test.tar.xz | test | | apache-2.0 | | apache-2.0.LICENSE |
339+
| | | | mit | | mit.LICENSE |
340+
+----------------+------+-----------------+----------------------+
341+
342+
343+
The multiple licenses support format for a ABOUT file is by "grouping"
344+
345+
::
346+
347+
about_resource: test.tar.xz
348+
name: test
349+
licenses:
350+
- key: apache 2.0
351+
name: apache-2.0.LICENSE
352+
- key: mit
353+
name: mit.LICENSE
354+

SPECIFICATION.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ A simple and valid ABOUT file named httpd.ABOUT may look like this::
3232
download_url: http://archive.apache.org/dist/httpd/httpd-2.4.3.tar.gz
3333
license_expression: apache-2.0
3434
licenses:
35-
- license_file: httpd.LICENSE
35+
- key: apache-2.0
36+
- file: apache-2.0.LICENSE
3637
notice_file: httpd.NOTICE
3738
copyright: Copyright (c) 2012 The Apache Software Foundation.
3839

@@ -48,7 +49,7 @@ The meaning of this ABOUT file is:
4849
- The file "httpd-2.4.3.tar.gz" was originally downloaded from
4950
http://archive.apache.org/dist/httpd/httpd-2.4.3.tar.gz
5051

51-
- In the same directory, "httpd.LICENSE" and "httpd.NOTICE" are files that
52+
- In the same directory, "apache-2.0.LICENSE" and "httpd.NOTICE" are files that
5253
contain respectively the license text and the notice text for this component.
5354

5455
- This component is licensed under "apache-2.0"
@@ -189,12 +190,14 @@ encoded text and allows to support non-ASCII text content.
189190
For example, the full license text for a component is often stored in a separate
190191
file named COPYING::
191192

192-
license_file: linux.COPYING
193+
licenses:
194+
- file: linux.COPYING
193195

194196
In this example, the README file is stored in a doc directory, one directory
195197
above the ABOUT file directory, using a relative POSIX path::
196198

197-
license_file: ../docs/ruby.README
199+
licenses:
200+
- file: ../docs/ruby.README
198201

199202
Field referencing a URL
200203
~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)