Repository navigation
docs(cli): document -C output set and distinguish it from moria's -C - #38
Merged
Merged
Conversation
The -C/--outdir man entry only mentioned mithril-report.json, but -C also writes sbom.cdx.json and sbom.spdx.json when the SBOM pass runs, and those standard-format SBOMs are reachable only through -C (the JSON report carries components inline, but not the CycloneDX/SPDX documents). Spell that out in the man page and README, and note that moria(1) also has a -C that means something different (its extraction output directory) so a moria user is not surprised. Docs only; no behavior change.
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Docs-only cleanup of
-C/--outdir.-Centry only mentionedmithril-report.json, but-Calso writessbom.cdx.jsonandsbom.spdx.jsonwhen the SBOM pass runs. Thosestandard-format SBOMs are reachable only through
-C(the JSON reportcarries components inline, but not the CycloneDX/SPDX documents). The man page
now says so.
moria(1)also has a-C, but it means that tool'sextraction output directory, whereas mithril's is the report output directory,
so a moria user is not surprised.
from
-C.No behavior change. Builds on the flag-coherence PR; its base retargets on
merge.