Skip to content

Commit 8500069

Browse files
committed
add documentation for osh options
1 parent 81d1870 commit 8500069

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

docs/configuration/index.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -786,6 +786,34 @@ We will be happy for any feedback regarding it, [please contact us](https://gith
786786

787787
(*string*) An option to set arguments of `csmock` (the tool used inside [OpenScanHub](https://openscanhub.fedoraproject.org/)). For instance, you can specify arguments like `--cppcheck-add-flag=--enable=style` to check styling issues as seen in [this example run](https://openscanhub.fedoraproject.org/task/10066/) triggered from [this](https://github.com/avahi/avahi/pull/641) testing pull-request on Avahi.
788788

789+
#### osh_options
790+
A set of additional options passed into osh-cli for additional functionality
791+
##### analyzer
792+
(*string*)
793+
list of analyzers to be passed to osh-cli use comma as a separator: e.g. "analyzer:gcc,clang,cppcheck"
794+
795+
```yaml
796+
osh_options:
797+
analyzer: "gcc, shellcheck"
798+
```
799+
800+
##### config
801+
(*string*)
802+
Used to specify mock config name to be passed to osh-cli. If value is not set in yaml file, default value "fedora-rawhide-x86_64" is used.
803+
804+
```yaml
805+
osh_options:
806+
config: "fedora-rawhide-x86_64"
807+
```
808+
809+
##### profile
810+
(*string*)
811+
Used to specify predefined scanning profile to be passed to osh cli.
812+
813+
```yaml
814+
osh_options:
815+
profile: "dev"
816+
```
789817

790818
## Aliases
791819

0 commit comments

Comments
 (0)