Skip to content

Commit 73570ad

Browse files
authored
docs: Update documentation with fixes (#2197)
Fixes #2182 Fixes #2174
1 parent a229bb8 commit 73570ad

2 files changed

Lines changed: 8 additions & 2 deletions

File tree

docs/supported_languages_and_lockfiles.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,3 +142,9 @@ Run the command below for detection:
142142
```
143143
./osv-scanner scan source -r /path/to/folder/you/want/to/scan
144144
```
145+
146+
### Known limitations
147+
148+
When scanning a file in the `osv-scanner.json` format, using the `--format=spdx` flag produces incorrect output.
149+
150+
For more details, see issue [#2192](https://github.com/google/osv-scanner/issues/2192).

docs/usage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -163,11 +163,11 @@ docker pull ghcr.io/google/osv-scanner:latest
163163
Once you have the image, you can test that it works by running:
164164

165165
```bash
166-
docker run -it ghcr.io/google/osv-scanner -h
166+
docker run ghcr.io/google/osv-scanner -h
167167
```
168168

169169
To run a scan, mount the directory to scan to `/src` and pass the necessary flags:
170170

171171
```bash
172-
docker run -it -v ${PWD}:/src ghcr.io/google/osv-scanner -L /src/go.mod
172+
docker run -v ${PWD}:/src ghcr.io/google/osv-scanner -L /src/go.mod
173173
```

0 commit comments

Comments
 (0)