Update documentation for vuln scanning to match behaviour#8
Merged
andrew merged 1 commit intogit-pkgs:mainfrom Feb 25, 2026
Merged
Conversation
ashokfaire
changed the title
andrew
approved these changes
Feb 25, 2026
Contributor
|
Good catch, thanks! |
Contributor
|
The build failure isn't your fault, I'm working on a fix seperately |
To run the scan, I believe you need to pass the subcommand. It looks like these documentation examples arrived very early in the repo and haven't changed, so I assume the behaviour I'm getting in 0.14.0 should match the documentation.
andrew
force-pushed
the
tweak-vulns-scan-example-in-readme
branch
from
179c679 to
3bfa27e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adjust the examples for running a vulnerability scan. (179c679)
To run the scan, I believe you need to pass the subcommand. It looks like these documentation examples arrived very early in the repo and haven't changed, so I assume the behaviour I'm getting in 0.14.0 should match the documentation.
If I run the first example in the index page,
git pkgs vulnsin 0.14.0 I get back the help message for vulns' subcommands.(The documentation here is still somewhat incomplete, but I've filed a separate issue about that: git-pkgs/git-pkgs#131.)