Skip to content

Commit caf905c

Browse files
authored
docs: document the base key (#5681)
1 parent 4a76630 commit caf905c

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/reference/project-file/snapcraft-yaml.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,23 @@ values such as its confinement level and supported architectures.
5151
5252
.. kitbash-field:: Project base
5353

54+
**Description**
55+
56+
The base snap to be used as the run-time environment.
57+
58+
If the ``build-base`` key is unset, then the ``base`` key also determines the build
59+
environment. For example, ``base: core24`` builds the snap in an Ubuntu 24.04
60+
environment.
61+
62+
For more information about the ``base`` and ``build-base`` keys, see
63+
:ref:`reference-bases`.
64+
65+
**Examples**
66+
67+
.. code-block:: yaml
68+
69+
base: core24
70+
5471
.. py:currentmodule:: snapcraft.models.project
5572
5673
.. kitbash-field:: Project build_base

0 commit comments

Comments
 (0)