From 0b914f7e7ae62927b80219a7ea0f72b282b0e405 Mon Sep 17 00:00:00 2001 From: "Sascha L. Teichmann" Date: Thu, 17 Aug 2023 17:02:10 +0200 Subject: [PATCH] Document regular expression syntax used for filtering URLs. (#433) * Document regular expression syntax used for filtering URLs. * Typo: describes -> described * Forget to add aggregator doc --------- Co-authored-by: JanHoefelmeyer --- docs/csaf_aggregator.md | 2 +- docs/csaf_checker.md | 4 +++- docs/csaf_downloader.md | 4 +++- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/csaf_aggregator.md b/docs/csaf_aggregator.md index e1e60d7..9b92dd7 100644 --- a/docs/csaf_aggregator.md +++ b/docs/csaf_aggregator.md @@ -95,7 +95,7 @@ lock_file // path to lockfile, to stop other instances if one is n interim_years // limiting the years for which interim documents are searched (default 0) verbose // print more diagnostic output, e.g. https requests (default false) allow_single_provider // debugging option (default false) -ignorepattern // patterns of advisory URLs to be ignored +ignorepattern // patterns of advisory URLs to be ignored (see checker doc for details) client_cert // path to client certificate to access access-protected advisories client_key // path to client key to access access-protected advisories client_passphrase // client passphrase to access access-protected advisories diff --git a/docs/csaf_checker.md b/docs/csaf_checker.md index 6dc103b..f555c69 100644 --- a/docs/csaf_checker.md +++ b/docs/csaf_checker.md @@ -100,7 +100,7 @@ There are following variants: All interval boundaries are inclusive. You can ignore certain advisories while checking by specifying a list -of regular expressions to match their URLs by using the `ignorepattern` +of regular expressions[^1] 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**. @@ -119,3 +119,5 @@ If a provider hosts one or more advisories with a TLP level of AMBER or RED, the To check these advisories, authorization can be given via custom headers or certificates. The authorization method chosen needs to grant access to all advisories, as otherwise the checker will be unable to check the advisories it doesn't have permission for, falsifying the result. + +[^1]: Accepted syntax is described [here](https://github.com/google/re2/wiki/Syntax). diff --git a/docs/csaf_downloader.md b/docs/csaf_downloader.md index 2fb98d9..f2ed419 100644 --- a/docs/csaf_downloader.md +++ b/docs/csaf_downloader.md @@ -103,7 +103,7 @@ 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` +of regular expressions[^1] to match their URLs by using the `ignorepattern` option. E.g. `-i='.*white.*' -i='*.red.*'` will ignore files which URLs contain @@ -112,3 +112,5 @@ In the config file this has to be noted as: ``` ignorepattern = [".*white.*", ".*red.*"] ``` + +[^1]: Accepted syntax is described [here](https://github.com/google/re2/wiki/Syntax).