Commit a7123024 authored by Peter Hutterer's avatar Peter Hutterer
Browse files

doc: drop the secondary documentation



Let's document all the variables in the templates where they show up in pages
too.
Signed-off-by: Peter Hutterer's avatarPeter Hutterer <peter.hutterer@who-t.net>
parent c1f129bf
......@@ -2,42 +2,6 @@
#
# {{ warning }}
# This template will create a {{distribution}} image based on the following variables:
#
{% if not version %}
# - FDO_DISTRIBUTION_VERSION: the {{distribution}} version ({{version_examples|join(', ')}}, etc...)
{% endif %}
# - FDO_DISTRIBUTION_PACKAGES: if set, list of packages that needs to be installed
# - FDO_DISTRIBUTION_EXEC: if set, this command will be run once the packages have
# been installed
# - FDO_DISTRIBUTION_NAME: set by these templates to "{{distribution}}".
# Consider this as read-only variable.
# - FDO_UPSTREAM_REPO: the upstream project on this gitlab instance
# where we might find the given tag (for example:
# `wayland/weston`)
# - FDO_REPO_SUFFIX: The repository name suffix.
# If this variable isn't defined,
# "{{distribution}}/$FDO_DISTRIBUTION_VERSION" is used for
# the suffix.
# - FDO_DISTRIBUTION_TAG: tag to copy the image from the upstream registry. If the
# tag does not exist, create a new build and tag it
# - FDO_CACHE_DIR: A directory that needs to be mounted as `/cache` during
# $FDO_DISTRIBUTION_EXEC stage. Defaults to `/cache` from the
# host, so that most users should not need this.
# - FDO_FORCE_REBUILD: when set, the container will be rebuild unconditionally.
# - FDO_EXPIRES_AFTER: Allows to set an expiration time for the build image. Useful when
# images are not meant to be kept for eternity.
# The values are something like 1h, 2d, 3w for hour, day and weeks,
# respectively
#
# The resulting image will be pushed in the local registry, under:
# $CI_REGISTRY_IMAGE/$FDO_REPO_SUFFIX:$FDO_DISTRIBUTION_TAG
#
# To build a new container, use:
# - `.fdo.container-build@{{distribution}}`: this will rebuild a new container
# only if $FDO_DISTRIBUTION_TAG is not available in the local registry or
# in the $FDO_UPSTREAM_REPO registry. To force rebuilding the container,
# set the variable $FDO_FORCE_REBUILD.
# we cannot reuse exported variables in after_script,
# so let's have a common definition
......
......@@ -2,39 +2,6 @@
#
# THIS FILE IS GENERATED, DO NOT EDIT
# This template will create a alpine image based on the following variables:
#
# - FDO_DISTRIBUTION_PACKAGES: if set, list of packages that needs to be installed
# - FDO_DISTRIBUTION_EXEC: if set, this command will be run once the packages have
# been installed
# - FDO_DISTRIBUTION_NAME: set by these templates to "alpine".
# Consider this as read-only variable.
# - FDO_UPSTREAM_REPO: the upstream project on this gitlab instance
# where we might find the given tag (for example:
# `wayland/weston`)
# - FDO_REPO_SUFFIX: The repository name suffix.
# If this variable isn't defined,
# "alpine/$FDO_DISTRIBUTION_VERSION" is used for
# the suffix.
# - FDO_DISTRIBUTION_TAG: tag to copy the image from the upstream registry. If the
# tag does not exist, create a new build and tag it
# - FDO_CACHE_DIR: A directory that needs to be mounted as `/cache` during
# $FDO_DISTRIBUTION_EXEC stage. Defaults to `/cache` from the
# host, so that most users should not need this.
# - FDO_FORCE_REBUILD: when set, the container will be rebuild unconditionally.
# - FDO_EXPIRES_AFTER: Allows to set an expiration time for the build image. Useful when
# images are not meant to be kept for eternity.
# The values are something like 1h, 2d, 3w for hour, day and weeks,
# respectively
#
# The resulting image will be pushed in the local registry, under:
# $CI_REGISTRY_IMAGE/$FDO_REPO_SUFFIX:$FDO_DISTRIBUTION_TAG
#
# To build a new container, use:
# - `.fdo.container-build@alpine`: this will rebuild a new container
# only if $FDO_DISTRIBUTION_TAG is not available in the local registry or
# in the $FDO_UPSTREAM_REPO registry. To force rebuilding the container,
# set the variable $FDO_FORCE_REBUILD.
# we cannot reuse exported variables in after_script,
# so let's have a common definition
......
......@@ -2,39 +2,6 @@
#
# THIS FILE IS GENERATED, DO NOT EDIT
# This template will create a arch image based on the following variables:
#
# - FDO_DISTRIBUTION_PACKAGES: if set, list of packages that needs to be installed
# - FDO_DISTRIBUTION_EXEC: if set, this command will be run once the packages have
# been installed
# - FDO_DISTRIBUTION_NAME: set by these templates to "arch".
# Consider this as read-only variable.
# - FDO_UPSTREAM_REPO: the upstream project on this gitlab instance
# where we might find the given tag (for example:
# `wayland/weston`)
# - FDO_REPO_SUFFIX: The repository name suffix.
# If this variable isn't defined,
# "arch/$FDO_DISTRIBUTION_VERSION" is used for
# the suffix.
# - FDO_DISTRIBUTION_TAG: tag to copy the image from the upstream registry. If the
# tag does not exist, create a new build and tag it
# - FDO_CACHE_DIR: A directory that needs to be mounted as `/cache` during
# $FDO_DISTRIBUTION_EXEC stage. Defaults to `/cache` from the
# host, so that most users should not need this.
# - FDO_FORCE_REBUILD: when set, the container will be rebuild unconditionally.
# - FDO_EXPIRES_AFTER: Allows to set an expiration time for the build image. Useful when
# images are not meant to be kept for eternity.
# The values are something like 1h, 2d, 3w for hour, day and weeks,
# respectively
#
# The resulting image will be pushed in the local registry, under:
# $CI_REGISTRY_IMAGE/$FDO_REPO_SUFFIX:$FDO_DISTRIBUTION_TAG
#
# To build a new container, use:
# - `.fdo.container-build@arch`: this will rebuild a new container
# only if $FDO_DISTRIBUTION_TAG is not available in the local registry or
# in the $FDO_UPSTREAM_REPO registry. To force rebuilding the container,
# set the variable $FDO_FORCE_REBUILD.
# we cannot reuse exported variables in after_script,
# so let's have a common definition
......
......@@ -2,40 +2,6 @@
#
# THIS FILE IS GENERATED, DO NOT EDIT
# This template will create a centos image based on the following variables:
#
# - FDO_DISTRIBUTION_VERSION: the centos version (7, 8, etc...)
# - FDO_DISTRIBUTION_PACKAGES: if set, list of packages that needs to be installed
# - FDO_DISTRIBUTION_EXEC: if set, this command will be run once the packages have
# been installed
# - FDO_DISTRIBUTION_NAME: set by these templates to "centos".
# Consider this as read-only variable.
# - FDO_UPSTREAM_REPO: the upstream project on this gitlab instance
# where we might find the given tag (for example:
# `wayland/weston`)
# - FDO_REPO_SUFFIX: The repository name suffix.
# If this variable isn't defined,
# "centos/$FDO_DISTRIBUTION_VERSION" is used for
# the suffix.
# - FDO_DISTRIBUTION_TAG: tag to copy the image from the upstream registry. If the
# tag does not exist, create a new build and tag it
# - FDO_CACHE_DIR: A directory that needs to be mounted as `/cache` during
# $FDO_DISTRIBUTION_EXEC stage. Defaults to `/cache` from the
# host, so that most users should not need this.
# - FDO_FORCE_REBUILD: when set, the container will be rebuild unconditionally.
# - FDO_EXPIRES_AFTER: Allows to set an expiration time for the build image. Useful when
# images are not meant to be kept for eternity.
# The values are something like 1h, 2d, 3w for hour, day and weeks,
# respectively
#
# The resulting image will be pushed in the local registry, under:
# $CI_REGISTRY_IMAGE/$FDO_REPO_SUFFIX:$FDO_DISTRIBUTION_TAG
#
# To build a new container, use:
# - `.fdo.container-build@centos`: this will rebuild a new container
# only if $FDO_DISTRIBUTION_TAG is not available in the local registry or
# in the $FDO_UPSTREAM_REPO registry. To force rebuilding the container,
# set the variable $FDO_FORCE_REBUILD.
# we cannot reuse exported variables in after_script,
# so let's have a common definition
......
......@@ -2,40 +2,6 @@
#
# THIS FILE IS GENERATED, DO NOT EDIT
# This template will create a debian image based on the following variables:
#
# - FDO_DISTRIBUTION_VERSION: the debian version (stretch, sid, buster, etc...)
# - FDO_DISTRIBUTION_PACKAGES: if set, list of packages that needs to be installed
# - FDO_DISTRIBUTION_EXEC: if set, this command will be run once the packages have
# been installed
# - FDO_DISTRIBUTION_NAME: set by these templates to "debian".
# Consider this as read-only variable.
# - FDO_UPSTREAM_REPO: the upstream project on this gitlab instance
# where we might find the given tag (for example:
# `wayland/weston`)
# - FDO_REPO_SUFFIX: The repository name suffix.
# If this variable isn't defined,
# "debian/$FDO_DISTRIBUTION_VERSION" is used for
# the suffix.
# - FDO_DISTRIBUTION_TAG: tag to copy the image from the upstream registry. If the
# tag does not exist, create a new build and tag it
# - FDO_CACHE_DIR: A directory that needs to be mounted as `/cache` during
# $FDO_DISTRIBUTION_EXEC stage. Defaults to `/cache` from the
# host, so that most users should not need this.
# - FDO_FORCE_REBUILD: when set, the container will be rebuild unconditionally.
# - FDO_EXPIRES_AFTER: Allows to set an expiration time for the build image. Useful when
# images are not meant to be kept for eternity.
# The values are something like 1h, 2d, 3w for hour, day and weeks,
# respectively
#
# The resulting image will be pushed in the local registry, under:
# $CI_REGISTRY_IMAGE/$FDO_REPO_SUFFIX:$FDO_DISTRIBUTION_TAG
#
# To build a new container, use:
# - `.fdo.container-build@debian`: this will rebuild a new container
# only if $FDO_DISTRIBUTION_TAG is not available in the local registry or
# in the $FDO_UPSTREAM_REPO registry. To force rebuilding the container,
# set the variable $FDO_FORCE_REBUILD.
# we cannot reuse exported variables in after_script,
# so let's have a common definition
......
......@@ -2,40 +2,6 @@
#
# THIS FILE IS GENERATED, DO NOT EDIT
# This template will create a fedora image based on the following variables:
#
# - FDO_DISTRIBUTION_VERSION: the fedora version (31, 30, 32, 33, etc...)
# - FDO_DISTRIBUTION_PACKAGES: if set, list of packages that needs to be installed
# - FDO_DISTRIBUTION_EXEC: if set, this command will be run once the packages have
# been installed
# - FDO_DISTRIBUTION_NAME: set by these templates to "fedora".
# Consider this as read-only variable.
# - FDO_UPSTREAM_REPO: the upstream project on this gitlab instance
# where we might find the given tag (for example:
# `wayland/weston`)
# - FDO_REPO_SUFFIX: The repository name suffix.
# If this variable isn't defined,
# "fedora/$FDO_DISTRIBUTION_VERSION" is used for
# the suffix.
# - FDO_DISTRIBUTION_TAG: tag to copy the image from the upstream registry. If the
# tag does not exist, create a new build and tag it
# - FDO_CACHE_DIR: A directory that needs to be mounted as `/cache` during
# $FDO_DISTRIBUTION_EXEC stage. Defaults to `/cache` from the
# host, so that most users should not need this.
# - FDO_FORCE_REBUILD: when set, the container will be rebuild unconditionally.
# - FDO_EXPIRES_AFTER: Allows to set an expiration time for the build image. Useful when
# images are not meant to be kept for eternity.
# The values are something like 1h, 2d, 3w for hour, day and weeks,
# respectively
#
# The resulting image will be pushed in the local registry, under:
# $CI_REGISTRY_IMAGE/$FDO_REPO_SUFFIX:$FDO_DISTRIBUTION_TAG
#
# To build a new container, use:
# - `.fdo.container-build@fedora`: this will rebuild a new container
# only if $FDO_DISTRIBUTION_TAG is not available in the local registry or
# in the $FDO_UPSTREAM_REPO registry. To force rebuilding the container,
# set the variable $FDO_FORCE_REBUILD.
# we cannot reuse exported variables in after_script,
# so let's have a common definition
......
......@@ -2,40 +2,6 @@
#
# THIS FILE IS GENERATED, DO NOT EDIT
# This template will create a ubuntu image based on the following variables:
#
# - FDO_DISTRIBUTION_VERSION: the ubuntu version (19.10, 18.04, etc...)
# - FDO_DISTRIBUTION_PACKAGES: if set, list of packages that needs to be installed
# - FDO_DISTRIBUTION_EXEC: if set, this command will be run once the packages have
# been installed
# - FDO_DISTRIBUTION_NAME: set by these templates to "ubuntu".
# Consider this as read-only variable.
# - FDO_UPSTREAM_REPO: the upstream project on this gitlab instance
# where we might find the given tag (for example:
# `wayland/weston`)
# - FDO_REPO_SUFFIX: The repository name suffix.
# If this variable isn't defined,
# "ubuntu/$FDO_DISTRIBUTION_VERSION" is used for
# the suffix.
# - FDO_DISTRIBUTION_TAG: tag to copy the image from the upstream registry. If the
# tag does not exist, create a new build and tag it
# - FDO_CACHE_DIR: A directory that needs to be mounted as `/cache` during
# $FDO_DISTRIBUTION_EXEC stage. Defaults to `/cache` from the
# host, so that most users should not need this.
# - FDO_FORCE_REBUILD: when set, the container will be rebuild unconditionally.
# - FDO_EXPIRES_AFTER: Allows to set an expiration time for the build image. Useful when
# images are not meant to be kept for eternity.
# The values are something like 1h, 2d, 3w for hour, day and weeks,
# respectively
#
# The resulting image will be pushed in the local registry, under:
# $CI_REGISTRY_IMAGE/$FDO_REPO_SUFFIX:$FDO_DISTRIBUTION_TAG
#
# To build a new container, use:
# - `.fdo.container-build@ubuntu`: this will rebuild a new container
# only if $FDO_DISTRIBUTION_TAG is not available in the local registry or
# in the $FDO_UPSTREAM_REPO registry. To force rebuilding the container,
# set the variable $FDO_FORCE_REBUILD.
# we cannot reuse exported variables in after_script,
# so let's have a common definition
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment