aboutsummaryrefslogtreecommitdiff
path: root/docs/tvloader-assumptions.md
blob: eb84d494561a4a6ce9ec52628567460a55244823 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
SPDX-License-Identifier: CC-BY-4.0

The tag-value file loader in `package tvloader` makes the following assumptions:

Document Creation Info
----------------------
* The Document Creation Info section will always come first, and be completed
  first. Although the spec may not make this explicit, it appears that this is
  the intended format. Unless it comes first, the parser will not be able to
  confirm what version of the SPDX spec is being used. And, "SPDXID:" tags are
  used for not just the Document Creation Info section but also for others (e.g.
  Packages, Files).

Relationship
------------
* Relationship sections will begin with the "Relationship" tag.

Annotation
----------
* Annotation sections will begin with the "Annotator" tag.

Other License Info
------------------
* Other License sections will begin with the "LicenseID" tag.

* Any Other License section, if present, will come later than the Document
  Creation Info section and after any Package, File and Snippet sections.

Review
------
* Review sections will begin with the "Reviewer" tag.

* Any Review section, if present, will come later than the Document Creation
  Info section and after any Package, File, Snippet, and Other License sections.