aboutsummaryrefslogtreecommitdiff
path: root/docs/tvsaver-assumptions.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/tvsaver-assumptions.md')
-rw-r--r--docs/tvsaver-assumptions.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/tvsaver-assumptions.md b/docs/tvsaver-assumptions.md
new file mode 100644
index 0000000..f210a8a
--- /dev/null
+++ b/docs/tvsaver-assumptions.md
@@ -0,0 +1,14 @@
+SPDX-License-Identifier: CC-BY-4.0
+
+The tag-value file saver in `package tvsaver` makes the following assumptions:
+
+Document Creation Info
+----------------------
+* Mandatory fields will be treated the same way as optional fields; if they are
+ set to the empty string, they will be omitted. Thus, an invalid Creation Info
+ section (e.g. one that doesn't include a correct SPDXVersion field) will
+ result in outputting an invalid Creation Info section.
+
+Relationship
+------------
+* Same comment as above re: optional fields, for RelationshipComment.