Skip to content

Commit

Permalink
style: Align on using asterisks for emphasis in Markdown files
Browse files Browse the repository at this point in the history
This fixes violations of the markdownlint rule MD049/emphasis-style.

Signed-off-by: Martin Nonnenmacher <[email protected]>
  • Loading branch information
mnonnenmacher committed Jun 25, 2023
1 parent 9c37e7b commit ea6ba0c
Show file tree
Hide file tree
Showing 14 changed files with 76 additions and 76 deletions.
4 changes: 2 additions & 2 deletions ADOPTERS.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@

# Adopters

_If you're using ORT in your organization, please add your organization's name to the alphabetically sorted table below.
*If you're using ORT in your organization, please add your organization's name to the alphabetically sorted table below.
This really helps the project to gain momentum and credibility. It's a small contribution back to the project with a big
impact._
impact.*

| Organization | Contact | Description of Use |
|--------------|---------|--------------------|
Expand Down
52 changes: 26 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,21 +44,21 @@ your own copy as nothing on the internet is forever
* Correct package metadata or licensing findings yourself, using InnerSource or with the help of the FOSS community

ORT can be used as library (for programmatic use), via a command line interface (for scripted use), or via its CI
integrations. It consists of the following tools which can be combined into a _highly customizable_ pipeline:
integrations. It consists of the following tools which can be combined into a *highly customizable* pipeline:

* [_Analyzer_](#analyzer) - determines the dependencies of projects and their metadata, abstracting which package
* [*Analyzer*](#analyzer) - determines the dependencies of projects and their metadata, abstracting which package
managers or build systems are actually being used.
* [_Downloader_](#downloader) - fetches all source code of the projects and their dependencies, abstracting which
* [*Downloader*](#downloader) - fetches all source code of the projects and their dependencies, abstracting which
Version Control System (VCS) or other means are used to retrieve the source code.
* [_Scanner_](#scanner) - uses configured source code scanners to detect license / copyright findings, abstracting
* [*Scanner*](#scanner) - uses configured source code scanners to detect license / copyright findings, abstracting
the type of scanner.
* [_Advisor_](#advisor) - retrieves security advisories for used dependencies from configured vulnerability data
* [*Advisor*](#advisor) - retrieves security advisories for used dependencies from configured vulnerability data
services.
* [_Evaluator_](#evaluator) - evaluates custom policy rules along with custom license classifications against the data
* [*Evaluator*](#evaluator) - evaluates custom policy rules along with custom license classifications against the data
gathered in preceding stages and returns a list of policy violations, e.g. to flag license findings.
* [_Reporter_](#reporter) - presents results in various formats such as visual reports, Open Source notices or
* [*Reporter*](#reporter) - presents results in various formats such as visual reports, Open Source notices or
Bill-Of-Materials (BOMs) to easily identify dependencies, licenses, copyrights or policy rule violations.
* [_Notifier_](./notifier) - sends result notifications via different channels (like
* [*Notifier*](./notifier) - sends result notifications via different channels (like
[emails](./examples/example.notifications.kts) and / or JIRA tickets).

Also see the [list of related tools](#related-tools) that help with running ORT.
Expand Down Expand Up @@ -135,7 +135,7 @@ Then, let ORT check whether all required external tools are available by running

and install any missing tools or add compatible versions as indicated.

Finally, ORT tools like the _analyzer_ can be run like
Finally, ORT tools like the *analyzer* can be run like

ort --info analyze -f JSON -i /project -o /project/ort/analyzer

Expand All @@ -146,7 +146,7 @@ Please see [Getting Started](./docs/getting-started.md) for an introduction to t

## Running on CI

A basic ORT pipeline (using the _analyzer_, _scanner_ and _reporter_) can easily be run on
A basic ORT pipeline (using the *analyzer*, *scanner* and *reporter*) can easily be run on
[Jenkins CI](https://jenkins.io/) by using the [Jenkinsfile](./integrations/jenkins/Jenkinsfile) in a (declarative)
[pipeline](https://jenkins.io/doc/book/pipeline/) job. Please see the [Jenkinsfile](./integrations/jenkins/Jenkinsfile)
itself for documentation of the required Jenkins plugins. The job accepts various parameters that are translated to ORT
Expand Down Expand Up @@ -294,7 +294,7 @@ can be used to populate a directory with template package configuration files.

#### [Policy rules file](./docs/scripts/rules-kts.md)

The file containing any policy rule implementations to be used with the _evaluator_.
The file containing any policy rule implementations to be used with the *evaluator*.

| Format | Scope | Default location |
|---------------------|-----------|---------------------------------------|
Expand Down Expand Up @@ -335,7 +335,7 @@ defined:

[![Analyzer](./logos/analyzer.png)](./analyzer/src/main/kotlin)

The _analyzer_ is a Software Composition Analysis (SCA) tool that determines the dependencies of software projects
The *analyzer* is a Software Composition Analysis (SCA) tool that determines the dependencies of software projects
inside the specified input directory (`-i`). It does so by querying the detected package managers; **no modifications**
to your existing project source code, like applying build system plugins, are necessary for that to work. The tree of
transitive dependencies per project is written out as part of an
Expand Down Expand Up @@ -411,8 +411,8 @@ or [packages](./plugins/package-managers/spdx/src/funTest/assets/projects/synthe

[![Downloader](./logos/downloader.png)](./downloader/src/main/kotlin)

Taking an ORT result file with an _analyzer_ result as the input (`-i`), the _downloader_ retrieves the source code of
all contained packages to the specified output directory (`-o`). The _downloader_ takes care of things like normalizing
Taking an ORT result file with an *analyzer* result as the input (`-i`), the *downloader* retrieves the source code of
all contained packages to the specified output directory (`-o`). The *downloader* takes care of things like normalizing
URLs and using the [appropriate VCS tool](./downloader/src/main/kotlin/vcs) to check out source code from version
control.

Expand All @@ -429,7 +429,7 @@ Currently, the following Version Control Systems (VCS) are supported:

This tool wraps underlying license / copyright scanners with a common API so all supported scanners can be used in the
same way to easily run them and compare their results. If passed an ORT result file with an analyzer result (`-i`), the
_scanner_ will automatically download the sources of the dependencies via the _downloader_ and scan them afterwards.
*scanner* will automatically download the sources of the dependencies via the *downloader* and scan them afterwards.

We recommend to use ORT with one of the following scanners as their integration has been thoroughly tested (in
alphabetical order):
Expand All @@ -450,7 +450,7 @@ For a comparison of some of these, see this
## Storage Backends

In order to not download or scan any previously scanned sources again, or to reuse scan results generated via other
services, the _scanner_ can be configured to use so-called storage backends. Before processing a package, it checks
services, the *scanner* can be configured to use so-called storage backends. Before processing a package, it checks
whether compatible scan results are already available in one of the storages declared; if this is the case, they
are fetched and reused. Otherwise, the package's source code is downloaded and scanned. Afterwards, the new scan
results can be put into a storage for later reuse.
Expand All @@ -474,14 +474,14 @@ operation is considered successful if all writer storages could successfully per

The configuration of storage backends is located in the [ORT configuration file](#ort-configuration-file). (For the
general structure of this file and the set of options available refer to the
[reference configuration](./model/src/main/resources/reference.yml).) The file has a section named _storages_ that
[reference configuration](./model/src/main/resources/reference.yml).) The file has a section named *storages* that
lists all the storage backends and assigns them a name. Each storage backend is of a specific type and needs to be
configured with type-specific properties. The different types of storage backends supported by ORT are described below.

After the declaration of the storage backends, the configuration file has to specify which ones of them the
scanner should use for looking up existing scan results or to store new results. This is done in two list properties
named _storageReaders_ and _storageWriters_. The lists reference the names of the storage backends declared in the
_storages_ section. The scanner invokes the storage backends in the order they appear in the lists; so for readers,
named *storageReaders* and *storageWriters*. The lists reference the names of the storage backends declared in the
*storages* section. The scanner invokes the storage backends in the order they appear in the lists; so for readers,
this defines a priority for look-up operations. Each storage backend can act as a reader; however, some types do not
support updates and thus cannot serve as writers. If a storage backend is referenced both as reader and writer, the
scanner creates only a single instance of this storage class.
Expand All @@ -492,7 +492,7 @@ a storage entry (like `fileBasedStorage`) can be freely chosen. That name is the

### Local File Storage

By default, the _scanner_ stores scan results on the local file system in the current user's home directory (i.e.
By default, the *scanner* stores scan results on the local file system in the current user's home directory (i.e.
`~/.ort/scanner/scan-results`) for later reuse. Settings like the storage directory and the compression flag can be
customized in the ORT configuration file (`-c`) with a respective storage configuration:

Expand Down Expand Up @@ -554,7 +554,7 @@ ort:
The database needs to exist. If the schema is set to something else than the default of `public`, it needs to exist and
be accessible by the configured username.

The _scanner_ will itself create a table called `scan_results` and
The *scanner* will itself create a table called `scan_results` and
store the data in a [jsonb](https://www.postgresql.org/docs/current/datatype-json.html) column.

If you do not want to use SSL set the `sslmode` to `disable`, other possible values are explained in the
Expand All @@ -564,7 +564,7 @@ configuration options see [ScanStorageConfiguration.kt](./model/src/main/kotlin/
### ClearlyDefined Storage

[ClearlyDefined](https://clearlydefined.io) is a service offering curated metadata for Open Source components. This
includes scan results that can be used by ORT's _scanner_ tool (if they have been generated by a compatible scanner
includes scan results that can be used by ORT's *scanner* tool (if they have been generated by a compatible scanner
version with a suitable configuration). This storage backend queries the ClearlyDefined service for scan results of the
packages to be processed. It is read-only; so it will not upload any new scan results to ClearlyDefined. In the
configuration the URL of the ClearlyDefined service needs to be set:
Expand All @@ -583,13 +583,13 @@ ort:

[![Advisor](./logos/advisor.png)](./advisor/src/main/kotlin)

The _advisor_ retrieves security advisories from configured services. It requires the analyzer result as an input. For
The *advisor* retrieves security advisories from configured services. It requires the analyzer result as an input. For
all the packages identified by the analyzer, it queries the services configured for known security vulnerabilities. The
vulnerabilities returned by these services are then stored in the output result file together with additional
information like the source of the data and a severity (if available).

Multiple providers for security advisories are available. The providers require specific configuration in the
[ORT configuration file](./model/src/main/resources/reference.yml), which needs to be placed in the _advisor_
[ORT configuration file](./model/src/main/resources/reference.yml), which needs to be placed in the *advisor*
section. When executing the advisor the providers to enable are selected with the `--advisors` option (or its short
alias `-a`); here a comma-separated list with provider IDs is expected. The following sections describe the providers
supported by the advisor:
Expand Down Expand Up @@ -652,15 +652,15 @@ To enable this provider, pass `-a OSV` on the command line.

[![Evaluator](./logos/evaluator.png)](./evaluator/src/main/kotlin)

The _evaluator_ is used to perform custom license policy checks on scan results. The rules to check against are
The *evaluator* is used to perform custom license policy checks on scan results. The rules to check against are
implemented as Kotlin scripts with a dedicated DSL. See
[example.rules.kts](./examples/example.rules.kts) for an example rules script.

<a name="reporter">&nbsp;</a>

[![Reporter](./logos/reporter.png)](./reporter/src/main/kotlin)

The _reporter_ generates a wide variety of documents in different formats from ORT result files. Currently, the
The *reporter* generates a wide variety of documents in different formats from ORT result files. Currently, the
following formats are supported (reporter names are case-insensitive):

* [AsciiDoc Template](docs/reporters/asciidoc-templates.md) (`-f AsciiDocTemplate`)
Expand Down
6 changes: 3 additions & 3 deletions docs/config-file-copyright-garbage-yml.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# The `copyright-garbage.yml` file

The `copyright-garbage.yml` file allows to define which Copyright statements are to be considered as garbage, like any
invalid findings from a scanner. This can be done by literal strings or regular expression patterns. The _evaluator_ and
_reporter_ take the file as optional input. See the [copyright-garbage.yml example](../examples/copyright-garbage.yml)
invalid findings from a scanner. This can be done by literal strings or regular expression patterns. The *evaluator* and
*reporter* take the file as optional input. See the [copyright-garbage.yml example](../examples/copyright-garbage.yml)
as a base to get started.

## Command Line

Either create a file at the default location at `$ORT_CONFIG_DIR/copyright-garbage.yml`, or pass a custom file via the
`--copyright-garbage-file` option of the _evaluator_ or _reporter_. For example:
`--copyright-garbage-file` option of the *evaluator* or *reporter*. For example:

```bash
cli/build/install/ort/bin/ort report
Expand Down
20 changes: 10 additions & 10 deletions docs/config-file-curations-yml.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,22 @@ Curations can be used to:
* package description or URL to its homepage.
* set the concluded license for a package:
* concluded license is the license applicable to a package dependency defined as an SPDX license expression.
* set the _is_metadata_only_ flag:
* set the *is_metadata_only* flag:
* metadata-only packages, such as Maven BOM files, do not have any source code. Thus, when the flag is set the
_downloader_ just skips the download and the _scanner_ skips the scan. Also, any _evaluator rule_ may optionally skip
*downloader* just skips the download and the *scanner* skips the scan. Also, any *evaluator rule* may optionally skip
its execution.
* set the _is_modified_ flag:
* set the *is_modified* flag:
* indicates whether files of this package have been modified compared to the original files, e.g., in case of a fork
of an upstream Open Source project, or a copy of the code in this project's repository.
* set the _declared_license_mapping_ property:
* set the *declared_license_mapping* property:
* Packages may have declared license string values which cannot be parsed to SpdxExpressions. In some cases this can
be fixed by mapping these strings to a valid license. If multiple curations declare license mappings, they get
combined into a single mapping. Thus, multiple curations can contribute to the declared license mapping for the
package. The effect of its application can be seen in the _declared_license_processed_ property of the respective
package. The effect of its application can be seen in the *declared_license_processed* property of the respective
curated package.

The sections below explain how to create curations in the `curations.yml` file which,
if passed to the _analyzer_, is applied to all package metadata found in the analysis.
if passed to the *analyzer*, is applied to all package metadata found in the analysis.
If a license detected in the source code of a package needs to be corrected, add
a license finding curation in the [.ort.yml](config-file-ort-yml.md#curations) file for the project.

Expand All @@ -42,11 +42,11 @@ metadata contains information on how to locate the source code, but not always.
provides no VCS information, it points to outdated repositories or the repositories are not correctly tagged. Because it
is not always possible to fix this information in upstream packages, ORT offers a curation mechanism for metadata.

These curations can be configured in a YAML file that is passed to the _analyzer_. The data from the curations file
These curations can be configured in a YAML file that is passed to the *analyzer*. The data from the curations file
amends the metadata provided by the packages themselves. This way, it is possible to fix broken VCS URLs or provide the
location of source artifacts.

Hint: If the `concluded_license` _and_ the `authors` are curated, this package will be skipped during the `scan` step,
Hint: If the `concluded_license` *and* the `authors` are curated, this package will be skipped during the `scan` step,
as no more information from the scanner is required. This requires the `skipConcluded` scanner option to be enabled in
the [config.yml](../README.md#ort-configuration-file).

Expand Down Expand Up @@ -87,7 +87,7 @@ Where the list of available options for curations is defined in
## Command Line
To make ORT use the `curations.yml` file, put it to the default location of `$ORT_CONFIG_DIR/curations.yml` and then run
the _analyzer_:
the *analyzer*:

```bash
cli/build/install/ort/bin/ort analyze
Expand All @@ -103,7 +103,7 @@ in `$ORT_CONFIG_DIR/config.yml`. Similarly, ORT can use [ClearlyDefined](https:/
[reference configuration file](../model/src/main/resources/reference.yml) for examples.

To override curations, e.g. for testing them locally, you can also pass a `curations.yml` file or a curations directory
via the `--package-curations-file` / `--package-curations-dir` options of the _evaluator_:
via the `--package-curations-file` / `--package-curations-dir` options of the *evaluator*:

```bash
cli/build/install/ort/bin/ort evaluate
Expand Down
6 changes: 3 additions & 3 deletions docs/config-file-license-classifications-yml.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ The `license-classifications.yml` file holds a user-defined categorization of li
You can use the [license-classifications.yml example] as the base configuration
file for your scans.

The file consists of two sections: The first one, _categories_, allows defining arbitrary categories for grouping
The file consists of two sections: The first one, *categories*, allows defining arbitrary categories for grouping
licenses. Categories have a name and an optional description; the names must be unique.

The second section, _categorizations_, assigns licenses to the categories defined before. Licenses are identified
The second section, *categorizations*, assigns licenses to the categories defined before. Licenses are identified
using SPDX identifiers. Each license can be assigned an arbitrary number of categories by listing the names of these
categories. Note that only names can be used that reference one of the categories from the first section.

Expand Down Expand Up @@ -41,7 +41,7 @@ multiple orthogonal, partly overlapping sets of categories with different meanin
## Command Line

To use the `license-classifications.yml` file put it to `$ORT_CONFIG_DIR/license-classifications.yml` or pass it to the
`--license-classifications-file` option of the _evaluator_:
`--license-classifications-file` option of the *evaluator*:

```bash
cli/build/install/ort/bin/ort evaluate
Expand Down
Loading

0 comments on commit ea6ba0c

Please sign in to comment.