summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/variables.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/variables.rst')
-rw-r--r--documentation/ref-manual/variables.rst64
1 files changed, 64 insertions, 0 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index b6d4fc523f..1c4689343d 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -3956,6 +3956,70 @@ system and gives an overview of their function and contents.
3956 material for Wic is located in the 3956 material for Wic is located in the
3957 ":doc:`/ref-manual/kickstart`" chapter. 3957 ":doc:`/ref-manual/kickstart`" chapter.
3958 3958
3959 :term:`IMAGE_EXTRA_PARTITION_FILES`
3960 A space-separated list of files installed into the extra partition(s)
3961 when preparing an image using the Wic tool with the
3962 ``extra_partition`` source plugin. By default,
3963 the files are
3964 installed under the same name as the source files. To change the
3965 installed name, separate it from the original name with a semi-colon
3966 (;). Source files need to be located in
3967 :term:`DEPLOY_DIR_IMAGE`. Here is an
3968 example::
3969
3970 IMAGE_EXTRA_PARTITION_FILES = "foobar file.conf;config"
3971
3972 In the above example, the file ``foobar`` is installed with its original name
3973 ``foobar``, while the file ``file.conf`` is installed and renamed to ``config``.
3974
3975 Alternatively, source files can be picked up using a glob pattern.
3976 However, hidden files are ignored, and the pattern is non-recursive
3977 (subdirectories are ignored).
3978 The destination file will have the same name as the base
3979 name of the source file path. To install files into a renamed directory
3980 within the target location, pass its name after a semi-colon (;).
3981 Here are two examples::
3982
3983 IMAGE_EXTRA_PARTITION_FILES = "foo/*"
3984 IMAGE_EXTRA_PARTITION_FILES = "foo/*;bar/"
3985
3986 The first line in this example
3987 installs all files from ``foo`` directory
3988 into the root of the target partition. The second line in this example installs
3989 the same files into a ``bar`` directory within the target partition.
3990 The ``bar/`` directory is automatically created if it does not exist.
3991
3992 You can also specify the target by label, UUID or partition name if multiple
3993 extra partitions coexist. Let's take the following example. This would be
3994 the WKS file for the image currently being built::
3995
3996 part --source extra_partition --fstype=ext4 --label foo
3997 part --source extra_partition --fstype=ext4 --uuid e7d0824e-cda3-4bed-9f54-9ef5312d105d
3998 part --source extra_partition --fstype=ext4 --part-name config
3999
4000 And the following configuration::
4001
4002 IMAGE_EXTRA_PARTITION_FILES_label-foo = "foo/*"
4003 IMAGE_EXTRA_PARTITION_FILES_uuid-e7d0824e-cda3-4bed-9f54-9ef5312d105d = "foo/*;bar/"
4004 IMAGE_EXTRA_PARTITION_FILES_part-name-config = "config"
4005
4006 Then:
4007
4008 - The partition labeled "foo" would get all files from the ``foo``
4009 directory.
4010
4011 - The partition whose UUID is "e7d0824e-cda3-4bed-9f54-9ef5312d105d"
4012 would get all files from the ``foo`` directory, installed into a
4013 ``bar`` directory.
4014
4015 - The partition named "config" would get the file ``config``.
4016
4017 You can find information on how to use the Wic tool in the
4018 ":ref:`dev-manual/wic:creating partitioned images using wic`"
4019 section of the Yocto Project Development Tasks Manual. Reference
4020 material for Wic is located in the
4021 ":doc:`/ref-manual/kickstart`" chapter.
4022
3959 :term:`IMAGE_FEATURES` 4023 :term:`IMAGE_FEATURES`
3960 The primary list of features to include in an image. Typically, you 4024 The primary list of features to include in an image. Typically, you
3961 configure this variable in an image recipe. Although you can use this 4025 configure this variable in an image recipe. Although you can use this