Mirrors/syft
2
0
Fork 0
mirror of https://github.com/anchore/syft synced 2024-09-19 21:51:56 +00:00
Code Issues Projects Releases Packages Wiki Activity

chore: fix some comments (#3114)

Browse source 
Signed-off-by: luozexuan <fetchcode@139.com>
This commit is contained in:
luozexuan 2024-08-13 00:08:04 +08:00 committed by GitHub
parent cf85450e08
commit c19cf626ab
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
DEVELOPING.md
View file

@ -83,7 +83,7 @@ Syft's core library is implemented in the `syft` package and subpackages, where
- the `syft` package contains a single function that can take a `source.Source` object and catalog it, producing an `sbom.SBOM` object
- the `syft/format` package contains the ability to encode and decode SBOMs to and from different SBOM formats (such as SPDX and CycloneDX)
The `cmd` pacakge at the highest level execution flow wires up [`spf13/cobra`](https://github.com/spf13/cobra) commands for execution in the main application:
The `cmd` package at the highest level execution flow wires up [`spf13/cobra`](https://github.com/spf13/cobra) commands for execution in the main application:
```mermaid
sequenceDiagram
participant main as cmd/syft/main

2
cmd/syft/internal/options/format.go
View file

@ -50,7 +50,7 @@ if false, uses the syft-json output for templating (which follows the syft JSON
Note: long term support for this option is not guaranteed (it may change or break at any time)`)
prettyDescription := `include space indention and newlines
prettyDescription := `include space indentation and newlines
note: inherits default value from 'format.pretty' or 'false' if parent is unset`
descriptions.Add(&o.SyftJSON.Pretty, prettyDescription)
descriptions.Add(&o.SPDXJSON.Pretty, prettyDescription)

2
internal/cache/README.md vendored
View file

@ -1,6 +1,6 @@
# Caching
All caches are created from a global `manager`. By defaut this is a `bypassedCache`, which performs no caching.
All caches are created from a global `manager`. By default this is a `bypassedCache`, which performs no caching.
One benefit of this is that tests don't need to worry about caching causing issues unless they explicitly need
to test the cache and can opt-in using the `cache.TestCache(t)` helper.

2
test/cli/cyclonedx_valid_test.go
View file

@ -12,7 +12,7 @@ import (
"github.com/anchore/syft/syft/format/cyclonedxjson"
)
// We have schema validation mechanims in schema/cyclonedx/
// We have schema validation mechanisms in schema/cyclonedx/
// This test allows us to double check that validation against the cyclonedx-cli tool
func TestValidCycloneDX(t *testing.T) {
imageFixture := func(t *testing.T) string {