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: update argument list #4443

Merged
merged 2 commits into from
Sep 16, 2024
Merged

Conversation

AryanBakliwal
Copy link
Contributor

fixes: #4393

Updated the arguments list in both MANUAL.md and README.md

Signed-off-by: Aryan Bakliwal <[email protected]>
Copy link
Member

@mastersans mastersans left a comment

Choose a reason for hiding this comment

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

Hi Thanks for the Pull Request, I have minor nitpick.

README.md Outdated Show resolved Hide resolved

CVE Data Download:
Arguments related to data sources and Cache Configuration

-n {api,api2,json-nvd,json-mirror}, --nvd {api,api2,json-nvd,json-mirror}
-n {api,api2,json,json-mirror,json-nvd}, --nvd {api,api2,json,json-mirror,json-nvd}
Copy link
Member

Choose a reason for hiding this comment

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

@terriko I was wondering should we remove "api" its been time since we deprecated nvd api 1

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm intending to keep it until we declare 4.0. Right now it's barely any work to just leave it there so I wasn't going to worry about it until we start looking at stuff like re-architecting for no-scan mode.

doc/MANUAL.md Outdated Show resolved Hide resolved
Signed-off-by: Aryan Bakliwal <[email protected]>
@AryanBakliwal
Copy link
Contributor Author

I have addressed the changes pointed out by @mastersans and also some other minor inconsistencies. Should I change these in the cli file as well?

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.

Thank you for doing this!

I'm going to merge this but please go ahead and make changes to cli.py as needed to make it match in a separate PR.

@terriko terriko merged commit 31f15bf into intel:main Sep 16, 2024
21 checks passed
@AryanBakliwal AryanBakliwal deleted the update_argslist branch September 27, 2024 18:41
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.

docs: update argument list for README/MANUAL
3 participants