Skip to content

Commit

Permalink
docs: add documentation about include/exclude options in sm plugin
Browse files Browse the repository at this point in the history
Signed-off-by: Krzysztof Piotrowski <[email protected]>
  • Loading branch information
Ruadhri17 committed May 22, 2024
1 parent 1a1b434 commit 40e1cfe
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/src/references/agent/software-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -367,8 +367,14 @@ For each type of software package supported on the device must be provided a spe

`tedge-agent` behavior on `software_update` commands can be configured with `tedge config`.

- `software.plugin.default` set the default software plugin to be used for software management on the device.
- `software.plugin.max_packages` set the maximum number of software packages reported for each type of software package.
- `software.plugin.default` sets the default software plugin to be used for software management on the device.
- `software.plugin.max_packages` sets the maximum number of software packages reported for each type of software package.
- `software.plugin.exclude` sets the filtering criterion that excludes software packages from the output list if they match the pattern.
- `software.plugin.include` sets the filtering criterion that includes software packages in the output list if they match the pattern.

:::info
Include pattern takes precedence over exclude pattern, so when both are used at the same time, the software list will exclude packages according to the pattern but keep the exceptions covered by the include pattern.
:::

## Custom implementation

Expand Down

0 comments on commit 40e1cfe

Please sign in to comment.