diff --git a/docs/build_config.adoc b/docs/build_config.adoc index 0e704da06..f2fedbefa 100644 --- a/docs/build_config.adoc +++ b/docs/build_config.adoc @@ -36,6 +36,11 @@ an existing entry from the data. The following list contains all the allowed keywords in the project configuration: +==== AssetsURL: TYPE@URL + +Define a url for automatic asset downloading. Supported types +are currently `fedpkg` and `goproxy`. + ==== BinaryType: TYPE The binary type is the format of the packages that make up the build @@ -142,6 +147,13 @@ For podman container builds, it specifies the container config format. Possible are 'docker' and 'oci'. The default is 'docker'. The 'docker' format allows a few extensions like ONBUILD, SHELL, DOMAINNAME, COMMENT, HEALTHCHECK amongst others. +==== Conflict: PACKAGE + +Specify that a package must not be installed in the build environment. + +==== Conflict: PACKAGE_A:PACKAGE_B + +Specify a synthetic conflict between to packages. ==== Constraint: SELECTOR STRING @@ -151,6 +163,18 @@ Define build constraints for build jobs. The selector is a colon-separated list which gets a string assigned. See the build job constraints page for details. +==== DistMacro: NAME VALUE + +Define a macro to be used when parsing the spec files of packages. +This is similar to using a `Macros:` section with the difference +that the macro will not be written to the .rpmmacros file. It should +therefore be used for macros that come from packages of the +distributions. + +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 Flags which modify the behaviour during dependency resolution. @@ -234,6 +258,13 @@ for packages like `make` that are used to build itself. Preinstalled packages are automatically kept, as the package installation program needs to work all the time. +==== Macros: + +Defines the start of a literal macros block. The block is ended +by either reaching the end of the config or by a literal +`Macros:` line. See the section about macro definitions below for +more information. + ==== OptFlags: TARGET_ARCH FLAGS (RPM only) Optflags exports compiler flags to the build by adding lines to rpm's @@ -314,6 +345,13 @@ 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. + * singleexport + +If multiple packages contain different versions of a rpm package, only +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] CAUTION: OBS only @@ -340,6 +378,16 @@ appended, e.g.: 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 +are currently `arch`, `debian`, `hdlist2`, `rpmmd`, `suse`. If the +type is not specified, it is guessed from the build type. + ==== Required: PACKAGE Specify a package that always is installed for package builds. @@ -423,6 +471,9 @@ Example: %_hardened_build 0 :Macros +Note that the macro lines are copied verbatim, i.e. macro expansion +does not take place. + === Building with ccache or sccache The usage of ccache or sccache can be enabled for each package by diff --git a/docs/pbuild.html b/docs/pbuild.html index 9b35cd737..d6ab5154e 100644 --- a/docs/pbuild.html +++ b/docs/pbuild.html @@ -1104,14 +1104,19 @@
The following list contains all the allowed keywords in the project configuration:
Define a url for automatic asset downloading. Supported types
+are currently fedpkg
and goproxy
.
The binary type is the format of the packages that make up the build
environment. This is usually set automatically depending on the recipe
type and preinstall package list.
Currently understood values are: rpm
, deb
, and arch
.
Use an alternative build engine. Examples are mock
(for Fedora and
Red Hat) and debootstrap
(for Debian), debbuild
(to build debian
packages with spec files), podman
(container builds).
The BuildFlags keyword defines flags for the build process. The following values for FLAG are usable.
Specify that a package must not be installed in the build environment.
Specify a synthetic conflict between to packages.
@@ -1275,7 +1288,18 @@ 3.2.4. Constraint: SELECTOR STRINGconstraints page for details.
-
+3.2.5. ExpandFlags: FLAG+3.2.8. DistMacro: NAME VALUE+Define a macro to be used when parsing the spec files of packages.
+This is similar to using a Note that the lines of the project config are macro expanded while
+parsing, so you have to use
+
3.2.9. ExpandFlags: FLAGFlags which modify the behaviour during dependency resolution.
-
3.2.6. ExportFilter: REGEX ARCHITECTURES+3.2.10. ExportFilter: REGEX ARCHITECTURESThe export filter can be used to export build results from one architecture to others. This is required when one architecture needs packages from another architecture for building. The REGEX placeholder @@ -1341,20 +1365,20 @@ 3.2.6. ExportFilter: REGEX ARCHITECTU to also use them locally.
-
3.2.7. FileProvides: FILE PACKAGES+3.2.11. FileProvides: FILE PACKAGESDue to memory consumption reasons dependencies to files as supported by rpm are ignored by default. As a workaround, FileProvides can be used to tell the systems which packages contain a file. The file needs to have the full path.
-
3.2.8. HostArch: HOST_ARCH+3.2.12. HostArch: HOST_ARCHThis is used for cross builds. It defines the host architecture used for building, while the scheduler architecture remains the target architecture.
-
3.2.9. Ignore: PACKAGE_OR_DEPENDENCY+3.2.13. Ignore: PACKAGE_OR_DEPENDENCYIgnore can be used to break dependencies. This can be useful to reduce the number of needed packages or to break cyclic dependencies. If a package is specified, all capabilities provided by the package are @@ -1364,12 +1388,12 @@ 3.2.9. Ignore: PACKAGE_OR_DEPENDENCYoriginating package as described in the following section.
-
3.2.10. Ignore: ORIGIN_PACKAGE:PACKAGE_OR_DEPENDENCY+3.2.14. Ignore: ORIGIN_PACKAGE:PACKAGE_OR_DEPENDENCYIgnore a dependency coming from ORIGIN_PACKAGE. See the previous section for more details.
-
3.2.11. Keep: PACKAGES+3.2.15. Keep: PACKAGESTo eliminate build cycles the to-be-built packages are not installed by
default. Keep can be used to overwrite this behavior. It is usually needed
for packages like 3.2.11. Keep: PACKAGESto work all the time.
-
+3.2.12. OptFlags: TARGET_ARCH FLAGS (RPM only)+3.2.16. Macros:+Defines the start of a literal macros block. The block is ended
+by either reaching the end of the config or by a literal
+
+
3.2.17. OptFlags: TARGET_ARCH FLAGS (RPM only)Optflags exports compiler flags to the build by adding lines to rpm’s
-
3.2.13. Order: PACKAGE_A:PACKAGE_B+3.2.18. Order: PACKAGE_A:PACKAGE_BThe build script takes care about the installation order if they are defined via dependencies inside of the packages. However, there might be dependency loops (reported during setup of the build system) or missing @@ -1394,12 +1425,12 @@ 3.2.13. Order: PACKAGE_A:PACKAGE_BPACKAGE_B.
-
3.2.14. Patterntype: TYPES+3.2.19. Patterntype: TYPESDefines the pattern format. Valid values are:
-
3.2.15. Prefer: PACKAGE+3.2.20. Prefer: PACKAGEIn case multiple packages satisfy a dependency, the dependency expansion 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 @@ -1410,12 +1441,12 @@ 3.2.15. Prefer: PACKAGEas a de-prefer.
-
3.2.16. Prefer: ORIGIN_PACKAGE:PACKAGE+3.2.21. Prefer: ORIGIN_PACKAGE:PACKAGEIt is possible to define the prefer only when the dependency comes from the specified originating package.
-
3.2.17. Preinstall: PACKAGE+3.2.22. Preinstall: PACKAGEThis is used to specify packages needed to run the package installation program. These packages are unpacked so that the native installation program can be used to install the build environment. @@ -1423,7 +1454,7 @@ 3.2.17. Preinstall: PACKAGEpackages will be re-installed later on including script execution.
- 3.2.18. PublishFlag: FLAG+3.2.23. PublishFlag: FLAG
|