Skip to content

Commit

Permalink
doc: move remote assets into additional file
Browse files Browse the repository at this point in the history
  • Loading branch information
adrianschroeter committed Mar 24, 2022
1 parent 00886da commit cbeb173
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 73 deletions.
65 changes: 1 addition & 64 deletions docs/pbuild.adoc
Expand Up @@ -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: <URL>

It is also possible to specify a checksum to make sure that the asset is correct.

#!RemoteAsset: <CHECKSUM>
Source: <URL>

An alternative is just to use the

#!RemoteAssetUrl: <URL>

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.

<!-- OBS-RemoteAsset: <URL> -->

The resulting downloaded file can be copied into the image using

<!-- OBS-CopyToImage: <source> <destination> -->

The kiwi profile name is added to container names by default. This can be
disabled via

<!-- OBS-DoNotAppendProfileToContainername -->

==== 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[]

Expand Down
18 changes: 9 additions & 9 deletions docs/pbuild.html
Expand Up @@ -1112,7 +1112,7 @@ <h4 id="_buildflags_flag_value">3.1.3. BuildFlags: FLAG:VALUE</h4>
<div class="ulist"><ul>
<li>
<p>
vmfstype:
vmfstype:TYPE
</p>
</li>
</ul></div>
Expand All @@ -1121,7 +1121,7 @@ <h4 id="_buildflags_flag_value">3.1.3. BuildFlags: FLAG:VALUE</h4>
<div class="ulist"><ul>
<li>
<p>
vmfsoptions:
vmfsoptions:OPTIONS
</p>
</li>
</ul></div>
Expand All @@ -1132,15 +1132,15 @@ <h4 id="_buildflags_flag_value">3.1.3. BuildFlags: FLAG:VALUE</h4>
<div class="ulist"><ul>
<li>
<p>
kiwiprofile:
kiwiprofile:PROFILE
</p>
</li>
</ul></div>
<div class="paragraph"><p>builds the selected profile in &kiwi; appliance builds.</p></div>
<div class="ulist"><ul>
<li>
<p>
logidlelimit:
logidlelimit:SECONDS
</p>
</li>
</ul></div>
Expand All @@ -1150,7 +1150,7 @@ <h4 id="_buildflags_flag_value">3.1.3. BuildFlags: FLAG:VALUE</h4>
<div class="ulist"><ul>
<li>
<p>
excludebuild:
excludebuild:PACKAGE
</p>
</li>
</ul></div>
Expand All @@ -1159,7 +1159,7 @@ <h4 id="_buildflags_flag_value">3.1.3. BuildFlags: FLAG:VALUE</h4>
<div class="ulist"><ul>
<li>
<p>
onlybuild:
onlybuild:PACKAGE
</p>
</li>
</ul></div>
Expand All @@ -1169,7 +1169,7 @@ <h4 id="_buildflags_flag_value">3.1.3. BuildFlags: FLAG:VALUE</h4>
<div class="ulist"><ul>
<li>
<p>
useccache:
useccache:PACKAGE
</p>
</li>
</ul></div>
Expand Down Expand Up @@ -1198,7 +1198,7 @@ <h4 id="_buildflags_flag_value">3.1.3. BuildFlags: FLAG:VALUE</h4>
<div class="ulist"><ul>
<li>
<p>
ccachetype:
ccachetype:TYPE
</p>
</li>
</ul></div>
Expand Down Expand Up @@ -1664,7 +1664,7 @@ <h3 id="_build_config">4.6. Build Config</h3>
<div id="footer">
<div id="footer-text">
Last updated
2022-03-07 10:46:30 CET
2022-03-24 09:17:43 CET
</div>
</div>
</body>
Expand Down
65 changes: 65 additions & 0 deletions 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: <URL>

It is also possible to specify a checksum to make sure that the asset is correct.

#!RemoteAsset: <CHECKSUM>
Source: <URL>

An alternative is just to use the

#!RemoteAssetUrl: <URL>

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.

<!-- OBS-RemoteAsset: <URL> -->

The resulting downloaded file can be copied into the image using

<!-- OBS-CopyToImage: <source> <destination> -->

The kiwi profile name is added to container names by default. This can be
disabled via

<!-- OBS-DoNotAppendProfileToContainername -->

==== 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.

0 comments on commit cbeb173

Please sign in to comment.