From cbeb1739634c1e72119f84678006f063a8a15453 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adrian=20Schr=C3=B6ter?= Date: Thu, 24 Mar 2022 09:18:13 +0100 Subject: [PATCH] doc: move remote assets into additional file --- docs/pbuild.adoc | 65 +---------------------------------------- docs/pbuild.html | 18 ++++++------ docs/source_assets.adoc | 65 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 75 insertions(+), 73 deletions(-) create mode 100644 docs/source_assets.adoc diff --git a/docs/pbuild.adoc b/docs/pbuild.adoc index 181d65678..4f5570a54 100644 --- a/docs/pbuild.adoc +++ b/docs/pbuild.adoc @@ -128,71 +128,8 @@ Extra packages needed for debugging can be specified with (eg. gdb, strace, valgrind or assumed missing dependencies for testing). -=== Remote Assets -Remote Assets can be defined inside of the build descriptions. They are resources from a remote -servers and will be downloaded and validated by pbuild before the corresponding build is started. - -Supported protocols for resources using an url are: - - * http - * https - * git+http - * git+https - -This depends on the build description format as described below. - -==== rpm spec files - -Source lines in spec files can declare remote assets. Rpm is already supporting to use -an URL as source definition. A comment before such a line marks it as remote asset for pbuild: - - #!RemoteAsset - Source: - -It is also possible to specify a checksum to make sure that the asset is correct. - - #!RemoteAsset: - Source: - -An alternative is just to use the - - #!RemoteAssetUrl: - -marker without any Source: tag when the downloaded file should not become -part of the source rpm. - -==== kiwi build description - -The kiwi format is not supporting remote source specifications, but they can be -specified via XML comments. - - - -The resulting downloaded file can be copied into the image using - - - -The kiwi profile name is added to container names by default. This can be -disabled via - - - -==== Dockerfile description - -Has no support for assets yet. - -==== Arch Linux PKGBUILD - -PKGBuild files already contain the needed URLs and Checksums, so no extra -treatment is needed. - -==== FedPkg "sources" file - -The sources file contains a list of file names with checksums. PBuild will -automatically download the missing files from a FedPkg Server that needs -to be configured in the project config via the "AssetsURL:" directive or set -with the "--assets" option. +include::source_assets.adoc[] include::build_config.adoc[] diff --git a/docs/pbuild.html b/docs/pbuild.html index 9d5cd5656..9c1c13476 100644 --- a/docs/pbuild.html +++ b/docs/pbuild.html @@ -1112,7 +1112,7 @@

3.1.3. BuildFlags: FLAG:VALUE

  • -vmfstype: +vmfstype:TYPE

@@ -1121,7 +1121,7 @@

3.1.3. BuildFlags: FLAG:VALUE

  • -vmfsoptions: +vmfsoptions:OPTIONS

@@ -1132,7 +1132,7 @@

3.1.3. BuildFlags: FLAG:VALUE

  • -kiwiprofile: +kiwiprofile:PROFILE

@@ -1140,7 +1140,7 @@

3.1.3. BuildFlags: FLAG:VALUE

  • -logidlelimit: +logidlelimit:SECONDS

@@ -1150,7 +1150,7 @@

3.1.3. BuildFlags: FLAG:VALUE

  • -excludebuild: +excludebuild:PACKAGE

@@ -1159,7 +1159,7 @@

3.1.3. BuildFlags: FLAG:VALUE

  • -onlybuild: +onlybuild:PACKAGE

@@ -1169,7 +1169,7 @@

3.1.3. BuildFlags: FLAG:VALUE

  • -useccache: +useccache:PACKAGE

@@ -1198,7 +1198,7 @@

3.1.3. BuildFlags: FLAG:VALUE

  • -ccachetype: +ccachetype:TYPE

@@ -1664,7 +1664,7 @@

4.6. Build Config

diff --git a/docs/source_assets.adoc b/docs/source_assets.adoc new file mode 100644 index 000000000..00bb9c7ae --- /dev/null +++ b/docs/source_assets.adoc @@ -0,0 +1,65 @@ +=== Remote Assets + +Remote Assets can be defined inside of the build descriptions. They are resources from a remote +servers and will be downloaded and validated by pbuild before the corresponding build is started. + +Supported protocols for resources using an url are: + + * http + * https + * git+http + * git+https + +This depends on the build description format as described below. + +==== rpm spec files + +Source lines in spec files can declare remote assets. Rpm is already supporting to use +an URL as source definition. A comment before such a line marks it as remote asset for pbuild: + + #!RemoteAsset + Source: + +It is also possible to specify a checksum to make sure that the asset is correct. + + #!RemoteAsset: + Source: + +An alternative is just to use the + + #!RemoteAssetUrl: + +marker without any Source: tag when the downloaded file should not become +part of the source rpm. + +==== kiwi build description + +The kiwi format is not supporting remote source specifications, but they can be +specified via XML comments. + + + +The resulting downloaded file can be copied into the image using + + + +The kiwi profile name is added to container names by default. This can be +disabled via + + + +==== Dockerfile description + +Has no support for assets yet. + +==== Arch Linux PKGBUILD + +PKGBuild files already contain the needed URLs and Checksums, so no extra +treatment is needed. + +==== FedPkg "sources" file + +The sources file contains a list of file names with checksums. PBuild will +automatically download the missing files from a FedPkg Server that needs +to be configured in the project config via the "AssetsURL:" directive or set +with the "--assets" option.