Merge branch 'main' into checker-timerange-report

gocsaf · Aug 16, 2023 · fa0a665 · fa0a665
2 parents 16603ea + 2d1dc18
commit fa0a665
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 11 deletions.
diff --git a/cmd/csaf_downloader/config.go b/cmd/csaf_downloader/config.go
@@ -30,10 +30,9 @@ type config struct {
 	Rate                 *float64          `long:"rate" short:"r" description:"The average upper limit of https operations per second (defaults to unlimited)" toml:"rate"`
 	Worker               int               `long:"worker" short:"w" description:"NUMber of concurrent downloads" value-name:"NUM" toml:"worker"`
 	Range                *models.TimeRange `long:"timerange" short:"t" description:"RANGE of time from which advisories to download" value-name:"RANGE" toml:"timerange"`
-	Folder               string            `long:"folder" short:"f" description:"Download into a given FOLDER" value-name:"FOLDER" toml:"folder"`
-	IgnorePattern        []string          `long:"ignorepattern" short:"i" description:"Dont download files if there URLs match any of the given PATTERNs" value-name:"PATTERN" toml:"ignorepattern"`
-
-	ExtraHeader http.Header `long:"header" short:"H" description:"One or more extra HTTP header fields" toml:"header"`
+	Folder               string            `long:"folder" short:"f" description:"Download into a given subFOLDER" value-name:"FOLDER" toml:"folder"`
+	IgnorePattern        []string          `long:"ignorepattern" short:"i" description:"Do not download files if their URLs match any of the given PATTERNs" value-name:"PATTERN" toml:"ignorepattern"`
+	ExtraHeader          http.Header       `long:"header" short:"H" description:"One or more extra HTTP header fields" toml:"header"`
 
 	RemoteValidator        string   `long:"validator" description:"URL to validate documents remotely" value-name:"URL" toml:"validator"`
 	RemoteValidatorCache   string   `long:"validatorcache" description:"FILE to cache remote validations" value-name:"FILE" toml:"validatorcache"`

diff --git a/docs/csaf_downloader.md b/docs/csaf_downloader.md
@@ -15,8 +15,8 @@ Application Options:
   -r, --rate=                      The average upper limit of https operations per second (defaults to unlimited)
   -w, --worker=NUM                 NUMber of concurrent downloads (default: 2)
   -t, --timerange=RANGE            RANGE of time from which advisories to download
-  -f, --folder=FOLDER              Download into a given FOLDER
-  -i, --ignorepattern=PATTERN      Dont download files if there URLs match any of the given PATTERNs
+  -f, --folder=FOLDER              Download all into a given subFOLDER
+  -i, --ignorepattern=PATTERN      Do not download files if their URLs match any of the given PATTERNs
   -H, --header=                    One or more extra HTTP header fields
       --validator=URL              URL to validate documents remotely
       --validatorcache=FILE        FILE to cache remote validations
@@ -91,13 +91,16 @@ into a given intervall. There are three possible notations:
 
 All interval boundaries are inclusive.
 
-If the `folder` option is given the advisories are stored in this folder. 
-If it is omitted (by default) the advisories are stored in folder name by the
-year they are from.
+If the `folder` option is given all the advisories are stored in a subfolder
+of this name. Otherwise the advisories are each stored in a folder named
+by the year they are from.
 
 You can ignore certain advisories while downloading by specifying a list
-of regular expressions to match their URLs by using the `ignorepattern` option. 
-E.g. `-i='.*white.*' -i='*.red.*'` will ignore files which URLs contain the sub strings **white** or **red**.
+of regular expressions to match their URLs by using the `ignorepattern`
+option.
+
+E.g. `-i='.*white.*' -i='*.red.*'` will ignore files which URLs contain
+the sub strings **white** or **red**.
 In the config file this has to be noted as:
 ```
 ignorepattern = [".*white.*", ".*red.*"]