cve-bin-tool icon indicating copy to clipboard operation
cve-bin-tool copied to clipboard

fix: add docs + test for initial no-scan work

Open terriko opened this issue 6 months ago • 4 comments

I'm going to get this merged as-is, but I'll set up an issue reminding us that we want a test and a preliminary docs entry (likely explaining what works and what doesn't, such as the fact that it won't operate without cve data yet)

Originally posted by @terriko in https://github.com/intel/cve-bin-tool/pull/5122#pullrequestreview-2911437168

Making this as a reminder for @joydeep049 We'd like

  • a really basic test (i.e. something that shows that the --no-scan flag can be used from the CLI but doens't care much what it does)
  • some initial information for the docs, likely explaining what works now and maybe a section about what's planned.

terriko avatar Jun 09 '25 21:06 terriko

Should we wait and add a bit more features before updating the docs? I was hoping to get the language parser work done before changing the documentation, as discussed in the last meet. Or I could also add some docs now as well. Totally fine with me

joydeep049 avatar Jun 10 '25 05:06 joydeep049

I think we want really short "this option exists but it doesn't fully work yet" probably both in the help text and in the manual or readme. Mostly I don't want people who haven't been following development to get too excited when they see it in the pre-release.

terriko avatar Jun 10 '25 15:06 terriko

Hi! @terriko I’d like to work on this issue as part of my GSoC 2026 preparation. I’ve set up the CVE Binary Tool locally and can reproduce the bug. May I please get this assigned to me?

amritamishra01 avatar Nov 12 '25 12:11 amritamishra01

Hi @terriko Just a reminder, I've already added PR for the docs work here

joydeep049 avatar Nov 12 '25 17:11 joydeep049