Skip to content

Commit 4eccaca

Browse files
committed
docs(model): Document that filename patterns get prepended with "**/"
The usages in `PathLicenseMatcher` and in `VersionControlSystem` prepend the filename patterns. Signed-off-by: Frank Viernau <frank.viernau@gmail.com>
1 parent b2e0293 commit 4eccaca

2 files changed

Lines changed: 6 additions & 5 deletions

File tree

model/src/main/kotlin/config/LicenseFilePatterns.kt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,27 +23,27 @@ import com.fasterxml.jackson.annotation.JsonIgnore
2323

2424
/**
2525
* A class that holds various filename patterns for files that typically contain license-related information. All
26-
* patterns are supposed to be used case-insensitively.
26+
* patterns are supposed to be used case-insensitively. The prefix '*​*​/' will be prepended before usage.
2727
*/
2828
data class LicenseFilePatterns(
2929
/**
30-
* A set of globs that match typical license filenames.
30+
* A set of globs that match typical license filenames. The prefix '*​*​/' will be prepended before usage.
3131
*/
3232
val licenseFilenames: Set<String>,
3333

3434
/**
35-
* A set of globs that match typical notice filenames.
35+
* A set of globs that match typical notice filenames. The prefix '*​*​/' will be prepended before usage.
3636
*/
3737
val noticeFilenames: Set<String>,
3838

3939
/**
40-
* A set of globs that match typical patent filenames.
40+
* A set of globs that match typical patent filenames. The prefix '*​*​/' will be prepended before usage.
4141
*/
4242
val patentFilenames: Set<String>,
4343

4444
/**
4545
* A set of globs that match files that often contain the license of a project, but that are no license files and
46-
* are therefore not contained in [licenseFilenames].
46+
* are therefore not contained in [licenseFilenames]. The prefix '*​*​/' will be prepended before usage.
4747
*/
4848
val otherLicenseFilenames: Set<String>
4949
) {

website/docs/configuration/license-texts.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ See the [`reference.yml`](https://github.com/oss-review-toolkit/ort/blob/main/mo
5353
#### License File Patterns
5454

5555
To decide which files to archive, ORT has a [predefined set of license file patterns](https://github.com/oss-review-toolkit/ort/blob/main/model/src/main/kotlin/config/LicenseFilePatterns.kt).
56+
The prefix '**/' will be prepended prior to their usage.
5657
To overwrite these patterns, you can add the `licenseFilePatterns` section to the `config.yml` file:
5758

5859
```yaml

0 commit comments

Comments
 (0)