Skip to content

docs: update argument list for README/MANUAL #4393

@terriko

Description

@terriko

@mastersans has recently made some changes to the triage arguments used by cve-bin-tool. We've merged most of the docs changes needed now (most recently #4374) but I need someone to go through and make sure the listing in both README and MANUAL are up to date.

Readme list is here: https://github.com/intel/cve-bin-tool?tab=readme-ov-file#full-option-list
Manual list is after the table of contents here: https://github.com/intel/cve-bin-tool/blob/main/doc/MANUAL.md#cve-binary-tool-user-manual

  1. Make sure you have the latest code from github and have switched to the latest main branch.
  2. From the main directory of cve-bin-tool, run python -m cve_bin_tool.cli --help | less and view the list of arguments as they're printed. We want the part that starts at "optional arguments"
  3. You should be able to cut and paste just the arguments directly into MANUAL.md replacing the arguments that are there.
  4. README.md takes a bit more finesse as you need to make sure the links work, so you'll have to read it and make modifications.

This should be pretty doable by a beginner so I'll flag it as a good first issue, but we're running close to release so anyone should feel free to just get it done. (Normally I encourage experienced devs to leave the good first issues for beginners.)

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions