diff options
Diffstat (limited to 'documentation/dev-manual/common-tasks.rst')
-rw-r--r-- | documentation/dev-manual/common-tasks.rst | 159 |
1 files changed, 81 insertions, 78 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 0c267d5f48..c25af4eff2 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst | |||
@@ -5598,13 +5598,13 @@ file:: | |||
5598 | ./mkefidisk-201804191017-sda.direct | 5598 | ./mkefidisk-201804191017-sda.direct |
5599 | 5599 | ||
5600 | The following build artifacts were used to create the image(s): | 5600 | The following build artifacts were used to create the image(s): |
5601 | ROOTFS_DIR: /home/stephano/build/master/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/rootfs | 5601 | ROOTFS_DIR: /home/stephano/yocto/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/rootfs |
5602 | BOOTIMG_DIR: /home/stephano/build/master/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/recipe-sysroot/usr/share | 5602 | BOOTIMG_DIR: /home/stephano/yocto/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/recipe-sysroot/usr/share |
5603 | KERNEL_DIR: /home/stephano/build/master/build/tmp-glibc/deploy/images/qemux86 | 5603 | KERNEL_DIR: /home/stephano/yocto/build/tmp-glibc/deploy/images/qemux86 |
5604 | NATIVE_SYSROOT: /home/stephano/build/master/build/tmp-glibc/work/i586-oe-linux/wic-tools/1.0-r0/recipe-sysroot-native | 5604 | NATIVE_SYSROOT: /home/stephano/yocto/build/tmp-glibc/work/i586-oe-linux/wic-tools/1.0-r0/recipe-sysroot-native |
5605 | 5605 | ||
5606 | INFO: The image(s) were created using OE kickstart file: | 5606 | INFO: The image(s) were created using OE kickstart file: |
5607 | /home/stephano/build/master/openembedded-core/scripts/lib/wic/canned-wks/mkefidisk.wks | 5607 | /home/stephano/yocto/openembedded-core/scripts/lib/wic/canned-wks/mkefidisk.wks |
5608 | 5608 | ||
5609 | The previous example shows the easiest way to create an image by running | 5609 | The previous example shows the easiest way to create an image by running |
5610 | in cooked mode and supplying a kickstart file and the "-e" option to | 5610 | in cooked mode and supplying a kickstart file and the "-e" option to |
@@ -5665,8 +5665,8 @@ in the ``scripts/lib/image/canned-wks`` directory and then by changing | |||
5665 | the lines that specify the target disk from which to boot. | 5665 | the lines that specify the target disk from which to boot. |
5666 | :: | 5666 | :: |
5667 | 5667 | ||
5668 | $ cp /home/stephano/poky/scripts/lib/wic/canned-wks/directdisk-gpt.wks \ | 5668 | $ cp /home/stephano/yocto/poky/scripts/lib/wic/canned-wks/directdisk-gpt.wks \ |
5669 | /home/stephano/poky/scripts/lib/wic/canned-wks/directdisksdb-gpt.wks | 5669 | /home/stephano/yocto/poky/scripts/lib/wic/canned-wks/directdisksdb-gpt.wks |
5670 | 5670 | ||
5671 | Next, the example modifies the ``directdisksdb-gpt.wks`` file and | 5671 | Next, the example modifies the ``directdisksdb-gpt.wks`` file and |
5672 | changes all instances of "``--ondisk sda``" to "``--ondisk sdb``". The | 5672 | changes all instances of "``--ondisk sda``" to "``--ondisk sdb``". The |
@@ -5698,13 +5698,13 @@ Computing (nuc) :term:`MACHINE` the | |||
5698 | ./directdisksdb-gpt-201710090938-sdb.direct | 5698 | ./directdisksdb-gpt-201710090938-sdb.direct |
5699 | 5699 | ||
5700 | The following build artifacts were used to create the image(s): | 5700 | The following build artifacts were used to create the image(s): |
5701 | ROOTFS_DIR: /home/stephano/build/master/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/rootfs | 5701 | ROOTFS_DIR: /home/stephano/yocto/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/rootfs |
5702 | BOOTIMG_DIR: /home/stephano/build/master/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/recipe-sysroot/usr/share | 5702 | BOOTIMG_DIR: /home/stephano/yocto/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/recipe-sysroot/usr/share |
5703 | KERNEL_DIR: /home/stephano/build/master/build/tmp-glibc/deploy/images/qemux86 | 5703 | KERNEL_DIR: /home/stephano/yocto/build/tmp-glibc/deploy/images/qemux86 |
5704 | NATIVE_SYSROOT: /home/stephano/build/master/build/tmp-glibc/work/i586-oe-linux/wic-tools/1.0-r0/recipe-sysroot-native | 5704 | NATIVE_SYSROOT: /home/stephano/yocto/build/tmp-glibc/work/i586-oe-linux/wic-tools/1.0-r0/recipe-sysroot-native |
5705 | 5705 | ||
5706 | INFO: The image(s) were created using OE kickstart file: | 5706 | INFO: The image(s) were created using OE kickstart file: |
5707 | /home/stephano/poky/scripts/lib/wic/canned-wks/directdisksdb-gpt.wks | 5707 | /home/stephano/yocto/poky/scripts/lib/wic/canned-wks/directdisksdb-gpt.wks |
5708 | 5708 | ||
5709 | Continuing with the example, you can now directly ``dd`` the image to a | 5709 | Continuing with the example, you can now directly ``dd`` the image to a |
5710 | USB stick, or whatever media for which you built your image, and boot | 5710 | USB stick, or whatever media for which you built your image, and boot |
@@ -5724,11 +5724,11 @@ Mode) and uses a modified kickstart file. The example also uses the | |||
5724 | ``-o`` option to cause Wic to create the output somewhere other than the | 5724 | ``-o`` option to cause Wic to create the output somewhere other than the |
5725 | default output directory, which is the current directory:: | 5725 | default output directory, which is the current directory:: |
5726 | 5726 | ||
5727 | $ wic create /home/stephano/my_yocto/test.wks -o /home/stephano/testwic \ | 5727 | $ wic create test.wks -o /home/stephano/testwic \ |
5728 | --rootfs-dir /home/stephano/build/master/build/tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/rootfs \ | 5728 | --rootfs-dir /home/stephano/yocto/build/tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/rootfs \ |
5729 | --bootimg-dir /home/stephano/build/master/build/tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/recipe-sysroot/usr/share \ | 5729 | --bootimg-dir /home/stephano/yocto/build/tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/recipe-sysroot/usr/share \ |
5730 | --kernel-dir /home/stephano/build/master/build/tmp/deploy/images/qemux86 \ | 5730 | --kernel-dir /home/stephano/yocto/build/tmp/deploy/images/qemux86 \ |
5731 | --native-sysroot /home/stephano/build/master/build/tmp/work/i586-poky-linux/wic-tools/1.0-r0/recipe-sysroot-native | 5731 | --native-sysroot /home/stephano/yocto/build/tmp/work/i586-poky-linux/wic-tools/1.0-r0/recipe-sysroot-native |
5732 | 5732 | ||
5733 | INFO: Creating image(s)... | 5733 | INFO: Creating image(s)... |
5734 | 5734 | ||
@@ -5736,13 +5736,13 @@ default output directory, which is the current directory:: | |||
5736 | /home/stephano/testwic/test-201710091445-sdb.direct | 5736 | /home/stephano/testwic/test-201710091445-sdb.direct |
5737 | 5737 | ||
5738 | The following build artifacts were used to create the image(s): | 5738 | The following build artifacts were used to create the image(s): |
5739 | ROOTFS_DIR: /home/stephano/build/master/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/rootfs | 5739 | ROOTFS_DIR: /home/stephano/yocto/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/rootfs |
5740 | BOOTIMG_DIR: /home/stephano/build/master/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/recipe-sysroot/usr/share | 5740 | BOOTIMG_DIR: /home/stephano/yocto/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/recipe-sysroot/usr/share |
5741 | KERNEL_DIR: /home/stephano/build/master/build/tmp-glibc/deploy/images/qemux86 | 5741 | KERNEL_DIR: /home/stephano/yocto/build/tmp-glibc/deploy/images/qemux86 |
5742 | NATIVE_SYSROOT: /home/stephano/build/master/build/tmp-glibc/work/i586-oe-linux/wic-tools/1.0-r0/recipe-sysroot-native | 5742 | NATIVE_SYSROOT: /home/stephano/yocto/build/tmp-glibc/work/i586-oe-linux/wic-tools/1.0-r0/recipe-sysroot-native |
5743 | 5743 | ||
5744 | INFO: The image(s) were created using OE kickstart file: | 5744 | INFO: The image(s) were created using OE kickstart file: |
5745 | /home/stephano/my_yocto/test.wks | 5745 | test.wks |
5746 | 5746 | ||
5747 | For this example, | 5747 | For this example, |
5748 | :term:`MACHINE` did not have to be | 5748 | :term:`MACHINE` did not have to be |
@@ -7097,7 +7097,7 @@ Generating and Using Signed Packages | |||
7097 | In order to add security to RPM packages used during a build, you can | 7097 | In order to add security to RPM packages used during a build, you can |
7098 | take steps to securely sign them. Once a signature is verified, the | 7098 | take steps to securely sign them. Once a signature is verified, the |
7099 | OpenEmbedded build system can use the package in the build. If security | 7099 | OpenEmbedded build system can use the package in the build. If security |
7100 | fails for a signed package, the build system aborts the build. | 7100 | fails for a signed package, the build system stops the build. |
7101 | 7101 | ||
7102 | This section describes how to sign RPM packages during a build and how | 7102 | This section describes how to sign RPM packages during a build and how |
7103 | to use signed package feeds (repositories) when doing a build. | 7103 | to use signed package feeds (repositories) when doing a build. |
@@ -8392,11 +8392,11 @@ The OpenEmbedded build system can run tests on real hardware, and for | |||
8392 | certain devices it can also deploy the image to be tested onto the | 8392 | certain devices it can also deploy the image to be tested onto the |
8393 | device beforehand. | 8393 | device beforehand. |
8394 | 8394 | ||
8395 | For automated deployment, a "master image" is installed onto the | 8395 | For automated deployment, a "controller image" is installed onto the |
8396 | hardware once as part of setup. Then, each time tests are to be run, the | 8396 | hardware once as part of setup. Then, each time tests are to be run, the |
8397 | following occurs: | 8397 | following occurs: |
8398 | 8398 | ||
8399 | 1. The master image is booted into and used to write the image to be | 8399 | 1. The controller image is booted into and used to write the image to be |
8400 | tested to a second partition. | 8400 | tested to a second partition. |
8401 | 8401 | ||
8402 | 2. The device is then rebooted using an external script that you need to | 8402 | 2. The device is then rebooted using an external script that you need to |
@@ -8465,15 +8465,15 @@ not need any information in this section. You can skip down to the | |||
8465 | ":ref:`dev-manual/common-tasks:running tests`" section. | 8465 | ":ref:`dev-manual/common-tasks:running tests`" section. |
8466 | 8466 | ||
8467 | If you did set :term:`TEST_TARGET` to "SystemdbootTarget", you also need to | 8467 | If you did set :term:`TEST_TARGET` to "SystemdbootTarget", you also need to |
8468 | perform a one-time setup of your master image by doing the following: | 8468 | perform a one-time setup of your controller image by doing the following: |
8469 | 8469 | ||
8470 | 1. *Set EFI_PROVIDER:* Be sure that :term:`EFI_PROVIDER` is as follows:: | 8470 | 1. *Set EFI_PROVIDER:* Be sure that :term:`EFI_PROVIDER` is as follows:: |
8471 | 8471 | ||
8472 | EFI_PROVIDER = "systemd-boot" | 8472 | EFI_PROVIDER = "systemd-boot" |
8473 | 8473 | ||
8474 | 2. *Build the master image:* Build the ``core-image-testmaster`` image. | 8474 | 2. *Build the controller image:* Build the ``core-image-testmaster`` image. |
8475 | The ``core-image-testmaster`` recipe is provided as an example for a | 8475 | The ``core-image-testmaster`` recipe is provided as an example for a |
8476 | "master" image and you can customize the image recipe as you would | 8476 | "controller" image and you can customize the image recipe as you would |
8477 | any other recipe. | 8477 | any other recipe. |
8478 | 8478 | ||
8479 | Here are the image recipe requirements: | 8479 | Here are the image recipe requirements: |
@@ -9588,51 +9588,51 @@ If you examine the output or the log file, you see the failure during | |||
9588 | | /bin/mkdir -p include/near | 9588 | | /bin/mkdir -p include/near |
9589 | | /bin/mkdir -p include/near | 9589 | | /bin/mkdir -p include/near |
9590 | | /bin/mkdir -p include/near | 9590 | | /bin/mkdir -p include/near |
9591 | | ln -s /home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ | 9591 | | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ |
9592 | 0.14-r0/neard-0.14/include/types.h include/near/types.h | 9592 | 0.14-r0/neard-0.14/include/types.h include/near/types.h |
9593 | | ln -s /home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ | 9593 | | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ |
9594 | 0.14-r0/neard-0.14/include/log.h include/near/log.h | 9594 | 0.14-r0/neard-0.14/include/log.h include/near/log.h |
9595 | | ln -s /home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ | 9595 | | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ |
9596 | 0.14-r0/neard-0.14/include/plugin.h include/near/plugin.h | 9596 | 0.14-r0/neard-0.14/include/plugin.h include/near/plugin.h |
9597 | | /bin/mkdir -p include/near | 9597 | | /bin/mkdir -p include/near |
9598 | | /bin/mkdir -p include/near | 9598 | | /bin/mkdir -p include/near |
9599 | | /bin/mkdir -p include/near | 9599 | | /bin/mkdir -p include/near |
9600 | | ln -s /home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ | 9600 | | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ |
9601 | 0.14-r0/neard-0.14/include/tag.h include/near/tag.h | 9601 | 0.14-r0/neard-0.14/include/tag.h include/near/tag.h |
9602 | | /bin/mkdir -p include/near | 9602 | | /bin/mkdir -p include/near |
9603 | | ln -s /home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ | 9603 | | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ |
9604 | 0.14-r0/neard-0.14/include/adapter.h include/near/adapter.h | 9604 | 0.14-r0/neard-0.14/include/adapter.h include/near/adapter.h |
9605 | | /bin/mkdir -p include/near | 9605 | | /bin/mkdir -p include/near |
9606 | | ln -s /home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ | 9606 | | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ |
9607 | 0.14-r0/neard-0.14/include/ndef.h include/near/ndef.h | 9607 | 0.14-r0/neard-0.14/include/ndef.h include/near/ndef.h |
9608 | | ln -s /home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ | 9608 | | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ |
9609 | 0.14-r0/neard-0.14/include/tlv.h include/near/tlv.h | 9609 | 0.14-r0/neard-0.14/include/tlv.h include/near/tlv.h |
9610 | | /bin/mkdir -p include/near | 9610 | | /bin/mkdir -p include/near |
9611 | | /bin/mkdir -p include/near | 9611 | | /bin/mkdir -p include/near |
9612 | | ln -s /home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ | 9612 | | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ |
9613 | 0.14-r0/neard-0.14/include/setting.h include/near/setting.h | 9613 | 0.14-r0/neard-0.14/include/setting.h include/near/setting.h |
9614 | | /bin/mkdir -p include/near | 9614 | | /bin/mkdir -p include/near |
9615 | | /bin/mkdir -p include/near | 9615 | | /bin/mkdir -p include/near |
9616 | | /bin/mkdir -p include/near | 9616 | | /bin/mkdir -p include/near |
9617 | | ln -s /home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ | 9617 | | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ |
9618 | 0.14-r0/neard-0.14/include/device.h include/near/device.h | 9618 | 0.14-r0/neard-0.14/include/device.h include/near/device.h |
9619 | | ln -s /home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ | 9619 | | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ |
9620 | 0.14-r0/neard-0.14/include/nfc_copy.h include/near/nfc_copy.h | 9620 | 0.14-r0/neard-0.14/include/nfc_copy.h include/near/nfc_copy.h |
9621 | | ln -s /home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ | 9621 | | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ |
9622 | 0.14-r0/neard-0.14/include/snep.h include/near/snep.h | 9622 | 0.14-r0/neard-0.14/include/snep.h include/near/snep.h |
9623 | | ln -s /home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ | 9623 | | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ |
9624 | 0.14-r0/neard-0.14/include/version.h include/near/version.h | 9624 | 0.14-r0/neard-0.14/include/version.h include/near/version.h |
9625 | | ln -s /home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ | 9625 | | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ |
9626 | 0.14-r0/neard-0.14/include/dbus.h include/near/dbus.h | 9626 | 0.14-r0/neard-0.14/include/dbus.h include/near/dbus.h |
9627 | | ./src/genbuiltin nfctype1 nfctype2 nfctype3 nfctype4 p2p > src/builtin.h | 9627 | | ./src/genbuiltin nfctype1 nfctype2 nfctype3 nfctype4 p2p > src/builtin.h |
9628 | | i586-poky-linux-gcc -m32 -march=i586 --sysroot=/home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/ | 9628 | | i586-poky-linux-gcc -m32 -march=i586 --sysroot=/home/pokybuild/yocto-autobuilder/nightly-x86/ |
9629 | build/build/tmp/sysroots/qemux86 -DHAVE_CONFIG_H -I. -I./include -I./src -I./gdbus -I/home/pokybuild/ | 9629 | build/build/tmp/sysroots/qemux86 -DHAVE_CONFIG_H -I. -I./include -I./src -I./gdbus -I/home/pokybuild/ |
9630 | yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/sysroots/qemux86/usr/include/glib-2.0 | 9630 | yocto-autobuilder/nightly-x86/build/build/tmp/sysroots/qemux86/usr/include/glib-2.0 |
9631 | -I/home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/sysroots/qemux86/usr/ | 9631 | -I/home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/sysroots/qemux86/usr/ |
9632 | lib/glib-2.0/include -I/home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/ | 9632 | lib/glib-2.0/include -I/home/pokybuild/yocto-autobuilder/nightly-x86/build/build/ |
9633 | tmp/sysroots/qemux86/usr/include/dbus-1.0 -I/home/pokybuild/yocto-autobuilder/yocto-slave/ | 9633 | tmp/sysroots/qemux86/usr/include/dbus-1.0 -I/home/pokybuild/yocto-autobuilder/ |
9634 | nightly-x86/build/build/tmp/sysroots/qemux86/usr/lib/dbus-1.0/include -I/home/pokybuild/yocto-autobuilder/ | 9634 | nightly-x86/build/build/tmp/sysroots/qemux86/usr/lib/dbus-1.0/include -I/home/pokybuild/yocto-autobuilder/ |
9635 | yocto-slave/nightly-x86/build/build/tmp/sysroots/qemux86/usr/include/libnl3 | 9635 | nightly-x86/build/build/tmp/sysroots/qemux86/usr/include/libnl3 |
9636 | -DNEAR_PLUGIN_BUILTIN -DPLUGINDIR=\""/usr/lib/near/plugins"\" | 9636 | -DNEAR_PLUGIN_BUILTIN -DPLUGINDIR=\""/usr/lib/near/plugins"\" |
9637 | -DCONFIGDIR=\""/etc/neard\"" -O2 -pipe -g -feliminate-unused-debug-types -c | 9637 | -DCONFIGDIR=\""/etc/neard\"" -O2 -pipe -g -feliminate-unused-debug-types -c |
9638 | -o tools/snep-send.o tools/snep-send.c | 9638 | -o tools/snep-send.o tools/snep-send.c |
@@ -10810,12 +10810,12 @@ package:: | |||
10810 | LICENSE_FLAGS_WHITELIST = "commercial_gst-plugins-ugly license_emgd_1.10" | 10810 | LICENSE_FLAGS_WHITELIST = "commercial_gst-plugins-ugly license_emgd_1.10" |
10811 | 10811 | ||
10812 | As a convenience, you do not need to specify the | 10812 | As a convenience, you do not need to specify the |
10813 | complete license string in the whitelist for every package. You can use | 10813 | complete license string for every package. You can use |
10814 | an abbreviated form, which consists of just the first portion or | 10814 | an abbreviated form, which consists of just the first portion or |
10815 | portions of the license string before the initial underscore character | 10815 | portions of the license string before the initial underscore character |
10816 | or characters. A partial string will match any license that contains the | 10816 | or characters. A partial string will match any license that contains the |
10817 | given string as the first portion of its license. For example, the | 10817 | given string as the first portion of its license. For example, the |
10818 | following whitelist string will also match both of the packages | 10818 | following value will also match both of the packages |
10819 | previously mentioned as well as any other packages that have licenses | 10819 | previously mentioned as well as any other packages that have licenses |
10820 | starting with "commercial" or "license". | 10820 | starting with "commercial" or "license". |
10821 | :: | 10821 | :: |
@@ -10828,8 +10828,8 @@ License Flag Matching | |||
10828 | License flag matching allows you to control what recipes the | 10828 | License flag matching allows you to control what recipes the |
10829 | OpenEmbedded build system includes in the build. Fundamentally, the | 10829 | OpenEmbedded build system includes in the build. Fundamentally, the |
10830 | build system attempts to match :term:`LICENSE_FLAGS` strings found in | 10830 | build system attempts to match :term:`LICENSE_FLAGS` strings found in |
10831 | recipes against :term:`LICENSE_FLAGS_WHITELIST` strings found in the | 10831 | recipes against strings found in :term:`LICENSE_FLAGS_WHITELIST`. |
10832 | whitelist. A match causes the build system to include a recipe in the | 10832 | A match causes the build system to include a recipe in the |
10833 | build, while failure to find a match causes the build system to exclude | 10833 | build, while failure to find a match causes the build system to exclude |
10834 | a recipe. | 10834 | a recipe. |
10835 | 10835 | ||
@@ -10837,18 +10837,19 @@ In general, license flag matching is simple. However, understanding some | |||
10837 | concepts will help you correctly and effectively use matching. | 10837 | concepts will help you correctly and effectively use matching. |
10838 | 10838 | ||
10839 | Before a flag defined by a particular recipe is tested against the | 10839 | Before a flag defined by a particular recipe is tested against the |
10840 | contents of the whitelist, the expanded string ``_${PN}`` is appended to | 10840 | entries of :term:`LICENSE_FLAGS_WHITELIST`, the expanded |
10841 | the flag. This expansion makes each :term:`LICENSE_FLAGS` value | 10841 | string ``_${PN}`` is appended to the flag. This expansion makes each |
10842 | recipe-specific. After expansion, the string is then matched against the | 10842 | :term:`LICENSE_FLAGS` value recipe-specific. After expansion, the |
10843 | whitelist. Thus, specifying ``LICENSE_FLAGS = "commercial"`` in recipe | 10843 | string is then matched against the entries. Thus, specifying |
10844 | "foo", for example, results in the string ``"commercial_foo"``. And, to | 10844 | ``LICENSE_FLAGS = "commercial"`` in recipe "foo", for example, results |
10845 | create a match, that string must appear in the whitelist. | 10845 | in the string ``"commercial_foo"``. And, to create a match, that string |
10846 | must appear among the entries of :term:`LICENSE_FLAGS_WHITELIST`. | ||
10846 | 10847 | ||
10847 | Judicious use of the :term:`LICENSE_FLAGS` strings and the contents of the | 10848 | Judicious use of the :term:`LICENSE_FLAGS` strings and the contents of the |
10848 | :term:`LICENSE_FLAGS_WHITELIST` variable allows you a lot of flexibility for | 10849 | :term:`LICENSE_FLAGS_WHITELIST` variable allows you a lot of flexibility for |
10849 | including or excluding recipes based on licensing. For example, you can | 10850 | including or excluding recipes based on licensing. For example, you can |
10850 | broaden the matching capabilities by using license flags string subsets | 10851 | broaden the matching capabilities by using license flags string subsets |
10851 | in the whitelist. | 10852 | in :term:`LICENSE_FLAGS_WHITELIST`. |
10852 | 10853 | ||
10853 | .. note:: | 10854 | .. note:: |
10854 | 10855 | ||
@@ -10856,43 +10857,44 @@ in the whitelist. | |||
10856 | string that precedes the appended underscore character (e.g. | 10857 | string that precedes the appended underscore character (e.g. |
10857 | ``usethispart_1.3``, ``usethispart_1.4``, and so forth). | 10858 | ``usethispart_1.3``, ``usethispart_1.4``, and so forth). |
10858 | 10859 | ||
10859 | For example, simply specifying the string "commercial" in the whitelist | 10860 | For example, simply specifying the string "commercial" in the |
10860 | matches any expanded :term:`LICENSE_FLAGS` definition that starts with the | 10861 | :term:`LICENSE_FLAGS_WHITELIST` variable matches any expanded |
10861 | string "commercial" such as "commercial_foo" and "commercial_bar", which | 10862 | :term:`LICENSE_FLAGS` definition that starts with the string |
10863 | "commercial" such as "commercial_foo" and "commercial_bar", which | ||
10862 | are the strings the build system automatically generates for | 10864 | are the strings the build system automatically generates for |
10863 | hypothetical recipes named "foo" and "bar" assuming those recipes simply | 10865 | hypothetical recipes named "foo" and "bar" assuming those recipes simply |
10864 | specify the following:: | 10866 | specify the following:: |
10865 | 10867 | ||
10866 | LICENSE_FLAGS = "commercial" | 10868 | LICENSE_FLAGS = "commercial" |
10867 | 10869 | ||
10868 | Thus, you can choose | 10870 | Thus, you can choose to exhaustively enumerate each license flag in the |
10869 | to exhaustively enumerate each license flag in the whitelist and allow | 10871 | list and allow only specific recipes into the image, or you can use a |
10870 | only specific recipes into the image, or you can use a string subset | 10872 | string subset that causes a broader range of matches to allow a range of |
10871 | that causes a broader range of matches to allow a range of recipes into | 10873 | recipes into the image. |
10872 | the image. | ||
10873 | 10874 | ||
10874 | This scheme works even if the :term:`LICENSE_FLAGS` string already has | 10875 | This scheme works even if the :term:`LICENSE_FLAGS` string already has |
10875 | ``_${PN}`` appended. For example, the build system turns the license | 10876 | ``_${PN}`` appended. For example, the build system turns the license |
10876 | flag "commercial_1.2_foo" into "commercial_1.2_foo_foo" and would match | 10877 | flag "commercial_1.2_foo" into "commercial_1.2_foo_foo" and would match |
10877 | both the general "commercial" and the specific "commercial_1.2_foo" | 10878 | both the general "commercial" and the specific "commercial_1.2_foo" |
10878 | strings found in the whitelist, as expected. | 10879 | strings found in the :term:`LICENSE_FLAGS_WHITELIST` variable, as expected. |
10879 | 10880 | ||
10880 | Here are some other scenarios: | 10881 | Here are some other scenarios: |
10881 | 10882 | ||
10882 | - You can specify a versioned string in the recipe such as | 10883 | - You can specify a versioned string in the recipe such as |
10883 | "commercial_foo_1.2" in a "foo" recipe. The build system expands this | 10884 | "commercial_foo_1.2" in a "foo" recipe. The build system expands this |
10884 | string to "commercial_foo_1.2_foo". Combine this license flag with a | 10885 | string to "commercial_foo_1.2_foo". Combine this license flag with a |
10885 | whitelist that has the string "commercial" and you match the flag | 10886 | :term:`LICENSE_FLAGS_WHITELIST` variable that has the string |
10886 | along with any other flag that starts with the string "commercial". | 10887 | "commercial" and you match the flag along with any other flag that |
10888 | starts with the string "commercial". | ||
10887 | 10889 | ||
10888 | - Under the same circumstances, you can use "commercial_foo" in the | 10890 | - Under the same circumstances, you can add "commercial_foo" in the |
10889 | whitelist and the build system not only matches "commercial_foo_1.2" | 10891 | :term:`LICENSE_FLAGS_WHITELIST` variable and the build system not only |
10890 | but also matches any license flag with the string "commercial_foo", | 10892 | matches "commercial_foo_1.2" but also matches any license flag with |
10891 | regardless of the version. | 10893 | the string "commercial_foo", regardless of the version. |
10892 | 10894 | ||
10893 | - You can be very specific and use both the package and version parts | 10895 | - You can be very specific and use both the package and version parts |
10894 | in the whitelist (e.g. "commercial_foo_1.2") to specifically match a | 10896 | in the :term:`LICENSE_FLAGS_WHITELIST` list (e.g. |
10895 | versioned recipe. | 10897 | "commercial_foo_1.2") to specifically match a versioned recipe. |
10896 | 10898 | ||
10897 | Other Variables Related to Commercial Licenses | 10899 | Other Variables Related to Commercial Licenses |
10898 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 10900 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
@@ -10916,9 +10918,10 @@ file:: | |||
10916 | LICENSE_FLAGS_WHITELIST = "commercial_gst-plugins-ugly commercial_gst-plugins-bad commercial_qmmp" | 10918 | LICENSE_FLAGS_WHITELIST = "commercial_gst-plugins-ugly commercial_gst-plugins-bad commercial_qmmp" |
10917 | 10919 | ||
10918 | 10920 | ||
10919 | Of course, you could also create a matching whitelist for those | 10921 | Of course, you could also create a matching list for those |
10920 | components using the more general "commercial" in the whitelist, but | 10922 | components using the more general "commercial" in the |
10921 | that would also enable all the other packages with :term:`LICENSE_FLAGS` | 10923 | :term:`LICENSE_FLAGS_WHITELIST` variable, but that would also enable all |
10924 | the other packages with :term:`LICENSE_FLAGS` | ||
10922 | containing "commercial", which you may or may not want:: | 10925 | containing "commercial", which you may or may not want:: |
10923 | 10926 | ||
10924 | LICENSE_FLAGS_WHITELIST = "commercial" | 10927 | LICENSE_FLAGS_WHITELIST = "commercial" |