Skip to content

Commit

Permalink
More documentation tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
@mlschroe
mlschroe committed Feb 22, 2024
1 parent a9d3a1d commit 3479047
Show file tree
Hide file tree
Showing 2 changed files with 100 additions and 65 deletions.
71 changes: 43 additions & 28 deletions docs/build_config.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ an existing entry from the data.
The following list contains all the allowed keywords in the project
configuration:

==== AssetsURL: TYPE@URL
==== AssetsURL: \TYPE@URL

Define a url for automatic asset downloading. Supported types
are currently `fedpkg` and `goproxy`.
Expand All @@ -62,7 +62,7 @@ Here is an example config for `debbuild`:
BuildEngine: debbuild
Support: pax debbuild

==== BuildFlags: FLAG:VALUE
==== BuildFlags: FLAG[:VALUE]

The BuildFlags keyword defines flags for the build process. The
following values for FLAG are usable.
Expand Down Expand Up @@ -175,7 +175,7 @@ Note that the lines of the project config are macro expanded while
parsing, so you have to use `%%` for a literal percent sign in
the value.

==== ExpandFlags: FLAG
==== ExpandFlags: FLAG[:VALUE]

Flags which modify the behaviour during dependency resolution.

Expand Down Expand Up @@ -283,10 +283,10 @@ to break the loop.
The package in PACKAGE_A will get installed before the package in
PACKAGE_B.

==== Patterntype: TYPES
==== Patterntype: TYPE

Defines the pattern format. Valid values are: `none` (default), `ymp`,
`comps`.
`comps`. Multiple types can be specified.

==== Prefer: PACKAGE

Expand All @@ -295,7 +295,7 @@ will fail. This is unlike like most package managing tools, which just
pick one of the package. It is done that way to provide reproducible
builds and reduce the chance of surprising changes when new packages
are added to the repository.
The Prefer: tag lists packages to be preferred in case a choice exists.
The Prefer directive lists packages to be preferred in case a choice exists.
When the package name is prefixed with a minus sign, it is treated
as a de-prefer.

Expand All @@ -312,7 +312,17 @@ program can be used to install the build environment.
Included scripts are not executed during this phase. However, these
packages will be re-installed later on including script execution.

==== PublishFlag: FLAG
==== PublishFilter: REGEXP [REGEXP]

CAUTION: OBS only

Limits the published binary packages in public repositories. Packages
that match any REGEXP will not be put into the generated repository.

There can be only one line of PublishFilter for historic reasons.
However, multiple REGEXP can be defined.

==== PublishFlags: FLAG[:VALUE]

CAUTION: OBS only

Expand All @@ -339,11 +349,16 @@ even if a package fails to build on another architecture.

Also publish internal content tracking files (.report files).

* ympdist:NAME (OBS 2.11 or later)
* withsbom

Also publish SBOM data in the repostory. Container SBOM data is always
pushed to the registries.

* ympdist:NAME

Defines the distversion to be used in group element of ymp files. This
is used by the installer to check if the repository is suitable for the
installed distribution.
installed distribution. (OBS 2.11 or later)

* singleexport

Expand All @@ -352,36 +367,36 @@ publish the one from the first package. If the project is of the type
`maintenance_release`, this will be the package with the highest
incident number.

==== PublishFilter: REGEXP [REGEXP]
* artifacthub:REG_REPO:ID:[NAME[:EMAIL]]

CAUTION: OBS only
Specify data for artifacthub repository verification. This will
be added to the registry repository when pushing a container to
it.

Limits the published binary packages in public repositories. Packages
that match any REGEXP will not be put into the exported repository.
There can be only one line of PublishFilter for historic reasons.
However, multiple REGEXP can be defined.
==== RegistryURL: URL

Define a url for the downloading of containers.

==== Repotype: TYPE[:OPTIONS]

Defines the repository format for published repositories. Valid values
are: `none`, `rpm-md`, `suse`, `debian`, `hdlist2`, `arch`, `staticlinks`
and vagrant.
and vagrant. Multiple types can be specified to generate more than
one metadata type.

The OPTIONS parameter depends on the repository type, for rpm-md the
known options are `legacy` to create the old rpm-md format, `deltainfo`
or `prestodelta` to create delta rpm packages, `rsyncable` to use
rsyncable gzip compression. To split the debug packages in an own
published repository the option `splitdebug:REPOSITORY_SUFFIX` can be
appended, e.g.:
rsyncable gzip compression.

To split the debug packages in an own published repository the type
`splitdebug:REPOSITORY_SUFFIX` can be appended, e.g.:

Repotype: splitdebug:-debuginfo
Repotype: rpm-md splitdebug:-debuginfo

This results in a debuginfo package repository being created in parallel
to the package repository.

==== RegistryURL: URL

Define a url for the downloading of containers.

==== RepoURL: [TYPE@]URL

Define a url for the downloading of repository packages. Supported types
Expand All @@ -399,11 +414,11 @@ Execute the scriptlets of the specified preinstalled package. Scriptlet
execution takes place after the preinstall phase, but before installing
the remaining packages.

==== Substitute: DEPENDENCY DEPENDENCY...
==== Substitute: OLD_DEPENDENCY [NEW_DEPENDENCY... ]

It is possible to replace to BuildRequires with other packages. This
will have only an effect on directly BuildRequired packages, not on
indirectly required packages.
It is possible to replace BuildRequires dependencies with other
dependencies. This will have only an effect on directly BuildRequired
packages, not on indirectly required packages.

==== Support: PACKAGE

Expand Down
94 changes: 57 additions & 37 deletions docs/pbuild.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1104,7 +1104,7 @@ <h3 id="_available_keywords_in_project_configuration">3.2. Available Keywords in
<div class="paragraph"><p>The following list contains all the allowed keywords in the project
configuration:</p></div>
<div class="sect3">
<h4 id="_assetsurl_a_href_mailto_type_url_type_url_a">3.2.1. AssetsURL: <a href="mailto:TYPE@URL">TYPE@URL</a></h4>
<h4 id="_assetsurl_type_url">3.2.1. AssetsURL: TYPE@URL</h4>
<div class="paragraph"><p>Define a url for automatic asset downloading. Supported types
are currently <code>fedpkg</code> and <code>goproxy</code>.</p></div>
</div>
Expand All @@ -1131,7 +1131,7 @@ <h4 id="_buildengine_engine">3.2.3. BuildEngine: ENGINE</h4>
</div></div>
</div>
<div class="sect3">
<h4 id="_buildflags_flag_value">3.2.4. BuildFlags: FLAG:VALUE</h4>
<h4 id="_buildflags_flag_value">3.2.4. BuildFlags: FLAG[:VALUE]</h4>
<div class="paragraph"><p>The BuildFlags keyword defines flags for the build process. The
following values for FLAG are usable.</p></div>
<div class="ulist"><ul>
Expand Down Expand Up @@ -1299,7 +1299,7 @@ <h4 id="_distmacro_name_value">3.2.8. DistMacro: NAME VALUE</h4>
the value.</p></div>
</div>
<div class="sect3">
<h4 id="_expandflags_flag">3.2.9. ExpandFlags: FLAG</h4>
<h4 id="_expandflags_flag_value">3.2.9. ExpandFlags: FLAG[:VALUE]</h4>
<div class="paragraph"><p>Flags which modify the behaviour during dependency resolution.</p></div>
<div class="ulist"><ul>
<li>
Expand Down Expand Up @@ -1425,9 +1425,9 @@ <h4 id="_order_package_a_package_b">3.2.18. Order: PACKAGE_A:PACKAGE_B</h4>
PACKAGE_B.</p></div>
</div>
<div class="sect3">
<h4 id="_patterntype_types">3.2.19. Patterntype: TYPES</h4>
<h4 id="_patterntype_type">3.2.19. Patterntype: TYPE</h4>
<div class="paragraph"><p>Defines the pattern format. Valid values are: <code>none</code> (default), <code>ymp</code>,
<code>comps</code>.</p></div>
<code>comps</code>. Multiple types can be specified.</p></div>
</div>
<div class="sect3">
<h4 id="_prefer_package">3.2.20. Prefer: PACKAGE</h4>
Expand All @@ -1436,7 +1436,7 @@ <h4 id="_prefer_package">3.2.20. Prefer: PACKAGE</h4>
pick one of the package. It is done that way to provide reproducible
builds and reduce the chance of surprising changes when new packages
are added to the repository.
The Prefer: tag lists packages to be preferred in case a choice exists.
The Prefer directive lists packages to be preferred in case a choice exists.
When the package name is prefixed with a minus sign, it is treated
as a de-prefer.</p></div>
</div>
Expand All @@ -1454,7 +1454,22 @@ <h4 id="_preinstall_package">3.2.22. Preinstall: PACKAGE</h4>
packages will be re-installed later on including script execution.</p></div>
</div>
<div class="sect3">
<h4 id="_publishflag_flag">3.2.23. PublishFlag: FLAG</h4>
<h4 id="_publishfilter_regexp_regexp">3.2.23. PublishFilter: REGEXP [REGEXP]</h4>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/caution.png" alt="Caution" />
</td>
<td class="content">OBS only</td>
</tr></table>
</div>
<div class="paragraph"><p>Limits the published binary packages in public repositories. Packages
that match any REGEXP will not be put into the generated repository.</p></div>
<div class="paragraph"><p>There can be only one line of PublishFilter for historic reasons.
However, multiple REGEXP can be defined.</p></div>
</div>
<div class="sect3">
<h4 id="_publishflags_flag_value">3.2.24. PublishFlags: FLAG[:VALUE]</h4>
<div class="admonitionblock">
<table><tr>
<td class="icon">
Expand Down Expand Up @@ -1504,13 +1519,22 @@ <h4 id="_publishflag_flag">3.2.23. PublishFlag: FLAG</h4>
<div class="ulist"><ul>
<li>
<p>
ympdist:NAME (OBS 2.11 or later)
withsbom
</p>
</li>
</ul></div>
<div class="paragraph"><p>Also publish SBOM data in the repostory. Container SBOM data is always
pushed to the registries.</p></div>
<div class="ulist"><ul>
<li>
<p>
ympdist:NAME
</p>
</li>
</ul></div>
<div class="paragraph"><p>Defines the distversion to be used in group element of ymp files. This
is used by the installer to check if the repository is suitable for the
installed distribution.</p></div>
installed distribution. (OBS 2.11 or later)</p></div>
<div class="ulist"><ul>
<li>
<p>
Expand All @@ -1522,45 +1546,41 @@ <h4 id="_publishflag_flag">3.2.23. PublishFlag: FLAG</h4>
publish the one from the first package. If the project is of the type
<code>maintenance_release</code>, this will be the package with the highest
incident number.</p></div>
<div class="ulist"><ul>
<li>
<p>
artifacthub:REG_REPO:ID:[NAME[:EMAIL]]
</p>
</li>
</ul></div>
<div class="paragraph"><p>Specify data for artifacthub repository verification. This will
be added to the registry repository when pushing a container to
it.</p></div>
</div>
<div class="sect3">
<h4 id="_publishfilter_regexp_regexp">3.2.24. PublishFilter: REGEXP [REGEXP]</h4>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/caution.png" alt="Caution" />
</td>
<td class="content">OBS only</td>
</tr></table>
</div>
<div class="paragraph"><p>Limits the published binary packages in public repositories. Packages
that match any REGEXP will not be put into the exported repository.
There can be only one line of PublishFilter for historic reasons.
However, multiple REGEXP can be defined.</p></div>
<h4 id="_registryurl_url">3.2.25. RegistryURL: URL</h4>
<div class="paragraph"><p>Define a url for the downloading of containers.</p></div>
</div>
<div class="sect3">
<h4 id="_repotype_type_options">3.2.25. Repotype: TYPE[:OPTIONS]</h4>
<h4 id="_repotype_type_options">3.2.26. Repotype: TYPE[:OPTIONS]</h4>
<div class="paragraph"><p>Defines the repository format for published repositories. Valid values
are: <code>none</code>, <code>rpm-md</code>, <code>suse</code>, <code>debian</code>, <code>hdlist2</code>, <code>arch</code>, <code>staticlinks</code>
and vagrant.
The OPTIONS parameter depends on the repository type, for rpm-md the
and vagrant. Multiple types can be specified to generate more than
one metadata type.</p></div>
<div class="paragraph"><p>The OPTIONS parameter depends on the repository type, for rpm-md the
known options are <code>legacy</code> to create the old rpm-md format, <code>deltainfo</code>
or <code>prestodelta</code> to create delta rpm packages, <code>rsyncable</code> to use
rsyncable gzip compression. To split the debug packages in an own
published repository the option <code>splitdebug:REPOSITORY_SUFFIX</code> can be
appended, e.g.:</p></div>
rsyncable gzip compression.</p></div>
<div class="paragraph"><p>To split the debug packages in an own published repository the type
<code>splitdebug:REPOSITORY_SUFFIX</code> can be appended, e.g.:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>Repotype: splitdebug:-debuginfo</code></pre>
<pre><code>Repotype: rpm-md splitdebug:-debuginfo</code></pre>
</div></div>
<div class="paragraph"><p>This results in a debuginfo package repository being created in parallel
to the package repository.</p></div>
</div>
<div class="sect3">
<h4 id="_registryurl_url">3.2.26. RegistryURL: URL</h4>
<div class="paragraph"><p>Define a url for the downloading of containers.</p></div>
</div>
<div class="sect3">
<h4 id="_repourl_type_url">3.2.27. RepoURL: [TYPE@]URL</h4>
<div class="paragraph"><p>Define a url for the downloading of repository packages. Supported types
are currently <code>arch</code>, <code>debian</code>, <code>hdlist2</code>, <code>rpmmd</code>, <code>suse</code>. If the
Expand All @@ -1578,10 +1598,10 @@ <h4 id="_runscripts_package">3.2.29. Runscripts: PACKAGE</h4>
the remaining packages.</p></div>
</div>
<div class="sect3">
<h4 id="_substitute_dependency_dependency_8230">3.2.30. Substitute: DEPENDENCY DEPENDENCY&#8230;</h4>
<div class="paragraph"><p>It is possible to replace to BuildRequires with other packages. This
will have only an effect on directly BuildRequired packages, not on
indirectly required packages.</p></div>
<h4 id="_substitute_old_dependency_new_dependency_8230">3.2.30. Substitute: OLD_DEPENDENCY [NEW_DEPENDENCY&#8230; ]</h4>
<div class="paragraph"><p>It is possible to replace BuildRequires dependencies with other
dependencies. This will have only an effect on directly BuildRequired
packages, not on indirectly required packages.</p></div>
</div>
<div class="sect3">
<h4 id="_support_package">3.2.31. Support: PACKAGE</h4>
Expand Down

0 comments on commit 3479047

Please sign in to comment.