Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make known-unknowns more clear in the reports #1204

Open
rnjudge opened this issue Jan 4, 2023 · 1 comment
Open

Make known-unknowns more clear in the reports #1204

rnjudge opened this issue Jan 4, 2023 · 1 comment

Comments

@rnjudge
Copy link
Contributor

rnjudge commented Jan 4, 2023

Describe the Feature
In a discussion with @vargenau and his colleague, they mentioned that it would be nice to know known-unknowns in a container. This information is available from Tern but can sometimes be buried in the report. Proposal to make this information more clear.

Use Cases
When individuals are inventorying containers it is helpful to understand the limits of Tern's analysis so that users can know what further analysis needs to be done.

Implementation Changes
Changes to the output reporting. Perhaps a list of known unknowns in the default report? Also changing the wording in other report formats to make it more clear that further analysis is required. currently Tern reports say: Unknown content included in layer {files}. Please analyze these files separately or Unknown content. Additional analysis may be required

@vargenau thoughts on this? What would be most helpful/clear?

@vargenau
Copy link
Contributor

vargenau commented Jan 5, 2023

Hi @rnjudge,

Thank you for taking our request under consideration.

Currently, the messages are put in the PackageComment of each affected package.
It would be better to have them grouped in a separate section at the beginning of the SPDX file.

It could be:

  • in the DocumentComment field,
  • or in the PackageComment of the top-level package.

I would keep them also in the affected packages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants