almalinux
/
pungi
15
1
Fork 0
Code Issues Pull Requests Releases Activity

Update ostree phase documentation 

The message and the new option were not documented.

Signed-off-by: Lubomír Sedlář <lsedlar@redhat.com>
This commit is contained in:
Lubomír Sedlář 2016-10-27 09:23:58 +02:00
parent fa3c5aff63
commit 4427769f6a
2 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/configuration.rst
View File

@ -1068,8 +1068,11 @@ Example
OSTree Settings OSTree Settings
=============== ===============
The ``ostree`` phase of *Pungi* can create ostree repositories in a Koji The ``ostree`` phase of *Pungi* can create ostree repositories. This is done by
runroot environment. running ``rpm-ostree compose`` in a Koji runroot environment. The ostree
repository itself is not part of the compose and should be located in another
directory. Any new packages in the compose will be added to the repository with
a new commit.
**ostree** **ostree**
(*dict*) -- a variant/arch mapping of configuration. The format should be (*dict*) -- a variant/arch mapping of configuration. The format should be
@ -1091,6 +1094,8 @@ runroot environment.
* ``update_summary`` -- (*bool*) Update summary metadata after tree composing. * ``update_summary`` -- (*bool*) Update summary metadata after tree composing.
Defaults to ``False``. Defaults to ``False``.
* ``version`` -- (*str*) Version string to be added as versioning metadata. * ``version`` -- (*str*) Version string to be added as versioning metadata.
* ``tag_ref`` -- (*bool*, default ``True``) If set to ``False``, a git
reference will not be created.
Example config Example config

2
doc/messaging.rst
View File

@ -27,6 +27,8 @@ Currently these messages are sent:
* ``fail-to-start`` -- when there are incorrect CLI options or errors in * ``fail-to-start`` -- when there are incorrect CLI options or errors in
configuration file; this message does not contain ``compose_id`` nor is it configuration file; this message does not contain ``compose_id`` nor is it
started in the compose directory (which does not exist yet) started in the compose directory (which does not exist yet)
* ``ostree`` -- when a new commit is created, this message will announce its
hash and the name of ref it is meant for.
For phase related messages ``phase_name`` key is provided as well. For phase related messages ``phase_name`` key is provided as well.