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

docs: Fixed a few links in manual.md #4687

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

vedpawar2254
Copy link
Contributor

Fixed few links and their order, also changed the name to make it little more consistant

let me know if anything else is needed
Thanks

@vedpawar2254 vedpawar2254 changed the title Fixed a few links in manual.md [doc] Fixed a few links in manual.md Jan 12, 2025
@vedpawar2254 vedpawar2254 changed the title [doc] Fixed a few links in manual.md docs: Fixed a few links in manual.md Jan 12, 2025
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.

I always appreciate improved links, BUT:

  • I think if the desired parameter is a file for both, let's go with SBOM_FILENAME and VEX_FILENAME rather than having either of them be OUTPUT.
  • We should change these in the code as well so that the help text matches whatever's in the manual
  • Once the code is changed, you'll need to make update the sections where we list arguments (in MANUAL.md and README.md) to match what cve-bin-tool --help actually generates.

But your instinct to at least fix the parameter names is a good one, and can be done now! Let's just make them both FILENAME instead of OUPTUT.

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