aboutsummaryrefslogtreecommitdiff
path: root/docs/idsearcher-assumptions.md
blob: 32b75e97ceadac2f7b2741861f80e56fc4f5ab68 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
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.