Skip to content

Commit 7f36fc3

Browse files
committed
chore: Revisit the spellings of "FossID"
Whenever the actual product name is meant, the spelling should match the official one: "FossID". While at it, also apply some minor other wording improvements in the vicinity of the changes. Signed-off-by: Sebastian Schuberth <[email protected]>
1 parent b06e2ae commit 7f36fc3

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

clients/fossid-webapp/src/main/kotlin/FossIdRestService.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,8 +173,8 @@ interface FossIdRestService {
173173
/**
174174
* A class to modify the standard Jackson deserialization to deal with inconsistencies in responses
175175
* sent by the FossID server.
176-
* When deleting a scan, FossId returns the scan id as String in the 'data' property of the response. If no scan
177-
* could be found, it returns an empty array. Starting with FossID version 2023.1, the return type of the
176+
* When deleting a scan, FossID returns the scan id as a string in the `data` property of the response. If no
177+
* scan could be found, it returns an empty array. Starting with FossID version 2023.1, the return type of the
178178
* [deleteScan] function is now a map of strings to strings. Creating a special [FossIdServiceWithVersion]
179179
* implementation for this call is an overkill as ORT does not even use the return value. Therefore, this change
180180
* is also handled by the [PolymorphicIntDeserializer].

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ import org.ossreviewtoolkit.plugins.api.PluginConfig
2929
@JsonInclude(JsonInclude.Include.NON_NULL)
3030
data class ReporterConfiguration(
3131
/**
32-
* Reporter specific configuration options. The key needs to match the name of the reporter class, e.g. "FossId"
33-
* for the FossId reporter. See the documentation of the reporter for available options.
32+
* Reporter-specific configuration options. The key needs to match the ID of the reporter plugin, e.g. "FossId" for
33+
* the "FossIdReporter" class. See the documentation of the reporter for available options.
3434
*/
3535
val config: Map<String, PluginConfig>? = null
3636
)

plugins/scanners/fossid/src/main/kotlin/FossId.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ class FossId internal constructor(
264264
override fun scanPackage(nestedProvenance: NestedProvenance?, context: ScanContext): ScanResult {
265265
val startTime = Instant.now()
266266

267-
// FossId actually never uses the provenance determined by the scanner, but determines the source code to
267+
// FossID actually never uses the provenance determined by the scanner, but determines the source code to
268268
// download itself based on the passed VCS URL and revision, disregarding any VCS path.
269269
val pkg = context.coveredPackages.first()
270270
val provenance = pkg.vcsProcessed.revision.takeUnless { it.isBlank() }

plugins/scanners/fossid/src/main/kotlin/FossIdUrlProvider.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import org.ossreviewtoolkit.utils.ort.requestPasswordAuthentication
3232
/**
3333
* An internal helper class that generates the URLs used by [FossId] to check out the repositories to be scanned.
3434
*
35-
* The URLs used by FossId can sometimes be different from the normal package URLs. For instance, credentials may need
35+
* The URLs used by [FossId] can sometimes be different from the normal package URLs. For instance, credentials may need
3636
* to be added, or a different protocol may be used. This class takes care of such mappings.
3737
*/
3838
class FossIdUrlProvider private constructor(

plugins/scanners/fossid/src/test/kotlin/FossIdLicenseMappingTest.kt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ class FossIdLicenseMappingTest : WordSpec({
5656
findings.licenseFindings should beEmpty()
5757
}
5858

59-
"map non-SPDX compliant FossId licenses in a snippet to snippet findings" {
59+
"map non-SPDX compliant FossID licenses in a snippet to snippet findings" {
6060
val rawResults = createSnippet("Apache 2.0")
6161
val issues = mutableListOf<Issue>()
6262

@@ -79,7 +79,7 @@ class FossIdLicenseMappingTest : WordSpec({
7979
}
8080
}
8181

82-
"map deprecated SPDX FossId licenses in a snippet to snippet findings" {
82+
"map deprecated SPDX FossID licenses in a snippet to snippet findings" {
8383
val rawResults = createSnippet("GFDL-1.2")
8484
val issues = mutableListOf<Issue>()
8585

@@ -101,7 +101,7 @@ class FossIdLicenseMappingTest : WordSpec({
101101
}
102102
}
103103

104-
"map SPDX compliant FossId licenses in a snippet to snippet findings" {
104+
"map SPDX compliant FossID licenses in a snippet to snippet findings" {
105105
val rawResults = createSnippet("Apache-2.0")
106106
val issues = mutableListOf<Issue>()
107107

0 commit comments

Comments
 (0)