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.

Sign up for GitHub

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

doc: improve rate default documentation #364

Merged
merged 4 commits into from
May 1, 2023
Merged

doc: improve rate default documentation #364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9215a4d
doc: improve rate default documentation
bernhardreiter Apr 27, 2023
556ec5c
Adjust downloader doc, too.
s-l-teichmann Apr 27, 2023
c50990f
doc(csaf_checker): Add missing phrase, correct spelling
tschmidtb51 May 1, 2023
49e2441
docs(csaf_checker): correct format mistake
tschmidtb51 May 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/csaf_checker/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ type options struct {
ClientKey *string `long:"client-key" description:"TLS client private key file (PEM encoded data)" value-name:"KEY-FILE"`
Version bool `long:"version" description:"Display version of the binary"`
Verbose bool `long:"verbose" short:"v" description:"Verbose output"`
Rate *float64 `long:"rate" short:"r" description:"The average upper limit of https operations per second"`
Rate *float64 `long:"rate" short:"r" description:"The average upper limit of https operations per second (defaults to unlimited)"`
Years *uint `long:"years" short:"y" description:"Number of years to look back from now" value-name:"YEARS"`
ExtraHeader http.Header `long:"header" short:"H" description:"One or more extra HTTP header fields"`

Expand Down
2 changes: 1 addition & 1 deletion cmd/csaf_downloader/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ type options struct {
Insecure bool `long:"insecure" description:"Do not check TLS certificates from provider"`
Version bool `long:"version" description:"Display version of the binary"`
Verbose bool `long:"verbose" short:"v" description:"Verbose output"`
Rate *float64 `long:"rate" short:"r" description:"The average upper limit of https operations per second"`
Rate *float64 `long:"rate" short:"r" description:"The average upper limit of https operations per second (defaults to unlimited)"`

ExtraHeader http.Header `long:"header" short:"H" description:"One or more extra HTTP header fields"`

Expand Down
2 changes: 1 addition & 1 deletion docs/csaf_aggregator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ workers // number of parallel workers to start (default 10)
folder // target folder on disc for writing the downloaded documents (default "/var/www")
web // directory to be served by the webserver (default "/var/www/html")
domain // base url where the contents will be reachable from outside (default "https://example.com")
rate // downloading limit per worker in HTTPS req/s (default: no limiting)
rate // downloading limit per worker in HTTPS req/s (defaults to unlimited)
insecure // do not check validity of TLS certificates
write_indices // write index.txt and changes.csv
update_interval // to indicate the collection interval for a provider (default ""on best effort")
Expand Down
4 changes: 2 additions & 2 deletions docs/csaf_checker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Application Options:
--client-key=KEY-FILE TLS client private key file (PEM encoded data)
--version Display version of the binary
-v, --verbose Verbose output
-r, --rate= The average upper limit of https operations per second
-r, --rate= The average upper limit of https operations per second (defaults to unlimited)
-y, --years=YEARS Number of years to look back from now
-H, --header= One or more extra HTTP header fields
--validator=URL URL to validate documents remotely
Expand All @@ -28,7 +28,7 @@ Help Options:

Will check all given _domains_, by trying each as a CSAF provider.

If a _domain_ starts with `https://` it is instead considered a direct URL to the `provider-metadata.json` and checking procedes from there.
If a _domain_ starts with `https://` it is instead considered a direct URL to the `provider-metadata.json` and checking proceeds from there.


Usage example:
Expand Down
2 changes: 1 addition & 1 deletion docs/csaf_downloader.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Application Options:
--insecure Do not check TLS certificates from provider
--version Display version of the binary
-v, --verbose Verbose output
-r, --rate= The average upper limit of https operations per second
-r, --rate= The average upper limit of https operations per second (defaults to unlimited)
-H, --header= One or more extra HTTP header fields
--validator=URL URL to validate documents remotely
--validatorcache=FILE FILE to cache remote validations
Expand Down