aboutsummaryrefslogtreecommitdiff
path: root/examples/README.md
diff options
context:
space:
mode:
authorSteve Winslow <steve@swinslow.net>2020-05-10 14:54:30 -0400
committerSteve Winslow <steve@swinslow.net>2020-05-10 14:54:30 -0400
commitd1a01f0c01c3d1095ff4a43088daacf3cf6edee2 (patch)
tree8cb8e346e7f351f5668458aee4212ecb83dfdb99 /examples/README.md
parent003280a3d97db9ecba61cfe6fad1a0a5f9e4529a (diff)
downloadspdx-tools-d1a01f0c01c3d1095ff4a43088daacf3cf6edee2.tar.gz
Refactor examples to handle element ID maps
Signed-off-by: Steve Winslow <steve@swinslow.net>
Diffstat (limited to 'examples/README.md')
-rw-r--r--examples/README.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/examples/README.md b/examples/README.md
index 26c6fe4..c62ce86 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -49,8 +49,9 @@ files, and printing the report to standard output.
*licensediff*, *tvloader*
This example demonstrates loading two SPDX tag-value files from disk into
-memory, and generating a diff of the concluded licenses for Files in the
-first-listed Packages in each document.
+memory, and generating a diff of the concluded licenses for Files in Packages
+with matching IDs in each document.
This is generally only useful when run with two SPDX documents that describe
-licenses for subsequent versions of the same set of files.
+licenses for subsequent versions of the same set of files, AND if they have
+the same identifier in both documents.