diff options
Diffstat (limited to 'docs/idsearcher-assumptions.md')
| -rw-r--r-- | docs/idsearcher-assumptions.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/idsearcher-assumptions.md b/docs/idsearcher-assumptions.md new file mode 100644 index 0000000..32b75e9 --- /dev/null +++ b/docs/idsearcher-assumptions.md @@ -0,0 +1,13 @@ +SPDX-License-Identifier: CC-BY-4.0 + +The short-form ID searcher in `package idsearcher` makes the following assumptions: + +- The searcher uses bufio.Scanner to scan the contents of each file, line by + line. If it encounters a line that is too large to fit within the buffer, it + will stop scanning that file. As a result, it will currently only pick up + short-form IDs that occur prior to such a line. + +- For PackageLicenseInfoFromFiles (in Package) and LicenseInfoInFile (in File), + an exception should be treated as a separate "license". For example, in the + expression `GPL-2.0-only WITH Classpath-exception-2.0`, each of `GPL-2.0-only` + and `Classpath-exception-2.0` will be listed separately. |