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

doc: add some examples in the API docs


Signed-off-by: Peter Hutterer's avatarPeter Hutterer <peter.hutterer@who-t.net>
parent a7123024
......@@ -102,6 +102,21 @@
# the image is copied into this project's registry.
# If no such image exists, the image is built and pushed to the local registry.
#
# **Example:**
#
# .. code-block:: yaml
#
# my-{{distribution}}-image:
# extends: .fdo.container-build@{{distribution}}
# variables:
# FDO_DISTRIBUTION_PACKAGES: 'curl wget gcc valgrind'
{% if not version %}
# FDO_DISTRIBUTION_VERSION: '{{versions[0]}}'
{% endif %}
# FDO_DISTRIBUTION_TAG: '2020-03-20'
#
#
#
# **Reserved by this template:**
#
# - ``image:`` do not override
......@@ -494,6 +509,21 @@
#
# This template sets ``image:`` to the generated image. You may override this.
#
# **Example:**
#
# .. code-block:: yaml
#
# my-{{distribution}}-test:
# extends: .fdo.distribution-image@{{distribution}}
# variables:
{% if not version %}
# FDO_DISTRIBUTION_VERSION: '{{versions[0]}}'
{% endif %}
# FDO_DISTRIBUTION_TAG: '2020-03-20'
# script:
# - meson builddir
# - ninja -C builddir test
#
# **Variables:**
#
{% if not version %}
......@@ -550,6 +580,20 @@
#
# This template sets ``image:`` to the generated image. You may override this.
#
# **Example:**
#
# .. code-block:: yaml
#
# my-{{distribution}}-test:
# extends: .fdo.distribution-image@{{distribution}}
# variables:
# FDO_REPO_SUFFIX: 'some/path'
# FDO_DISTRIBUTION_TAG: '2020-03-20'
# script:
# - meson builddir
# - ninja -C builddir test
#
#
# **Variables:**
#
# .. attribute:: FDO_REPO_SUFFIX
......
......@@ -98,6 +98,18 @@
# the image is copied into this project's registry.
# If no such image exists, the image is built and pushed to the local registry.
#
# **Example:**
#
# .. code-block:: yaml
#
# my-alpine-image:
# extends: .fdo.container-build@alpine
# variables:
# FDO_DISTRIBUTION_PACKAGES: 'curl wget gcc valgrind'
# FDO_DISTRIBUTION_TAG: '2020-03-20'
#
#
#
# **Reserved by this template:**
#
# - ``image:`` do not override
......@@ -270,6 +282,18 @@
#
# This template sets ``image:`` to the generated image. You may override this.
#
# **Example:**
#
# .. code-block:: yaml
#
# my-alpine-test:
# extends: .fdo.distribution-image@alpine
# variables:
# FDO_DISTRIBUTION_TAG: '2020-03-20'
# script:
# - meson builddir
# - ninja -C builddir test
#
# **Variables:**
#
# .. attribute:: FDO_DISTRIBUTION_TAG
......@@ -308,6 +332,20 @@
#
# This template sets ``image:`` to the generated image. You may override this.
#
# **Example:**
#
# .. code-block:: yaml
#
# my-alpine-test:
# extends: .fdo.distribution-image@alpine
# variables:
# FDO_REPO_SUFFIX: 'some/path'
# FDO_DISTRIBUTION_TAG: '2020-03-20'
# script:
# - meson builddir
# - ninja -C builddir test
#
#
# **Variables:**
#
# .. attribute:: FDO_REPO_SUFFIX
......
......@@ -98,6 +98,18 @@
# the image is copied into this project's registry.
# If no such image exists, the image is built and pushed to the local registry.
#
# **Example:**
#
# .. code-block:: yaml
#
# my-arch-image:
# extends: .fdo.container-build@arch
# variables:
# FDO_DISTRIBUTION_PACKAGES: 'curl wget gcc valgrind'
# FDO_DISTRIBUTION_TAG: '2020-03-20'
#
#
#
# **Reserved by this template:**
#
# - ``image:`` do not override
......@@ -257,6 +269,18 @@
#
# This template sets ``image:`` to the generated image. You may override this.
#
# **Example:**
#
# .. code-block:: yaml
#
# my-arch-test:
# extends: .fdo.distribution-image@arch
# variables:
# FDO_DISTRIBUTION_TAG: '2020-03-20'
# script:
# - meson builddir
# - ninja -C builddir test
#
# **Variables:**
#
# .. attribute:: FDO_DISTRIBUTION_TAG
......@@ -295,6 +319,20 @@
#
# This template sets ``image:`` to the generated image. You may override this.
#
# **Example:**
#
# .. code-block:: yaml
#
# my-arch-test:
# extends: .fdo.distribution-image@arch
# variables:
# FDO_REPO_SUFFIX: 'some/path'
# FDO_DISTRIBUTION_TAG: '2020-03-20'
# script:
# - meson builddir
# - ninja -C builddir test
#
#
# **Variables:**
#
# .. attribute:: FDO_REPO_SUFFIX
......
......@@ -97,6 +97,19 @@
# the image is copied into this project's registry.
# If no such image exists, the image is built and pushed to the local registry.
#
# **Example:**
#
# .. code-block:: yaml
#
# my-centos-image:
# extends: .fdo.container-build@centos
# variables:
# FDO_DISTRIBUTION_PACKAGES: 'curl wget gcc valgrind'
# FDO_DISTRIBUTION_VERSION: '7'
# FDO_DISTRIBUTION_TAG: '2020-03-20'
#
#
#
# **Reserved by this template:**
#
# - ``image:`` do not override
......@@ -261,6 +274,19 @@
#
# This template sets ``image:`` to the generated image. You may override this.
#
# **Example:**
#
# .. code-block:: yaml
#
# my-centos-test:
# extends: .fdo.distribution-image@centos
# variables:
# FDO_DISTRIBUTION_VERSION: '7'
# FDO_DISTRIBUTION_TAG: '2020-03-20'
# script:
# - meson builddir
# - ninja -C builddir test
#
# **Variables:**
#
# .. attribute:: FDO_DISTRIBUTION_VERSION
......@@ -307,6 +333,20 @@
#
# This template sets ``image:`` to the generated image. You may override this.
#
# **Example:**
#
# .. code-block:: yaml
#
# my-centos-test:
# extends: .fdo.distribution-image@centos
# variables:
# FDO_REPO_SUFFIX: 'some/path'
# FDO_DISTRIBUTION_TAG: '2020-03-20'
# script:
# - meson builddir
# - ninja -C builddir test
#
#
# **Variables:**
#
# .. attribute:: FDO_REPO_SUFFIX
......
......@@ -97,6 +97,19 @@
# the image is copied into this project's registry.
# If no such image exists, the image is built and pushed to the local registry.
#
# **Example:**
#
# .. code-block:: yaml
#
# my-debian-image:
# extends: .fdo.container-build@debian
# variables:
# FDO_DISTRIBUTION_PACKAGES: 'curl wget gcc valgrind'
# FDO_DISTRIBUTION_VERSION: 'stretch'
# FDO_DISTRIBUTION_TAG: '2020-03-20'
#
#
#
# **Reserved by this template:**
#
# - ``image:`` do not override
......@@ -460,6 +473,19 @@
#
# This template sets ``image:`` to the generated image. You may override this.
#
# **Example:**
#
# .. code-block:: yaml
#
# my-debian-test:
# extends: .fdo.distribution-image@debian
# variables:
# FDO_DISTRIBUTION_VERSION: 'stretch'
# FDO_DISTRIBUTION_TAG: '2020-03-20'
# script:
# - meson builddir
# - ninja -C builddir test
#
# **Variables:**
#
# .. attribute:: FDO_DISTRIBUTION_VERSION
......@@ -506,6 +532,20 @@
#
# This template sets ``image:`` to the generated image. You may override this.
#
# **Example:**
#
# .. code-block:: yaml
#
# my-debian-test:
# extends: .fdo.distribution-image@debian
# variables:
# FDO_REPO_SUFFIX: 'some/path'
# FDO_DISTRIBUTION_TAG: '2020-03-20'
# script:
# - meson builddir
# - ninja -C builddir test
#
#
# **Variables:**
#
# .. attribute:: FDO_REPO_SUFFIX
......
......@@ -97,6 +97,19 @@
# the image is copied into this project's registry.
# If no such image exists, the image is built and pushed to the local registry.
#
# **Example:**
#
# .. code-block:: yaml
#
# my-fedora-image:
# extends: .fdo.container-build@fedora
# variables:
# FDO_DISTRIBUTION_PACKAGES: 'curl wget gcc valgrind'
# FDO_DISTRIBUTION_VERSION: '31'
# FDO_DISTRIBUTION_TAG: '2020-03-20'
#
#
#
# **Reserved by this template:**
#
# - ``image:`` do not override
......@@ -451,6 +464,19 @@
#
# This template sets ``image:`` to the generated image. You may override this.
#
# **Example:**
#
# .. code-block:: yaml
#
# my-fedora-test:
# extends: .fdo.distribution-image@fedora
# variables:
# FDO_DISTRIBUTION_VERSION: '31'
# FDO_DISTRIBUTION_TAG: '2020-03-20'
# script:
# - meson builddir
# - ninja -C builddir test
#
# **Variables:**
#
# .. attribute:: FDO_DISTRIBUTION_VERSION
......@@ -497,6 +523,20 @@
#
# This template sets ``image:`` to the generated image. You may override this.
#
# **Example:**
#
# .. code-block:: yaml
#
# my-fedora-test:
# extends: .fdo.distribution-image@fedora
# variables:
# FDO_REPO_SUFFIX: 'some/path'
# FDO_DISTRIBUTION_TAG: '2020-03-20'
# script:
# - meson builddir
# - ninja -C builddir test
#
#
# **Variables:**
#
# .. attribute:: FDO_REPO_SUFFIX
......
......@@ -97,6 +97,19 @@
# the image is copied into this project's registry.
# If no such image exists, the image is built and pushed to the local registry.
#
# **Example:**
#
# .. code-block:: yaml
#
# my-ubuntu-image:
# extends: .fdo.container-build@ubuntu
# variables:
# FDO_DISTRIBUTION_PACKAGES: 'curl wget gcc valgrind'
# FDO_DISTRIBUTION_VERSION: '19.10'
# FDO_DISTRIBUTION_TAG: '2020-03-20'
#
#
#
# **Reserved by this template:**
#
# - ``image:`` do not override
......@@ -504,6 +517,19 @@
#
# This template sets ``image:`` to the generated image. You may override this.
#
# **Example:**
#
# .. code-block:: yaml
#
# my-ubuntu-test:
# extends: .fdo.distribution-image@ubuntu
# variables:
# FDO_DISTRIBUTION_VERSION: '19.10'
# FDO_DISTRIBUTION_TAG: '2020-03-20'
# script:
# - meson builddir
# - ninja -C builddir test
#
# **Variables:**
#
# .. attribute:: FDO_DISTRIBUTION_VERSION
......@@ -550,6 +576,20 @@
#
# This template sets ``image:`` to the generated image. You may override this.
#
# **Example:**
#
# .. code-block:: yaml
#
# my-ubuntu-test:
# extends: .fdo.distribution-image@ubuntu
# variables:
# FDO_REPO_SUFFIX: 'some/path'
# FDO_DISTRIBUTION_TAG: '2020-03-20'
# script:
# - meson builddir
# - ninja -C builddir test
#
#
# **Variables:**
#
# .. attribute:: FDO_REPO_SUFFIX
......
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