From 225e8d9cef1872112cff8d7d77ac9dcde4678391 Mon Sep 17 00:00:00 2001 From: Martin Nonnenmacher Date: Wed, 16 Sep 2020 16:46:33 +0200 Subject: [PATCH] docs: Mention the default locations in the configuration file docs Signed-off-by: Martin Nonnenmacher --- docs/config-file-copyright-garbage-yml.md | 3 ++- docs/config-file-curations-yml.md | 3 ++- docs/config-file-licenses-yml.md | 3 ++- docs/config-file-package-configuration-yml.md | 5 +++-- docs/config-file-resolutions-yml.md | 3 ++- docs/file-rules-kts.md | 3 ++- docs/how-to-fix-text-provider-kts.md | 4 ++-- 7 files changed, 15 insertions(+), 9 deletions(-) diff --git a/docs/config-file-copyright-garbage-yml.md b/docs/config-file-copyright-garbage-yml.md index 4e1151844484b..bee8bb1be1d9f 100644 --- a/docs/config-file-copyright-garbage-yml.md +++ b/docs/config-file-copyright-garbage-yml.md @@ -11,7 +11,8 @@ provides a way to clean up such errors across all scans. ## Command Line -To use the `copyright-garbage.yml` file pass it to the `--copyright-garbage-file` option of the _reporter_: +To use the `copyright-garbage.yml` file put it to `$ORT_CONFIG_DIR/copyright-garbage.yml` or pass it to the +`--copyright-garbage-file` option of the _reporter_: ```bash cli/build/install/ort/bin/ort report diff --git a/docs/config-file-curations-yml.md b/docs/config-file-curations-yml.md index 51ce6fa40ce60..ba7b3c5ec553c 100644 --- a/docs/config-file-curations-yml.md +++ b/docs/config-file-curations-yml.md @@ -75,7 +75,8 @@ The structure of the curations file consist of one or more `id` entries: ## Command Line -To use the `curations.yml` file pass it to the `--package-curations-file` option of the _analyzer_: +To use the `curations.yml` file put it to `$ORT_CONFIG_DIR/curations.yml` or pass it to the `--package-curations-file` +option of the _analyzer_: ``` cli/build/install/ort/bin/ort analyze diff --git a/docs/config-file-licenses-yml.md b/docs/config-file-licenses-yml.md index 5b197b7700ae6..3e1a0813753dd 100644 --- a/docs/config-file-licenses-yml.md +++ b/docs/config-file-licenses-yml.md @@ -13,7 +13,8 @@ Licenses can be assigned to license sets like "permissive" or "public domain" wh ## Command Line -To use the `licenses.yml` file pass it to the `--license-configuration-file` option of the _evaluator_: +To use the `licenses.yml` file put it to `$ORT_CONFIG_DIR/licenses.yml` or pass it to the `--license-configuration-file` +option of the _evaluator_: ```bash cli/build/install/ort/bin/ort evaluate diff --git a/docs/config-file-package-configuration-yml.md b/docs/config-file-package-configuration-yml.md index 92c8791c1746c..d55ddd264b86d 100644 --- a/docs/config-file-package-configuration-yml.md +++ b/docs/config-file-package-configuration-yml.md @@ -74,8 +74,9 @@ Note that in both of the above options only one package configuration can exist ### Using a Package Configuration Directory -To use a directory with configuration files for each *package id*, pass it to the `--package-configuration-dir` option -of the _evaluator_: +By default, ORT uses a directory with configuration files for each *package id* located at +`$ORT_CONFIG_DIR/package-configurations/`. To use a custom location you can pass it to the `--package-configuration-dir` +option of the _evaluator_: ```bash cli/build/install/ort/bin/ort evaluate diff --git a/docs/config-file-resolutions-yml.md b/docs/config-file-resolutions-yml.md index a925974fb163d..14882a8e421a9 100644 --- a/docs/config-file-resolutions-yml.md +++ b/docs/config-file-resolutions-yml.md @@ -86,7 +86,8 @@ rule_violations: ## Command Line -To use the `resolutions.yml` file pass it to the `--resolutions-file` option of the _reporter_: +To use the `resolutions.yml` file put it to `$ORT_CONFIG_DIR/resolutions.yml` or pass it to the `--resolutions-file` +option of the _reporter_: ```bash cli/build/install/ort/bin/ort report diff --git a/docs/file-rules-kts.md b/docs/file-rules-kts.md index 6eb64d332cf7a..02714bf0c2930 100644 --- a/docs/file-rules-kts.md +++ b/docs/file-rules-kts.md @@ -12,7 +12,8 @@ example depends on the licenses categorizations defined in the [licenses.yml exa ## Command Line -To use the `rules.kts` file pass it to the `--rules-file` option of the _evaluator_: +To use the `rules.kts` file put it to `$ORT_CONFIG_DIR/rules.kts` or pass it to the `--rules-file` option of the +_evaluator_: ```bash cli/build/install/ort/bin/ort evaluate \ diff --git a/docs/how-to-fix-text-provider-kts.md b/docs/how-to-fix-text-provider-kts.md index ab6fbe121f635..d338ceb00ef28 100644 --- a/docs/how-to-fix-text-provider-kts.md +++ b/docs/how-to-fix-text-provider-kts.md @@ -8,8 +8,8 @@ to create your custom how-to-fix messages in the generated reports. ## Command Line -To use the `how-to-fix-text-provider.kts` file and pass it to the `--how-to-fix-text-provider-script` option of the -_Reporter_: +To use the `how-to-fix-text-provider.kts` file put it to `$ORT_CONFIG_DIR/how-to-fix-text-provider.kts` or pass it to +the `--how-to-fix-text-provider-script` option of the _Reporter_: ```bash cli/build/install/ort/bin/ort report