Skip to content

chore: fix documentation and remove older test #4374

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

Merged
merged 4 commits into from
Aug 26, 2024
Merged

Conversation

mastersans
Copy link
Member

  • fixed documentation regarding triaging option(removed docs for --triage-input-file flag)
  • remove older test_triage.py test as newer test are present in test_vex.py
  • remove older test data file related to deprecated .vex format

cc @terriko @anthonyharrison

Copy link
Contributor

@terriko terriko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! spellcheck is complaining that CDX needs to be added to the dictionary.

@terriko terriko added this to the 3.4 milestone Aug 22, 2024
@terriko
Copy link
Contributor

terriko commented Aug 22, 2024

Oh, and while you're in there: looks like we could also use some entries for

  --product PRODUCT     Product Name
  --release RELEASE     Release Version
  --vendor VENDOR       Vendor/Supplier of Product
  -rr REVISION_REASON, --revision-reason REVISION_REASON

They can just point to the vex docs. We might want to consider grouping them together in a vex-flags group or something? I'm not sure how to make them easier to read in the --help output.

@mastersans
Copy link
Member Author

@terriko test should be fixed now, had to reinstall to solve the freeze issue.

Copy link
Contributor

@terriko terriko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. We probably need to update the full argument list in both README and MANUAL so it matches the new actual cve-bin-tool --help output, but I'll open a separate issue for that.

@terriko terriko merged commit 77397f8 into intel:main Aug 26, 2024
21 checks passed
@mastersans mastersans deleted the fix-docs branch August 29, 2024 16:55
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

Successfully merging this pull request may close these issues.

2 participants