Skip to content

Commit

Permalink
docs(analyzer): Clarify the input directory to be version-controlled
Browse files Browse the repository at this point in the history
This is until [1] is resolved.

[1]: #8803

Signed-off-by: Sebastian Schuberth <sebastian@doubleopen.org>
  • Loading branch information
sschuberth committed Aug 28, 2024
1 parent 1cd9699 commit 4841e02
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion website/docs/tools/analyzer.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 1

# Analyzer

The *analyzer* is a Software Composition Analysis (SCA) tool that determines the dependencies of software projects inside the specified input directory (`-i`).
The *analyzer* is a Software Composition Analysis (SCA) tool that determines the dependencies of software projects inside the specified version-controlled 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 [OrtResult](https://github.com/oss-review-toolkit/ort/blob/main/model/src/main/kotlin/OrtResult.kt) in YAML (or JSON, see `-f`) format to a file named `analyzer-result.yml` in the specified output directory (`-o`).
The output file exactly documents the status quo of all package-related metadata.
Expand Down

0 comments on commit 4841e02

Please sign in to comment.