From 4841e02c019c3c714704460bc4f320083a8fbd4d Mon Sep 17 00:00:00 2001 From: Sebastian Schuberth Date: Wed, 28 Aug 2024 12:23:51 +0200 Subject: [PATCH] docs(analyzer): Clarify the input directory to be version-controlled This is until [1] is resolved. [1]: https://github.com/oss-review-toolkit/ort/issues/8803 Signed-off-by: Sebastian Schuberth --- website/docs/tools/analyzer.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/tools/analyzer.md b/website/docs/tools/analyzer.md index d8a510e4d6bcf..a9d0918951034 100644 --- a/website/docs/tools/analyzer.md +++ b/website/docs/tools/analyzer.md @@ -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.