Add documentation for modular composes
List all available configuration options and go into some detail on how modules should be specified. This would probably deserver a more thorough explanation, but it's still bit in a flux. Fixes: https://pagure.io/pungi/issue/767 Signed-off-by: Lubomír Sedlář <lsedlar@redhat.com>
This commit is contained in:
parent
0f104cea40
commit
b068514471
2 changed files with 47 additions and 1 deletions
|
|
@ -78,3 +78,25 @@ Profiling
|
|||
|
||||
Profiling data on the ``pungi-gather`` tool can be enabled by setting the
|
||||
``gather_profiler`` configuration option to ``True``.
|
||||
|
||||
|
||||
Modular compose
|
||||
===============
|
||||
|
||||
A compose with ``gather_source`` set to ``module`` is called *modular*. The
|
||||
package list is determined by a list of modules.
|
||||
|
||||
The list of modules that will be put into a variant is defined in the
|
||||
``variants.xml`` file. The file can contain either *Name:Stream* or
|
||||
*Name:Stream:Version* references. See `Module Naming Policy
|
||||
<https://pagure.io/modularity/blob/master/f/source/development/building-modules/naming-policy.rst>`_
|
||||
for details. When *Version* is missing from the specification, Pungi will ask
|
||||
PDC for the latest one.
|
||||
|
||||
The module metadata in PDC contains a list of RPMs in the module as well as
|
||||
Koji tag from which the packages can be retrieved.
|
||||
|
||||
Restrictions
|
||||
------------
|
||||
|
||||
* A modular compose must always use Koji as a package set source.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue