Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

examples: Move and rename tag-value samples #126

Merged
merged 1 commit into from Mar 31, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion examples/1-load/example_load.go
Expand Up @@ -4,7 +4,7 @@

// This example demonstrates loading an SPDX tag-value file from disk into
// memory, and printing some of its contents to standard output.
// Run project: go run example_load.go ../sample-docs/example1/spdx/SPDXTagExample-v2.2.spdx
// Run project: go run example_load.go ../sample-docs/tv/hello.spdx

package main

Expand Down
2 changes: 1 addition & 1 deletion examples/2-load-save/example_load_save.go
Expand Up @@ -4,7 +4,7 @@

// This example demonstrates loading an SPDX tag-value file from disk into memory,
// and re-saving it to a different file on disk.
// Run project: go run example_load_save.go ../sample-docs/example1/spdx/SPDXTagExample-v2.2.spdx test.spdx
// Run project: go run example_load_save.go ../sample-docs/tv/hello.spdx test.spdx

package main

Expand Down
2 changes: 1 addition & 1 deletion examples/5-report/example_report.go
Expand Up @@ -5,7 +5,7 @@
// This example demonstrates loading an SPDX tag-value file from disk into memory,
// generating a basic report listing counts of the concluded licenses for its
// files, and printing the report to standard output.
// Run project: go run example_report.go ../sample-docs/example1/spdx/SPDXTagExample-v2.2.spdx
// Run project: go run example_report.go ../sample-docs/tv/hello.spdx
package main

import (
Expand Down
2 changes: 1 addition & 1 deletion examples/6-licensediff/example_licensediff.go
Expand Up @@ -8,7 +8,7 @@
// This is generally only useful when run with two SPDX documents that
// describe licenses for subsequent versions of the same set of files, AND if
// they have the same identifier in both documents.
// Run project: go run example_licensediff.go ../sample-docs/example1/spdx/SPDXTagExample-v2.2.spdx ../sample-docs/example2/spdx/SPDXTagExample-v2.2.spdx
// Run project: go run example_licensediff.go ../sample-docs/tv/hello.spdx ../sample-docs/tv/SPDXTagExample-v2.2.spdx
package main

import (
Expand Down
2 changes: 1 addition & 1 deletion examples/9-tvtojson/exampletvtojson.go
Expand Up @@ -4,7 +4,7 @@

// This example demonstrates loading an SPDX tag-value file from disk into memory,
// and re-saving it to a different json file on disk.
// Run project: go run exampletvtojson.go ../sample-docs/example1/spdx/SPDXTagExample-v2.2.spdx example.json
// Run project: go run exampletvtojson.go ../sample-docs/tv/hello.spdx example.json
package main

import (
Expand Down
10 changes: 5 additions & 5 deletions examples/README.md
Expand Up @@ -12,15 +12,15 @@ within the example's subdirectory.

This example demonstrates loading an SPDX tag-value file from disk into memory,
and printing some of its contents to standard output.
#### Run project: *go run example_load.go ../sample-docs/example1/spdx/SPDXTagExample-v2.2.spdx*
#### Run project: *go run example_load.go ../sample-docs/tv/hello.spdx*

## 2-load-save/

*tvloader*, *tvsaver*

This example demonstrates loading an SPDX tag-value file from disk into memory,
and re-saving it to a different file on disk.
#### Run project: *go run example_load_save.go ../sample-docs/example1/spdx/SPDXTagExample-v2.2.spdx test.spdx*
#### Run project: *go run example_load_save.go ../sample-docs/tv/hello.spdx test.spdx*

## 3-build/

Expand Down Expand Up @@ -48,7 +48,7 @@ Package and File license fields; and saving the resulting document to disk.
This example demonstrates loading an SPDX tag-value file from disk into memory,
generating a basic report listing counts of the concluded licenses for its
files, and printing the report to standard output.
#### Run project: *go run example_report.go ../sample-docs/example1/spdx/SPDXTagExample-v2.2.spdx*
#### Run project: *go run example_report.go ../sample-docs/tv/hello.spdx*

## 6-licensediff

Expand All @@ -61,7 +61,7 @@ with matching IDs in each document.
This is generally only useful when run with two SPDX documents that describe
licenses for subsequent versions of the same set of files, AND if they have
the same identifier in both documents.
#### Run project: *go run example_licensediff.go ../sample-docs/example1/spdx/SPDXTagExample-v2.2.spdx ../sample-docs/example2/spdx/SPDXTagExample2-v2.2.spdx*
#### Run project: *go run example_licensediff.go ../sample-docs/tv/hello.spdx ../sample-docs/tv/SPDXTagExample2-v2.2.spdx*

## 7-rdfloader

Expand All @@ -85,7 +85,7 @@ and then re-saving it to a different file on disk in tag-value format.

This example demonstrates loading an SPDX tag-value from disk into memory
and then re-saving it to a different file on disk in json format.
#### Run project: *go run exampletvtojson.go ../sample-docs/example1/spdx/SPDXTagExample-v2.2.spdx example.json*
#### Run project: *go run exampletvtojson.go ../sample-docs/tv/hello.spdx example.json*

## 10-jsonloader

Expand Down