From 9215a4d29ee59c1c253747f1c4d459b2757c8f5b Mon Sep 17 00:00:00 2001 From: Bernhard Reiter Date: Thu, 27 Apr 2023 11:55:37 +0200 Subject: [PATCH 1/4] doc: improve rate default documentation solve #359 --- cmd/csaf_checker/main.go | 2 +- cmd/csaf_downloader/main.go | 2 +- docs/csaf_aggregator.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/cmd/csaf_checker/main.go b/cmd/csaf_checker/main.go index dd94a78e..645a17a6 100644 --- a/cmd/csaf_checker/main.go +++ b/cmd/csaf_checker/main.go @@ -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"` diff --git a/cmd/csaf_downloader/main.go b/cmd/csaf_downloader/main.go index 5feb96fc..e7ceb4dd 100644 --- a/cmd/csaf_downloader/main.go +++ b/cmd/csaf_downloader/main.go @@ -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"` diff --git a/docs/csaf_aggregator.md b/docs/csaf_aggregator.md index 3c572db7..64491f8b 100644 --- a/docs/csaf_aggregator.md +++ b/docs/csaf_aggregator.md @@ -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") From 556ec5c680e648eb2703aaf13fb87fa86e3eeb9a Mon Sep 17 00:00:00 2001 From: "Sascha L. Teichmann" Date: Thu, 27 Apr 2023 14:40:00 +0200 Subject: [PATCH 2/4] Adjust downloader doc, too. --- docs/csaf_downloader.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/csaf_downloader.md b/docs/csaf_downloader.md index bf3f1943..79e333c4 100644 --- a/docs/csaf_downloader.md +++ b/docs/csaf_downloader.md @@ -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 From c50990f88557f2c5135d124096729f53527aed29 Mon Sep 17 00:00:00 2001 From: tschmidtb51 <65305130+tschmidtb51@users.noreply.github.com> Date: Mon, 1 May 2023 20:24:52 +0200 Subject: [PATCH 3/4] doc(csaf_checker): Add missing phrase, correct spelling --- docs/csaf_checker.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/csaf_checker.md b/docs/csaf_checker.md index 3c52f9a7..890fc369 100644 --- a/docs/csaf_checker.md +++ b/docs/csaf_checker.md @@ -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 @@ -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: From 49e2441537d60514d57214a182b207850d62ff2f Mon Sep 17 00:00:00 2001 From: tschmidtb51 <65305130+tschmidtb51@users.noreply.github.com> Date: Mon, 1 May 2023 20:25:52 +0200 Subject: [PATCH 4/4] docs(csaf_checker): correct format mistake --- docs/csaf_checker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/csaf_checker.md b/docs/csaf_checker.md index 890fc369..e4188135 100644 --- a/docs/csaf_checker.md +++ b/docs/csaf_checker.md @@ -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 (defaults to unlimited)" + -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