improve downloder: documenation for folder option

gocsaf · Aug 15, 2023 · 9e3217e · 9e3217e
1 parent 7288007
commit 9e3217e
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/cmd/csaf_downloader/config.go b/cmd/csaf_downloader/config.go
@@ -29,7 +29,7 @@ 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"`
+	Folder               string            `long:"folder" short:"f" description:"Download into a given subFOLDER" value-name:"FOLDER" toml:"folder"`
 
 	ExtraHeader http.Header `long:"header" short:"H" description:"One or more extra HTTP header fields" toml:"header"`
 

diff --git a/docs/csaf_downloader.md b/docs/csaf_downloader.md
@@ -15,7 +15,7 @@ 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
+  -f, --folder=FOLDER              Download all into a given subFOLDER
   -H, --header=                    One or more extra HTTP header fields
       --validator=URL              URL to validate documents remotely
       --validatorcache=FILE        FILE to cache remote validations
@@ -89,6 +89,6 @@ 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.