summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-09-27 13:58:02 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-10-01 22:52:54 +0100
commit0d194a8c621006d3846f9fe3a756ce71a15f733a (patch)
tree78e61cfb3f2ca12eab4350d9413349ba8399203b
parentdf2e70a3afa97dd237f9a68b73f964522811a21e (diff)
downloadpoky-0d194a8c621006d3846f9fe3a756ce71a15f733a.tar.gz
dev-manual, ref-manual: Review edits for new variables.
Applied review changes to the following variables: IMAGE_NAME DATETIME SDK_ARCH IMAGE_BASENAME TUNE_PKGARCH PACKAGE_GROUP COMPLEMENTARY_GLOB BUSYBOX_SPLIT_SUID Also, reformatted some 1.5 package version requirements into a list rather than a lazy literallayout tag. Provided some new wording for the "Directory Layout Changes" section in the Migration chapter. (From yocto-docs rev: 60c3a905dd9212f1b4f6969341640a0726342d11) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml180
-rw-r--r--documentation/ref-manual/migration.xml28
-rw-r--r--documentation/ref-manual/ref-variables.xml81
3 files changed, 190 insertions, 99 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index bc78a08adc..fe34e8ecd8 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -3609,10 +3609,9 @@
3609 <title>Setting Up Runtime Package Management</title> 3609 <title>Setting Up Runtime Package Management</title>
3610 3610
3611 <para> 3611 <para>
3612 For RPM, IPK, and DEB package formats, it is possible to set 3612 For supported package formats, it is possible to set
3613 up a repository that is a host-based 3613 up a repository that is a host-based package feed from which
3614 package feed from which you can install packages on the 3614 you can install packages on the target system during runtime.
3615 target system during runtime.
3616 Doing so is optional and depends on the following: 3615 Doing so is optional and depends on the following:
3617 <itemizedlist> 3616 <itemizedlist>
3618 <listitem><para> 3617 <listitem><para>
@@ -3637,23 +3636,30 @@
3637 </itemizedlist> 3636 </itemizedlist>
3638 </para> 3637 </para>
3639 3638
3640 <section id='runtime-package-management-deb-rpm'> 3639 <para>
3641 <title>Using DEB and RPM</title> 3640 The following list provides steps for setting up the optional
3642 3641 repository regardless of the package format.
3643 <para> 3642 Once you work through these generic steps, see the
3644 Following are the steps to set up the optional repository. 3643 "<link linkend='runtime-package-management-deb-rpm'>Using RPM</link>"
3645 This example assumes you are using RPM and the Apache 2 3644 section or the
3646 server: 3645 "<link linkend='runtime-package-management-ipk'>Using IPK</link>"
3647 <orderedlist> 3646 section for remaining steps specific to the package type.
3648 <listitem><para> 3647 <note>
3649 Add the directory to your Apache configuration, which 3648 The example assumes you are using the Apache 2 server:
3650 you can find at 3649 </note>
3651 <filename>/etc/httpd/conf/httpd.conf</filename>. 3650 <orderedlist>
3652 Use commands similar to these on the development system. 3651 <listitem><para>
3653 These example commands assume a top-level 3652 Add the directory to your Apache configuration, which
3654 <link linkend='source-directory'>Source Directory</link> 3653 you can find at
3655 named <filename>poky</filename> in your home directory: 3654 <filename>/etc/httpd/conf/httpd.conf</filename>.
3656 <literallayout class='monospaced'> 3655 Use commands similar to these on the development system.
3656 These example commands assume a top-level
3657 <link linkend='source-directory'>Source Directory</link>
3658 named <filename>poky</filename> in your home directory.
3659 The example also assumes an RPM package type.
3660 If you are using a different package type, such as
3661 IPK, use "ipk" in the pathnames:
3662 <literallayout class='monospaced'>
3657 &lt;VirtualHost *:80&gt; 3663 &lt;VirtualHost *:80&gt;
3658 .... 3664 ....
3659 Alias /rpm ~/poky/build/tmp/deploy/rpm 3665 Alias /rpm ~/poky/build/tmp/deploy/rpm
@@ -3661,53 +3667,62 @@
3661 Options +Indexes 3667 Options +Indexes
3662 &lt;/Directory&gt; 3668 &lt;/Directory&gt;
3663 &lt;/VirtualHost&gt; 3669 &lt;/VirtualHost&gt;
3664 </literallayout> 3670 </literallayout>
3665 </para></listitem> 3671 </para></listitem>
3666 <listitem><para> 3672 <listitem><para>
3667 Reload the Apache configuration as follows. 3673 Reload the Apache configuration as follows.
3668 For all commands, be sure you have root privileges. 3674 For all commands, be sure you have root privileges.
3669 </para> 3675 </para>
3670 <para> 3676 <para>
3671 If your development system is using Fedora or 3677 If your development system is using Fedora or
3672 CentOS, use the following: 3678 CentOS, use the following:
3673 <literallayout class='monospaced'> 3679 <literallayout class='monospaced'>
3674 service httpd reload 3680 service httpd reload
3675 </literallayout> 3681 </literallayout>
3676 For Ubuntu and Debian, use the following: 3682 For Ubuntu and Debian, use the following:
3677 <literallayout class='monospaced'> 3683 <literallayout class='monospaced'>
3678 /etc/init.d/apache2 reload 3684 /etc/init.d/apache2 reload
3679 </literallayout> 3685 </literallayout>
3680 For OpenSUSE, use the following: 3686 For OpenSUSE, use the following:
3681 <literallayout class='monospaced'> 3687 <literallayout class='monospaced'>
3682 /etc/init.d/apache2 reload 3688 /etc/init.d/apache2 reload
3683 </literallayout> 3689 </literallayout>
3684 </para></listitem> 3690 </para></listitem>
3685 <listitem><para> 3691 <listitem><para>
3686 Run BitBake on <filename>package-index</filename> 3692 Re-generate the package index:
3687 on the host 3693 <literallayout class='monospaced'>
3688 <literallayout class='monospaced'>
3689 bitbake package-index 3694 bitbake package-index
3690 </literallayout> 3695 </literallayout>
3691 </para></listitem> 3696 </para></listitem>
3692 <listitem><para> 3697 <listitem><para>
3693 Change your working directory to 3698 If you are using Security-Enhanced Linux (SELinux),
3694 <filename>tmp/deploy/rpm</filename> in the 3699 you need to label the files as being accessible
3695 <link linkend='build-directory'>Build Directory</link>. 3700 through Apache.
3696 </para></listitem> 3701 Use the following command from the development host.
3697 <listitem><para> 3702 Again, the example assumes RPM package types:
3698 If you are using Security-Enhanced Linux (SELinux), 3703 <literallayout class='monospaced'>
3699 you need to label the files as being accessible 3704 chcon -R -h -t httpd_sys_content_t tmp/deploy/rpm
3700 through Apache. 3705 </literallayout>
3701 Use the following command from the development host: 3706 </para></listitem>
3702 <literallayout class='monospaced'> 3707 </orderedlist>
3703 chcon -R -h -t httpd_sys_content_t . 3708 </para>
3704 </literallayout> 3709
3705 </para></listitem> 3710 <section id='runtime-package-management-deb-rpm'>
3711 <title>Using RPM</title>
3712
3713 <para>
3714 Following are RPM-specific steps needed for setting up the
3715 optional repository.
3716 Perform these steps after working through the common steps
3717 at the start of this section:
3718 <orderedlist>
3706 <listitem><para> 3719 <listitem><para>
3707 On the target machine, add the repository to Smart 3720 On the target machine, add the repository to Smart
3708 for every package architecture. 3721 for every package architecture.
3709 To see the list of package architectures, just list 3722 To see the list of package architectures, list
3710 the contents of the directory.</para> 3723 the contents of the
3724 setting-up-runtime-package-management <filename>tmp/deploy/rpm</filename> directory
3725 on the host.</para>
3711 <para> 3726 <para>
3712 As an example, suppose you list the contents of the 3727 As an example, suppose you list the contents of the
3713 directory and discover three architectures: 3728 directory and discover three architectures:
@@ -3715,7 +3730,7 @@
3715 and <filename>qemux86</filename>. 3730 and <filename>qemux86</filename>.
3716 Given this example, use the following commands: 3731 Given this example, use the following commands:
3717 <literallayout class='monospaced'> 3732 <literallayout class='monospaced'>
3718 smart channel &dash;&dash;add all type=rpm-md baseurl=http:server.name/rpm/all 3733 smart channel &dash;&dash;add all type=rpm-md baseurl=http://server.name/rpm/all
3719 smart channel &dash;&dash;add i585 type=rpm-md baseurl=http://server.name/rpm/i586 3734 smart channel &dash;&dash;add i585 type=rpm-md baseurl=http://server.name/rpm/i586
3720 smart channel &dash;&dash;add qemux86 type=rpm-md baseurl=http://server.name/rpm/qemux86 3735 smart channel &dash;&dash;add qemux86 type=rpm-md baseurl=http://server.name/rpm/qemux86
3721 </literallayout> 3736 </literallayout>
@@ -3728,6 +3743,9 @@
3728 </literallayout> 3743 </literallayout>
3729 </para></listitem> 3744 </para></listitem>
3730 </orderedlist> 3745 </orderedlist>
3746 You can now use the <filename>smart query</filename>
3747 and <filename>smart install</filename> commands to find
3748 and install packages from the repositories.
3731 </para> 3749 </para>
3732 </section> 3750 </section>
3733 3751
@@ -3735,18 +3753,32 @@
3735 <title>Using IPK</title> 3753 <title>Using IPK</title>
3736 3754
3737 <para> 3755 <para>
3738 If your packages are IPK, you can install packages onto an 3756 Following are IPK-specific steps needed for setting up the
3739 existing running system by first sharing the 3757 optional repository.
3740 <filename>tmp/deploy/ipk/</filename> directory 3758 Perform these steps after working through the common steps
3741 through a web server and then by changing 3759 at the start of this section:
3742 <filename>/etc/opkg/base-feeds.conf</filename> 3760 <orderedlist>
3743 to point at the shared server. 3761 <listitem><para>Install packages onto an
3744 Following is an example: 3762 existing running system by first sharing the
3745 <literallayout class='monospaced'> 3763 <filename>tmp/deploy/ipk/</filename> directory
3746 $ src/gz all http://www.mysite.com/somedir/deploy/ipk/all 3764 through a web server and then by changing
3747 $ src/gz armv7a http://www.mysite.com/somedir/deploy/ipk/armv7a 3765 <filename>/etc/opkg/base-feeds.conf</filename>
3748 $ src/gz beagleboard http://www.mysite.com/somedir/deploy/ipk/beagleboard 3766 to point at the shared server.
3749 </literallayout> 3767 Following is an example:
3768 <literallayout class='monospaced'>
3769 src/gz all http://www.mysite.com/somedir/deploy/ipk/all
3770 src/gz armv7a http://www.mysite.com/somedir/deploy/ipk/armv7a
3771 src/gz beagleboard http://www.mysite.com/somedir/deploy/ipk/beagleboard
3772 </literallayout></para></listitem>
3773 <listitem><para>From the target machine, fetch the
3774 repository information using this command:
3775 <literallayout class='monospaced'>
3776 opkg update
3777 </literallayout></para></listitem>
3778 </orderedlist>
3779 You can now use the <filename>opkg list</filename> and
3780 <filename>opkg install</filename> commands to find and
3781 install packages from the repositories.
3750 </para> 3782 </para>
3751 </section> 3783 </section>
3752 </section> 3784 </section>
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml
index 1b3b9d99dc..9915c3ce02 100644
--- a/documentation/ref-manual/migration.xml
+++ b/documentation/ref-manual/migration.xml
@@ -595,16 +595,15 @@
595 <para> 595 <para>
596 The OpenEmbedded build system now has some additional requirements 596 The OpenEmbedded build system now has some additional requirements
597 on the host system: 597 on the host system:
598 <literallayout class='monospaced'> 598 <itemizedlist>
599 Python 2.7.3+ 599 <listitem><para>Python 2.7.3+</para></listitem>
600 600 <listitem><para>Tar 1.24+</para></listitem>
601 tar 1.24+ 601 <listitem><para>Git 1.7.5+</para></listitem>
602 602 <listitem><para>Patched version of Make if you are using
603 git 1.7.5+ 603 3.82.
604 604 Most distributions that provide Make 3.82 use the patched
605 Patched version of make if you are using make version 3.82. Most 605 version.</para></listitem>
606 distributions that provide make 3.82 have now done this. 606 </itemizedlist>
607 </literallayout>
608 If the Linux distribution you are using on your build host 607 If the Linux distribution you are using on your build host
609 does not provide packages for these, you can install and use 608 does not provide packages for these, you can install and use
610 the Buildtools tarball, which provides an SDK-like environment 609 the Buildtools tarball, which provides an SDK-like environment
@@ -733,7 +732,12 @@
733 <listitem><para> 732 <listitem><para>
734 The <filename>pkgdata</filename> directory produced as 733 The <filename>pkgdata</filename> directory produced as
735 part of the packaging process has been collapsed into a 734 part of the packaging process has been collapsed into a
736 single machine-specific directory.</para></listitem> 735 single machine-specific directory.
736 These directories are located under
737 <filename>sysroots</filename> and use a machine-specific
738 name (i.e.
739 <filename>tmp/sysroots/&lt;machine&gt;/pkgdata</filename>).
740 </para></listitem>
737 </itemizedlist> 741 </itemizedlist>
738 </para> 742 </para>
739 </section> 743 </section>
@@ -778,7 +782,7 @@
778 Valid <filename>IMAGE_FEATURES</filename> are drawn from 782 Valid <filename>IMAGE_FEATURES</filename> are drawn from
779 <link linkend='var-PACKAGE_GROUP'><filename>PACKAGE_GROUP</filename></link> 783 <link linkend='var-PACKAGE_GROUP'><filename>PACKAGE_GROUP</filename></link>
780 definitions, 784 definitions,
781 <link linkend='var-COMPLEMENTARY_GLOBS'><filename>COMPLEMENTARY_GLOBS</filename></link> 785 <link linkend='var-COMPLEMENTARY_GLOB'><filename>COMPLEMENTARY_GLOB</filename></link>
782 and a new 'validitems' varflag on 786 and a new 'validitems' varflag on
783 <filename>IMAGE_FEATURES</filename>. 787 <filename>IMAGE_FEATURES</filename>.
784 This change allows additional features to be added if they 788 This change allows additional features to be added if they
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index c1e2013f42..cf964c78a7 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -822,7 +822,18 @@ 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 Need description. 825 For the BusyBox recipe, specifies whether to split the
826 output executable file into two parts: one for features
827 that require <filename>setuid root</filename>, and one for
828 the remaining features (i.e. those that do not require
829 <filename>setuid root</filename>).
830 </para>
831
832 <para>
833 The <filename>BUSYBOX_SPLIT_SUID</filename> variable
834 defaults to "1", which results in a single output
835 executable file.
836 Set the variable to "0" to split the output file.
826 </para> 837 </para>
827 </glossdef> 838 </glossdef>
828 </glossentry> 839 </glossentry>
@@ -893,10 +904,29 @@ Core layer for images cannot be removed
893 </glossdef> 904 </glossdef>
894 </glossentry> 905 </glossentry>
895 906
896 <glossentry id='var-COMPLEMENTARY_GLOBS'><glossterm>COMPLEMENTARY_GLOBS</glossterm> 907 <glossentry id='var-COMPLEMENTARY_GLOB'><glossterm>COMPLEMENTARY_GLOB</glossterm>
897 <glossdef> 908 <glossdef>
898 <para> 909 <para>
899 Need description. 910 Defines wildcards you can use when installing a list of
911 complementary packages for all the packages explicitly
912 (or implicitly) installed in an image.
913 The resulting list of complementary packages is associated
914 with an item that can be added to
915 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>.
916 An example usage of this is the "dev-pkgs" item that when
917 added to <filename>IMAGE_FEATURES</filename> will
918 install -dev packages (containing headers and other
919 development files) for every package in the image.
920 </para>
921
922 <para>
923 To add a new feature item pointing to a wildcard, use a
924 variable flag to specify the feature item name and
925 use the value to specify the wildcard.
926 Here is an example:
927 <literallayout class='monospaced'>
928 COMPLEMENTARY_GLOB[dev-pkgs] = '*-dev'
929 </literallayout>
900 </para> 930 </para>
901 </glossdef> 931 </glossdef>
902 </glossentry> 932 </glossentry>
@@ -1013,10 +1043,8 @@ Core layer for images cannot be removed
1013 <glossentry id='var-DATETIME'><glossterm>DATETIME</glossterm> 1043 <glossentry id='var-DATETIME'><glossterm>DATETIME</glossterm>
1014 <glossdef> 1044 <glossdef>
1015 <para> 1045 <para>
1016 The date and time on which the build started: 1046 The date and time on which the current build started.
1017 <literallayout class='monospaced'> 1047 The format is suitable for timestamps.
1018 date/time
1019 </literallayout>
1020 </para> 1048 </para>
1021 </glossdef> 1049 </glossdef>
1022 </glossentry> 1050 </glossentry>
@@ -1883,7 +1911,9 @@ Core layer for images cannot be removed
1883 <glossentry id='var-IMAGE_BASENAME'><glossterm>IMAGE_BASENAME</glossterm> 1911 <glossentry id='var-IMAGE_BASENAME'><glossterm>IMAGE_BASENAME</glossterm>
1884 <glossdef> 1912 <glossdef>
1885 <para> 1913 <para>
1886 Need description. 1914 The base name of image output files.
1915 This variable defaults to the recipe name
1916 (<filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>).
1887 </para> 1917 </para>
1888 </glossdef> 1918 </glossdef>
1889 </glossentry> 1919 </glossentry>
@@ -2032,8 +2062,8 @@ Core layer for images cannot be removed
2032 <para> 2062 <para>
2033 The name of the output image files minus the extension. 2063 The name of the output image files minus the extension.
2034 This variable is derived using the 2064 This variable is derived using the
2035 <link linkend='var-IMAGE_BASENAME'><filename>IMAGE_BASENAME</filename></link> 2065 <link linkend='var-IMAGE_BASENAME'><filename>IMAGE_BASENAME</filename></link>,
2036 <link linkend='var-MACHINE'><filename>MACHINE</filename></link> 2066 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>,
2037 and 2067 and
2038 <link linkend='var-DATETIME'><filename>DATETIME</filename></link> 2068 <link linkend='var-DATETIME'><filename>DATETIME</filename></link>
2039 variables: 2069 variables:
@@ -3675,7 +3705,27 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3675 <glossentry id='var-PACKAGE_GROUP'><glossterm>PACKAGE_GROUP</glossterm> 3705 <glossentry id='var-PACKAGE_GROUP'><glossterm>PACKAGE_GROUP</glossterm>
3676 <glossdef> 3706 <glossdef>
3677 <para> 3707 <para>
3678 Need description. 3708 Defines one or more packages to include in an image when
3709 a specific item is included in
3710 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>.
3711 When setting the value, <filename>PACKAGE_GROUP</filename>
3712 should have the name of the feature item as an override.
3713 Here is an example:
3714 <literallayout class='monospaced'>
3715 PACKAGE_GROUP_widget = "package1 package2"
3716 </literallayout>
3717 In this example, if "widget" were added to
3718 <filename>IMAGE_FEATURES</filename>, "package1" and
3719 "package2" would be included in the image.
3720 <note>
3721 Packages installed by features defined through
3722 <filename>PACKAGE_GROUP</filename> are often package
3723 groups.
3724 While similarly named, you should not confuse the
3725 <filename>PACKAGE_GROUP</filename> variable with
3726 package groups, which are discussed elsewhere in the
3727 documentation.
3728 </note>
3679 </para> 3729 </para>
3680 </glossdef> 3730 </glossdef>
3681 </glossentry> 3731 </glossentry>
@@ -4630,7 +4680,10 @@ PARALLEL_MAKEINST with the description ".
4630 <glossentry id='var-SDK_ARCH'><glossterm>SDK_ARCH</glossterm> 4680 <glossentry id='var-SDK_ARCH'><glossterm>SDK_ARCH</glossterm>
4631 <glossdef> 4681 <glossdef>
4632 <para> 4682 <para>
4633 Need description. 4683 The target architecture for the SDK.
4684 Typically, you do not directly set this variable.
4685 Instead, use
4686 <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>.
4634 </para> 4687 </para>
4635 </glossdef> 4688 </glossdef>
4636 </glossentry> 4689 </glossentry>
@@ -5570,7 +5623,9 @@ PARALLEL_MAKEINST with the description ".
5570 <glossentry id='var-TUNE_PKGARCH'><glossterm>TUNE_PKGARCH</glossterm> 5623 <glossentry id='var-TUNE_PKGARCH'><glossterm>TUNE_PKGARCH</glossterm>
5571 <glossdef> 5624 <glossdef>
5572 <para> 5625 <para>
5573 Need description. 5626 The package architecture understood by the packaging
5627 system to define the architecture, ABI, and tuning of
5628 output packages.
5574 </para> 5629 </para>
5575 </glossdef> 5630 </glossdef>
5576 </glossentry> 5631 </glossentry>