summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/migration.xml193
-rw-r--r--documentation/ref-manual/ref-variables.xml50
2 files changed, 138 insertions, 105 deletions
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml
index 9915c3ce02..4c7af582fa 100644
--- a/documentation/ref-manual/migration.xml
+++ b/documentation/ref-manual/migration.xml
@@ -599,7 +599,7 @@
599 <listitem><para>Python 2.7.3+</para></listitem> 599 <listitem><para>Python 2.7.3+</para></listitem>
600 <listitem><para>Tar 1.24+</para></listitem> 600 <listitem><para>Tar 1.24+</para></listitem>
601 <listitem><para>Git 1.7.5+</para></listitem> 601 <listitem><para>Git 1.7.5+</para></listitem>
602 <listitem><para>Patched version of Make if you are using 602 <listitem><para>Patched version of Make if you are using
603 3.82. 603 3.82.
604 Most distributions that provide Make 3.82 use the patched 604 Most distributions that provide Make 3.82 use the patched
605 version.</para></listitem> 605 version.</para></listitem>
@@ -633,15 +633,46 @@
633 </para> 633 </para>
634 </section> 634 </section>
635 635
636 <section id='migration-1.5-remove-operator'> 636 <section id='migration-1.5-bitbake'>
637 <title>BitBake <filename>_remove</filename> Operator</title> 637 <title>BitBake</title>
638 638
639 <para> 639 <para>
640 BitBake now supports a <filename>_remove</filename> operator. 640 The following changes have been made that relate to BitBake:
641 The addition of this operator means you will have to rename any 641 <itemizedlist>
642 items in recipe space (functions, variables) whose names currently 642 <listitem><para>
643 contain <filename>_remove_</filename> or end with 643 BitBake now supports a <filename>_remove</filename>
644 <filename>_remove</filename> to avoid unexpected behavior. 644 operator.
645 The addition of this operator means you will have to
646 rename any items in recipe space (functions, variables)
647 whose names currently contain
648 <filename>_remove_</filename> or end with
649 <filename>_remove</filename> to avoid unexpected behavior.
650 </para></listitem>
651 <listitem><para>
652 BitBake's global method pool has been removed.
653 This method not particularly useful and led to clashes
654 between recipes containing functions that had the
655 same name.</para></listitem>
656 <listitem><para>
657 The "none" server backend has been removed.
658 The "process" server backend has been serving well as the
659 default for a long time now.</para></listitem>
660 <listitem><para>
661 The <filename>bitbake-runtask</filename> script has been
662 removed.</para></listitem>
663 <listitem><para>
664 <filename>${</filename><link linkend='var-P'><filename>P</filename></link><filename>}</filename>
665 and
666 <filename>${</filename><link linkend='var-PF'><filename>PF</filename></link><filename>}</filename>
667 are no longer added to
668 <link linkend='var-PROVIDES'><filename>PROVIDES</filename></link>
669 by default.
670 These version-specific <filename>PROVIDES</filename>
671 items were seldom used.
672 Attempting to use them could result in two versions being
673 built simultaneously rather than just one version due to
674 the way BitBake resolves dependencies.</para></listitem>
675 </itemizedlist>
645 </para> 676 </para>
646 </section> 677 </section>
647 678
@@ -684,7 +715,7 @@
684 other variables depending on how you wish it to be handled. 715 other variables depending on how you wish it to be handled.
685 See the documented QA checks in the 716 See the documented QA checks in the
686 "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>" 717 "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>"
687 section. 718 section.
688 </para></listitem> 719 </para></listitem>
689 </itemizedlist> 720 </itemizedlist>
690 </para> 721 </para>
@@ -733,9 +764,9 @@
733 The <filename>pkgdata</filename> directory produced as 764 The <filename>pkgdata</filename> directory produced as
734 part of the packaging process has been collapsed into a 765 part of the packaging process has been collapsed into a
735 single machine-specific directory. 766 single machine-specific directory.
736 These directories are located under 767 This directory is located under
737 <filename>sysroots</filename> and use a machine-specific 768 <filename>sysroots</filename> and uses a machine-specific
738 name (i.e. 769 name (i.e.
739 <filename>tmp/sysroots/&lt;machine&gt;/pkgdata</filename>). 770 <filename>tmp/sysroots/&lt;machine&gt;/pkgdata</filename>).
740 </para></listitem> 771 </para></listitem>
741 </itemizedlist> 772 </itemizedlist>
@@ -753,10 +784,8 @@
753 This change should be safe within contexts where these revisions 784 This change should be safe within contexts where these revisions
754 are used because the chances of spatially close collisions 785 are used because the chances of spatially close collisions
755 is very low. 786 is very low.
756 <note> 787 Distant collisions are not a major issue in the way
757 Distant collisions are not a major issue in the way 788 the values are used.
758 the values are used.
759 </note>
760 </para> 789 </para>
761 </section> 790 </section>
762 791
@@ -764,9 +793,8 @@
764 <title><filename>IMAGE_FEATURES</filename></title> 793 <title><filename>IMAGE_FEATURES</filename></title>
765 794
766 <para> 795 <para>
767 These 796 The following changes have been made that relate to
768 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> 797 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>:
769 exist:
770 <itemizedlist> 798 <itemizedlist>
771 <listitem><para> 799 <listitem><para>
772 The value of 800 The value of
@@ -783,10 +811,11 @@
783 <link linkend='var-PACKAGE_GROUP'><filename>PACKAGE_GROUP</filename></link> 811 <link linkend='var-PACKAGE_GROUP'><filename>PACKAGE_GROUP</filename></link>
784 definitions, 812 definitions,
785 <link linkend='var-COMPLEMENTARY_GLOB'><filename>COMPLEMENTARY_GLOB</filename></link> 813 <link linkend='var-COMPLEMENTARY_GLOB'><filename>COMPLEMENTARY_GLOB</filename></link>
786 and a new 'validitems' varflag on 814 and a new "validitems" varflag on
787 <filename>IMAGE_FEATURES</filename>. 815 <filename>IMAGE_FEATURES</filename>.
788 This change allows additional features to be added if they 816 The "validitems" varflag change allows additional features
789 are not provided using the previous two mechanisms. 817 to be added if they are not provided using the previous
818 two mechanisms.
790 </para></listitem> 819 </para></listitem>
791 <listitem><para> 820 <listitem><para>
792 The previously deprecated "apps-console-core" 821 The previously deprecated "apps-console-core"
@@ -824,9 +853,9 @@
824 This addition is now handled automatically when "package-management" 853 This addition is now handled automatically when "package-management"
825 is not in 854 is not in
826 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>. 855 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>.
827 If you have custom image recipes that makes this addition, 856 If you have custom image recipes that make this addition,
828 you should remove the lines, as it is not needed and may interfere 857 you should remove the lines, as they are not needed and might
829 with correct operation of postinstall scripts. 858 interfere with correct operation of postinstall scripts.
830 </para> 859 </para>
831 </section> 860 </section>
832 861
@@ -849,8 +878,8 @@
849 <para> 878 <para>
850 The previously deprecated <filename>task.bbclass</filename> has 879 The previously deprecated <filename>task.bbclass</filename> has
851 now been dropped. 880 now been dropped.
852 You should remove recipes that previously inherited from this task 881 For recipes that previously inherited from this task, you should
853 and rename from <filename>task-*</filename> to 882 rename them from <filename>task-*</filename> to
854 <filename>packagegroup-*</filename> and inherit packagegroup 883 <filename>packagegroup-*</filename> and inherit packagegroup
855 instead. 884 instead.
856 </para> 885 </para>
@@ -930,52 +959,83 @@
930 </para></listitem> 959 </para></listitem>
931 <listitem><para> 960 <listitem><para>
932 <filename>anjuta-remote-run</filename> has been removed. 961 <filename>anjuta-remote-run</filename> has been removed.
933 Support for Anjuta IDE integration has not existed for some 962 Anjuta IDE integration has not been officially supported for
934 several releases.</para></listitem> 963 several releases.</para></listitem>
935 </itemizedlist> 964 </itemizedlist>
936 </section> 965 </section>
937 966
938 <section id='migration-1.5-other-changes'> 967 <section id='migration-1.5-build-history'>
939 <title>Other Changes</title> 968 <title>Build History</title>
940 969
941 <para> 970 <para>
942 Following is a list of short entries describing other changes: 971 Following are changes to Build History:
943 <itemizedlist> 972 <itemizedlist>
944 <listitem><para> 973 <listitem><para>
945 BitBake: <filename>methodpool</filename>: Retire this. 974 Installed package sizes:
946 Remove global method scope.</para></listitem> 975 <filename>installed-package-sizes.txt</filename> for an
947 <listitem><para> 976 image now records the size of the files installed by each
948 BitBake: server: Remove none server.</para></listitem> 977 package instead of the size of each compressed package
978 archive file.</para></listitem>
949 <listitem><para> 979 <listitem><para>
950 BitBake: Drop <filename>bitbake-runtask</filename>. 980 The dependency graphs (<filename>depends*.dot</filename>)
981 now use the actual package names instead of replacing
982 dashes, dots and plus signs with underscores.
951 </para></listitem> 983 </para></listitem>
952 <listitem><para> 984 <listitem><para>
953 Do not recommend <filename>udev-extraconf</filename> 985 The <filename>buildhistory-diff</filename> and
954 for <filename>udev</filename>.</para></listitem> 986 <filename>buildhistory-collect-srcrevs</filename>
955 <listitem><para> 987 utilities have improved command-line handling.
956 <filename>udev</filename>: Do not recommend 988 Use the <filename>&dash;&dash;help</filename> option for
957 <filename>pciutils/usbutils ids</filename> 989 each utility for more information on the new syntax.
958 </para></listitem> 990 </para></listitem>
991 </itemizedlist>
992 For more information on Build History, see the
993 "<link linkend='maintaining-build-output-quality'>Maintaining Build Output Quality</link>"
994 section.
995 </para>
996 </section>
997
998 <section id='migration-1.5-udev'>
999 <title><filename>udev</filename></title>
1000
1001 <para>
1002 Following are changes to <filename>udev</filename>:
1003 <itemizedlist>
959 <listitem><para> 1004 <listitem><para>
960 <filename>run-postinsts</filename>: Make this generic. 1005 <filename>udev</filename> no longer brings in
1006 <filename>udev-extraconf</filename> automatically
1007 through
1008 <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>,
1009 since this was originally intended to be optional.
1010 If you need the extra rules, then add
1011 <filename>udev-extraconf</filename> to your image.
961 </para></listitem> 1012 </para></listitem>
962 <listitem><para> 1013 <listitem><para>
963 <filename>classes/externalsrc</filename>: Enable global 1014 <filename>udev</filename> no longer brings in
964 inherit and simplify usage.</para></listitem> 1015 <filename>pciutils-ids</filename> or
1016 <filename>usbutils-ids</filename> through
1017 <filename>RRECOMMENDS</filename>.
1018 These are not needed by <filename>udev</filename> itself
1019 and removing them saves around 350KB.
1020 </para></listitem>
1021 </itemizedlist>
1022 </para>
1023 </section>
1024
1025 <section id='migration-1.5-other-changes'>
1026 <title>Other Changes</title>
1027
1028 <para>
1029 Following is a list of short entries describing other changes:
1030 <itemizedlist>
965 <listitem><para> 1031 <listitem><para>
966 BusyBox: Enable to list suid and non-suid app configs. 1032 <filename>run-postinsts</filename>: Make this generic.
967 </para></listitem> 1033 </para></listitem>
968 <listitem><para> 1034 <listitem><para>
969 <filename>base-files</filename>: Remove the unnecessary 1035 <filename>base-files</filename>: Remove the unnecessary
970 <filename>/media/xxx</filename> directories. 1036 <filename>/media/xxx</filename> directories.
971 </para></listitem> 1037 </para></listitem>
972 <listitem><para> 1038 <listitem><para>
973 <filename>classes/testimage.bbclass</filename>: New class
974 for image tests.
975 See the
976 "<link linkend='ref-classes-testimage'><filename>testimage.bbclass</filename></link>"
977 section for more information.</para></listitem>
978 <listitem><para>
979 <filename>alsa-state</filename>: Provide an empty 1039 <filename>alsa-state</filename>: Provide an empty
980 <filename>asound.conf</filename> by default. 1040 <filename>asound.conf</filename> by default.
981 </para></listitem> 1041 </para></listitem>
@@ -990,7 +1050,8 @@
990 <listitem><para> 1050 <listitem><para>
991 <filename>systemd</filename>: Remove 1051 <filename>systemd</filename>: Remove
992 <filename>systemd_unitdir</filename> if 1052 <filename>systemd_unitdir</filename> if
993 <filename>systemd</filename> is not in distro features. 1053 <filename>systemd</filename> is not in
1054 <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>.
994 </para></listitem> 1055 </para></listitem>
995 <listitem><para> 1056 <listitem><para>
996 <filename>systemd</filename>: Remove 1057 <filename>systemd</filename>: Remove
@@ -1003,10 +1064,6 @@
1003 <filename>OTHER</filename> entries. 1064 <filename>OTHER</filename> entries.
1004 </para></listitem> 1065 </para></listitem>
1005 <listitem><para> 1066 <listitem><para>
1006 Add <filename>libav</filename> and use it in
1007 <filename>gst-ffmpeg</filename> by default.
1008 </para></listitem>
1009 <listitem><para>
1010 <filename>image.bbclass</filename>: Move 1067 <filename>image.bbclass</filename>: Move
1011 <filename>runtime_mapping_rename</filename> to avoid 1068 <filename>runtime_mapping_rename</filename> to avoid
1012 conflict with <filename>multilib</filename>. 1069 conflict with <filename>multilib</filename>.
@@ -1019,33 +1076,9 @@
1019 to generate the <filename>dtb</filename> files. 1076 to generate the <filename>dtb</filename> files.
1020 </para></listitem> 1077 </para></listitem>
1021 <listitem><para> 1078 <listitem><para>
1022 <filename>classes/buildhistory</filename>: Record the
1023 size of the installed package not the compressed archive.
1024 </para></listitem>
1025 <listitem><para>
1026 <filename>classes/buildhistory</filename>: Avoid mangling
1027 names in dot graphs for images.
1028 </para></listitem>
1029 <listitem><para>
1030 <filename>buildhistory-diff/buildhistory-collect-srcrevs</filename>:
1031 Improved command-line handling.
1032 </para></listitem>
1033 <listitem><para>
1034 <filename>kern-tools</filename>: Switch from guilt to 1079 <filename>kern-tools</filename>: Switch from guilt to
1035 new <filename>kgit-s2q</filename> tool. 1080 new <filename>kgit-s2q</filename> tool.
1036 </para></listitem> 1081 </para></listitem>
1037 <listitem><para>
1038 <filename>poky.conf</filename>: Do not force the addition
1039 of extra
1040 <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>.
1041 </para></listitem>
1042 <listitem><para>
1043 <filename>bitbake.conf</filename>: Stop providing
1044 <filename>${</filename><link linkend='var-P'><filename>P</filename></link><filename>}</filename>
1045 and
1046 <filename>${</filename><link linkend='var-PF'><filename>PF</filename></link><filename>}</filename>
1047 by default.
1048 </para></listitem>
1049 </itemizedlist> 1082 </itemizedlist>
1050 </para> 1083 </para>
1051 </section> 1084 </section>
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index cf964c78a7..8133b9d14b 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -822,15 +822,15 @@ Core layer for images cannot be removed
822 <glossentry id='var-BUSYBOX_SPLIT_SUID'><glossterm>BUSYBOX_SPLIT_SUID</glossterm> 822 <glossentry id='var-BUSYBOX_SPLIT_SUID'><glossterm>BUSYBOX_SPLIT_SUID</glossterm>
823 <glossdef> 823 <glossdef>
824 <para> 824 <para>
825 For the BusyBox recipe, specifies whether to split the 825 For the BusyBox recipe, specifies whether to split the
826 output executable file into two parts: one for features 826 output executable file into two parts: one for features
827 that require <filename>setuid root</filename>, and one for 827 that require <filename>setuid root</filename>, and one for
828 the remaining features (i.e. those that do not require 828 the remaining features (i.e. those that do not require
829 <filename>setuid root</filename>). 829 <filename>setuid root</filename>).
830 </para> 830 </para>
831 831
832 <para> 832 <para>
833 The <filename>BUSYBOX_SPLIT_SUID</filename> variable 833 The <filename>BUSYBOX_SPLIT_SUID</filename> variable
834 defaults to "1", which results in a single output 834 defaults to "1", which results in a single output
835 executable file. 835 executable file.
836 Set the variable to "0" to split the output file. 836 Set the variable to "0" to split the output file.
@@ -907,21 +907,21 @@ Core layer for images cannot be removed
907 <glossentry id='var-COMPLEMENTARY_GLOB'><glossterm>COMPLEMENTARY_GLOB</glossterm> 907 <glossentry id='var-COMPLEMENTARY_GLOB'><glossterm>COMPLEMENTARY_GLOB</glossterm>
908 <glossdef> 908 <glossdef>
909 <para> 909 <para>
910 Defines wildcards you can use when installing a list of 910 Defines wildcards to match when installing a list of
911 complementary packages for all the packages explicitly 911 complementary packages for all the packages explicitly
912 (or implicitly) installed in an image. 912 (or implicitly) installed in an image.
913 The resulting list of complementary packages is associated 913 The resulting list of complementary packages is associated
914 with an item that can be added to 914 with an item that can be added to
915 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>. 915 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>.
916 An example usage of this is the "dev-pkgs" item that when 916 An example usage of this is the "dev-pkgs" item that when
917 added to <filename>IMAGE_FEATURES</filename> will 917 added to <filename>IMAGE_FEATURES</filename> will
918 install -dev packages (containing headers and other 918 install -dev packages (containing headers and other
919 development files) for every package in the image. 919 development files) for every package in the image.
920 </para> 920 </para>
921 921
922 <para> 922 <para>
923 To add a new feature item pointing to a wildcard, use a 923 To add a new feature item pointing to a wildcard, use a
924 variable flag to specify the feature item name and 924 variable flag to specify the feature item name and
925 use the value to specify the wildcard. 925 use the value to specify the wildcard.
926 Here is an example: 926 Here is an example:
927 <literallayout class='monospaced'> 927 <literallayout class='monospaced'>
@@ -1911,8 +1911,8 @@ Core layer for images cannot be removed
1911 <glossentry id='var-IMAGE_BASENAME'><glossterm>IMAGE_BASENAME</glossterm> 1911 <glossentry id='var-IMAGE_BASENAME'><glossterm>IMAGE_BASENAME</glossterm>
1912 <glossdef> 1912 <glossdef>
1913 <para> 1913 <para>
1914 The base name of image output files. 1914 The base name of image output files.
1915 This variable defaults to the recipe name 1915 This variable defaults to the recipe name
1916 (<filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>). 1916 (<filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>).
1917 </para> 1917 </para>
1918 </glossdef> 1918 </glossdef>
@@ -3705,8 +3705,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3705 <glossentry id='var-PACKAGE_GROUP'><glossterm>PACKAGE_GROUP</glossterm> 3705 <glossentry id='var-PACKAGE_GROUP'><glossterm>PACKAGE_GROUP</glossterm>
3706 <glossdef> 3706 <glossdef>
3707 <para> 3707 <para>
3708 Defines one or more packages to include in an image when 3708 Defines one or more packages to include in an image when
3709 a specific item is included in 3709 a specific item is included in
3710 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>. 3710 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>.
3711 When setting the value, <filename>PACKAGE_GROUP</filename> 3711 When setting the value, <filename>PACKAGE_GROUP</filename>
3712 should have the name of the feature item as an override. 3712 should have the name of the feature item as an override.
@@ -3714,15 +3714,15 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3714 <literallayout class='monospaced'> 3714 <literallayout class='monospaced'>
3715 PACKAGE_GROUP_widget = "package1 package2" 3715 PACKAGE_GROUP_widget = "package1 package2"
3716 </literallayout> 3716 </literallayout>
3717 In this example, if "widget" were added to 3717 In this example, if "widget" were added to
3718 <filename>IMAGE_FEATURES</filename>, "package1" and 3718 <filename>IMAGE_FEATURES</filename>, "package1" and
3719 "package2" would be included in the image. 3719 "package2" would be included in the image.
3720 <note> 3720 <note>
3721 Packages installed by features defined through 3721 Packages installed by features defined through
3722 <filename>PACKAGE_GROUP</filename> are often package 3722 <filename>PACKAGE_GROUP</filename> are often package
3723 groups. 3723 groups.
3724 While similarly named, you should not confuse the 3724 While similarly named, you should not confuse the
3725 <filename>PACKAGE_GROUP</filename> variable with 3725 <filename>PACKAGE_GROUP</filename> variable with
3726 package groups, which are discussed elsewhere in the 3726 package groups, which are discussed elsewhere in the
3727 documentation. 3727 documentation.
3728 </note> 3728 </note>
@@ -4680,7 +4680,7 @@ PARALLEL_MAKEINST with the description ".
4680 <glossentry id='var-SDK_ARCH'><glossterm>SDK_ARCH</glossterm> 4680 <glossentry id='var-SDK_ARCH'><glossterm>SDK_ARCH</glossterm>
4681 <glossdef> 4681 <glossdef>
4682 <para> 4682 <para>
4683 The target architecture for the SDK. 4683 The target architecture for the SDK.
4684 Typically, you do not directly set this variable. 4684 Typically, you do not directly set this variable.
4685 Instead, use 4685 Instead, use
4686 <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>. 4686 <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>.
@@ -5623,8 +5623,8 @@ PARALLEL_MAKEINST with the description ".
5623 <glossentry id='var-TUNE_PKGARCH'><glossterm>TUNE_PKGARCH</glossterm> 5623 <glossentry id='var-TUNE_PKGARCH'><glossterm>TUNE_PKGARCH</glossterm>
5624 <glossdef> 5624 <glossdef>
5625 <para> 5625 <para>
5626 The package architecture understood by the packaging 5626 The package architecture understood by the packaging
5627 system to define the architecture, ABI, and tuning of 5627 system to define the architecture, ABI, and tuning of
5628 output packages. 5628 output packages.
5629 </para> 5629 </para>
5630 </glossdef> 5630 </glossdef>