Skip to content

Commit

Permalink
Add docs for the new --update-missing option
Browse files Browse the repository at this point in the history
Also require fresh `fmf` for docs building.
  • Loading branch information
psss committed Oct 6, 2023
1 parent 8537a08 commit 8e4f385
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ all = [
docs = [
"sphinx_rtd_theme>=1.2.2", # The theme pulls a specific sphinx version
"docutils>=0.18.1",
"fmf>=1.3.0",
]

[project.scripts]
Expand Down
20 changes: 20 additions & 0 deletions stories/cli/multiple phases.fmf
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,26 @@ story: |
- implemented-by: /tmt/steps
- verified-by: /tests/core/phases

/update-missing:
summary: Update phase fields only when not already set
description:
In some cases it is useful to only update those fields
which are not already set in the configuration. The
``--update-missing`` option allows to fill these gaps with
information which cannot be hardcoded, for example the
current distro image under test.

example:
- |
# Use artemis as the provision plugin (unless other method
# is specified in the config) with the given distro image
# (for all guests which do not have the image defined)
tmt run -a provision --update-missing --how artemis --image fedora-38

link:
- implemented-by: /tmt/steps
- verified-by: /tests/core/phases

/remove:
summary: Allow removing phases via command line

Expand Down

0 comments on commit 8e4f385

Please sign in to comment.