Skip to content

Commit

Permalink
Document regular expression syntax used for filtering URLs.
Browse files Browse the repository at this point in the history
  • Loading branch information
s-l-teichmann committed Aug 17, 2023
1 parent 42709a8 commit e617ae4
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
4 changes: 3 additions & 1 deletion docs/csaf_checker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Expand All @@ -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 describes [here](https://github.com/google/re2/wiki/Syntax).
4 changes: 3 additions & 1 deletion docs/csaf_downloader.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -112,3 +112,5 @@ In the config file this has to be noted as:
```
ignorepattern = [".*white.*", ".*red.*"]
```

[^1]: Accepted syntax is describes [here](https://github.com/google/re2/wiki/Syntax).

0 comments on commit e617ae4

Please sign in to comment.