Skip to content

Commit

Permalink
docs(analyzer): Name precondition for analysis to work
Browse files Browse the repository at this point in the history
Signed-off-by: Sebastian Schuberth <sebastian@doubleopen.org>
  • Loading branch information
sschuberth committed Aug 28, 2024
1 parent 38c9efd commit a82f01c
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion website/docs/tools/analyzer.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@ sidebar_position: 1

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 is the only mandatory tool to run from ORT as its output is the input for all other tools.
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.
Analysis works 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 if the following preconditions are met:

* All projects use one of the package managers listed below in a reasonably recent version, and they are configured according to common best practices.
* All projects can be built in a single step out-of-the-box, without any custom confguration being set, like build system properties or environment variables.

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.
It can be further processed or manually edited before passing it to one of the other tools.
Expand Down

0 comments on commit a82f01c

Please sign in to comment.