documentation: yocto-project-qs, yocto-project-ref - package re-org

Reorganization of the packages section in the YP Quick Start.
These are now ordered still by distro but the listed packages
have been culled down to just the needed ones to run an
image on QEMU with graphical support.

A corresponding section in the reference manual now provides
the comprehensive list of packages for all supported distros.
The section in the reference manual is broken down by
distro and by function.

Finally, four new variables were introduced to track the
essential packages for each of the distros.  The variables
are defined in poky.ent and follow the form
<distro>_HOST_PACKAGES_ESSENTIAL.  This will make it so
we don't have to maintain this list of essential packages
in multiple places.

Reported-by: Paul Eggleton <paul.eggleton@intel.com>
(From yocto-docs rev: 839b441791980db82f4795454e976e606b486d25)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

3 files changed, 215 insertions, 58 deletions

diff --git a/documentation/poky-ref-manual/introduction.xml b/documentation/poky-ref-manual/introduction.xml
index 71717e3d77..5f3fa962b9 100644
--- a/documentation/poky-ref-manual/introduction.xml
+++ b/documentation/poky-ref-manual/introduction.xml
@@ -87,10 +87,177 @@
 <section id='intro-requirements'>
 <title>System Requirements</title>
     <para>
-        For Yocto Project system requirements, see the
+        For general Yocto Project system requirements, see the
         <ulink url='&YOCTO_DOCS_QS_URL;#yp-resources'>
         What You Need and How You Get It</ulink> section in the Yocto Project Quick Start.
+        The remainder of this section provides details on system requirements
+        not covered in the Yocto Project Quick Start.
     </para>
+
+    <section id='detailed-supported-distros'>
+    <title>Supported Linux Distributions</title>
+
+        <para>
+            TBD - a list of very specific distros and versions. 
+            The list will be kept up-to-date via a script provided that can 
+            be run prior to a release. 
+            The scripts output will yield the list and it can be copied 
+            into this section.
+        </para>
+    </section>
+
+    <section id='required-packages-for-the-host-development-system'>
+    <title>Required Packages for the Host Development System</title>
+
+        <para>
+            The list of packages you need on the host development system can 
+            be large when covering all build scenarios using the Yocto Project. 
+            This section provides required packages by Linux distribution and 
+            further categorized by function.
+        </para>
+
+        <section id='ubuntu-packages'>
+            <title>Ubuntu</title>
+
+            <para>
+                The following list shows the required packages by function
+                given a supported Ubuntu Linux distribution:
+                <itemizedlist>
+                    <listitem><para><emphasis>Essentials:</emphasis>
+                        Packages needed to build an image for a headless 
+                        system:
+                        <literallayout class='monospaced'>
+     $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL;
+                        </literallayout></para></listitem>
+                    <listitem><para><emphasis>Graphical Extras:</emphasis>
+                        Packages needed if you are going to have graphics 
+                        support when you run the image:
+                        <literallayout class='monospaced'>
+     $ sudo apt-get install libsdl1.2-dev xterm
+                        </literallayout></para></listitem>
+                    <listitem><para><emphasis>Documentation:</emphasis>
+                        Packages needed if you are going to build out the 
+                        Yocto Project documentation manuals:
+                        <literallayout class='monospaced'>
+     $ sudo apt-get install make xsltproc docbook-utils fop
+                        </literallayout></para></listitem>
+                    <listitem><para><emphasis>Application Development Extras:</emphasis>
+                        Packages needed if you are going to be developing 
+                        user-space applications:
+                        <literallayout class='monospaced'>
+     $ sudo apt-get install autoconf automake libtool libglib2.0-dev
+                        </literallayout></para></listitem>
+                </itemizedlist>
+            </para>
+        </section>
+
+        <section id='fedora-packages'>
+            <title>Fedora Packages</title>
+
+            <para>
+                The following list shows the required packages by function
+                given a supported Fedora Linux distribution:
+                <itemizedlist>
+                    <listitem><para><emphasis>Essentials:</emphasis>
+                        Packages needed to build an image for a headless 
+                        system:
+                        <literallayout class='monospaced'>
+     $ sudo yum install &FEDORA_HOST_PACKAGES_ESSENTIAL;
+                        </literallayout></para></listitem>
+                    <listitem><para><emphasis>Graphical Extras:</emphasis>
+                        Packages needed if you are going to have graphics 
+                        support when you run the image:
+                        <literallayout class='monospaced'>
+     $ sudo yum install SDL-devel xterm
+                        </literallayout></para></listitem>
+                    <listitem><para><emphasis>Documentation:</emphasis>
+                        Packages needed if you are going to build out the 
+                        Yocto Project documentation manuals:
+                        <literallayout class='monospaced'>
+     $ sudo yum install make docbook-style-dsssl docbook-style-xsl \
+     docbook-dtds docbook-utils fop libxslt
+                        </literallayout></para></listitem>
+                    <listitem><para><emphasis>Application Development Extras:</emphasis>
+                        Packages needed if you are going to be developing 
+                        user-space applications:
+                        <literallayout class='monospaced'>
+     $ sudo yum install autoconf automake libtool glib2-devel
+                        </literallayout></para></listitem>
+                </itemizedlist>
+            </para>
+        </section>
+
+        <section id='opensuse-packages'>
+            <title>OpenSUSE Packages</title>
+
+            <para>
+                The following list shows the required packages by function
+                given a supported OpenSUSE Linux distribution:
+                <itemizedlist>
+                    <listitem><para><emphasis>Essentials:</emphasis>
+                        Packages needed to build an image for a headless 
+                        system:
+                        <literallayout class='monospaced'>
+     $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL;
+                        </literallayout></para></listitem>
+                    <listitem><para><emphasis>Graphical Extras:</emphasis>
+                        Packages needed if you are going to have graphics 
+                        support when you run the image:
+                        <literallayout class='monospaced'>
+     $ sudo zypper install libSDL-devel xterm
+                        </literallayout></para></listitem>
+                    <listitem><para><emphasis>Documentation:</emphasis>
+                        Packages needed if you are going to build out the 
+                        Yocto Project documentation manuals:
+                        <literallayout class='monospaced'>
+     $ sudo zypper install make fop xsltproc
+                        </literallayout></para></listitem>
+                    <listitem><para><emphasis>Application Development Extras:</emphasis>
+                        Packages needed if you are going to be developing 
+                        user-space applications:
+                        <literallayout class='monospaced'>
+     $ sudo zypper install autoconf automake libtool glib2-devel
+                        </literallayout></para></listitem>
+                </itemizedlist>
+            </para>
+        </section>
+
+        <section id='centos-packages'>
+            <title>CentOS Packages</title>
+
+            <para>
+                The following list shows the required packages by function
+                given a supported CentOS Linux distribution:
+                <itemizedlist>
+                    <listitem><para><emphasis>Essentials:</emphasis>
+                        Packages needed to build an image for a headless 
+                        system:
+                        <literallayout class='monospaced'>
+     $ sudo yum -y install &CENTOS_HOST_PACKAGES_ESSENTIAL;
+                        </literallayout></para></listitem>
+                    <listitem><para><emphasis>Graphical Extras:</emphasis>
+                        Packages needed if you are going to have graphics 
+                        support when you run the image:
+                        <literallayout class='monospaced'>
+     $ sudo yum -y install SDL-devel xterm
+                        </literallayout></para></listitem>
+                    <listitem><para><emphasis>Documentation:</emphasis>
+                        Packages needed if you are going to build out the 
+                        Yocto Project documentation manuals:
+                        <literallayout class='monospaced'>
+     $ sudo yum -y install make docbook-style-dsssl docbook-style-xsl \
+     docbook-dtds docbook-utils fop libxslt
+                        </literallayout></para></listitem>
+                    <listitem><para><emphasis>Application Development Extras:</emphasis>
+                        Packages needed if you are going to be developing 
+                        user-space applications:
+                        <literallayout class='monospaced'>
+     $ sudo yum -y install autoconf automake libtool glib2-devel
+                        </literallayout></para></listitem>
+                </itemizedlist>
+            </para>
+        </section>
+    </section>
 </section>
 
 <section id='intro-getit'>
diff --git a/documentation/poky.ent b/documentation/poky.ent
index 6eb9d9aacf..8e0af71fa2 100644
--- a/documentation/poky.ent
+++ b/documentation/poky.ent
@@ -48,3 +48,10 @@
 <!ENTITY YOCTO_POKY_TARBALL "&YOCTO_POKY;.tar.bz2">
 <!ENTITY OE_INIT_PATH "&YOCTO_POKY;/oe-init-build-env">
 <!ENTITY OE_INIT_FILE "oe-init-build-env">
+<!ENTITY UBUNTU_HOST_PACKAGES_ESSENTIAL "awk wget git-core diffstat unzip texinfo build-essential chrpath">
+<!ENTITY FEDORA_HOST_PACKAGES_ESSENTIAL "awk make wget tar bzip2 gzip python unzip perl patch diffutils diffstat git
+cpp gcc gcc-c++ eglibc-devel texinfo chrpath ccache">
+<!ENTITY OPENSUSE_HOST_PACKAGES_ESSENTIAL "python gcc gcc-c++ git chrpath make wget diffstat texinfo python-curses">
+<!ENTITY CENTOS_HOST_PACKAGES_ESSENTIAL "gawk make wget tar bzip2 gzip python unzip perl patch diffutils diffstat git
+cpp gcc gcc-c++ glibc-devel texinfo chrpath">
+
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml
index bfb5d4ee16..a025895843 100644
--- a/documentation/yocto-project-qs/yocto-project-qs.xml
+++ b/documentation/yocto-project-qs/yocto-project-qs.xml
@@ -211,94 +211,77 @@
         <title>The Packages</title>
 
         <para>
-            Packages and package installation vary depending on your development system.  
-            In general, you need to have root access and then install the required packages.
-            The next few sections show you how to get set up with the right packages for
-            Ubuntu, Fedora, openSUSE, and CentOS.
+            Packages and package installation vary depending on your development system
+            and on your intent. 
+            For example, if you want to build an image that can run
+            on QEMU in graphical mode (a minimal, basic build
+            requirement), then the number of packages is different than if you want to
+            build an image for a headless system or build out the Yocto Project
+            documentation set. 
+            Collectively, the number of required packages is large
+            if you want to be able to cover all cases.
+            <note>In general, you need to have root access and then install the 
+                required packages.</note>
         </para>
-  
+
+        <para>
+            The next few sections list, by supported Linux Distributions, the required
+            packages needed to build an image that runs on QEMU in graphical mode
+            (e.g. essential plus graphics support).
+        </para>
+
+        <para> 
+            For lists of required packages for other scenarios, see the 
+            "<ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>Required Packages for the Host Development System</ulink>" 
+            section in the Yocto Project Reference Manual.
+        </para>
+
         <section id='ubuntu'>
             <title>Ubuntu</title>
 
             <para>
-                The packages you need for a supported Ubuntu distribution are shown in the following command:
-            </para>
-
+                The essential packages you need for a supported Ubuntu distribution 
+                are shown in the following command:
                 <literallayout class='monospaced'>
-     $ sudo apt-get install sed wget subversion git-core coreutils \
-     unzip texi2html texinfo libsdl1.2-dev docbook-utils fop gawk \
-     python-pysqlite2 diffstat make gcc build-essential xsltproc \
-     g++ desktop-file-utils chrpath libgl1-mesa-dev libglu1-mesa-dev \
-     autoconf automake groff libtool xterm libxml-parser-perl dblatex
+     $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL; libsdl1.2-dev xterm
                 </literallayout>
+            </para>
         </section>
 
         <section id='fedora'>
             <title>Fedora</title>
 
             <para>
-                The packages you need for a supported Fedora distribution are shown in the following
-                commands:
-            </para>
-
+                The essential packages you need for a supported Fedora distribution 
+                are shown in the following commands:
                 <literallayout class='monospaced'>
-     $ sudo yum groupinstall "development tools"
-     $ sudo yum install python m4 make wget curl ftp tar bzip2 gzip \
-     unzip perl texinfo texi2html diffstat openjade \
-     docbook-style-dsssl sed docbook-style-xsl docbook-dtds fop libxslt \
-     docbook-utils sed bc eglibc-devel ccache pcre pcre-devel quilt \
-     groff linuxdoc-tools patch cmake \
-     perl-ExtUtils-MakeMaker tcl-devel gettext chrpath ncurses apr \
-     SDL-devel mesa-libGL-devel mesa-libGLU-devel gnome-doc-utils \
-     autoconf automake libtool xterm dblatex glib-gettextize
+     $ sudo yum install &FEDORA_HOST_PACKAGES_ESSENTIAL; SDL-devel xterm
                 </literallayout>
-
+            </para>
         </section>
 
         <section id='opensuse'>
             <title>openSUSE</title>
 
             <para>
-                The packages you need for a supported openSUSE distribution are shown in the following 
-                command:
-            </para>
-
+                The essential packages you need for a supported openSUSE 
+                distribution are shown in the following command:
                 <literallayout class='monospaced'>
-     $ sudo zypper install python gcc gcc-c++ libtool fop \
-     subversion git chrpath automake make wget xsltproc \
-     diffstat texinfo freeglut-devel libSDL-devel dblatex \
-     python-curses
+     $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; libSDL-devel xterm
                 </literallayout>
+            </para>
         </section>
 
         <section id='centos'>
             <title>CentOS</title>
 
             <para>
-                The packages you need for a supported CentOS distribution are shown in the following 
-                commands:
-            </para>
-
+                The essential packages you need for a supported CentOS 
+                distribution are shown in the following commands:
                 <literallayout class='monospaced'>
-     $ sudo yum -y groupinstall "development tools"
-     $ sudo yum -y install tetex gawk sqlite-devel vim-common redhat-lsb xz \
-       m4 make wget curl ftp tar bzip2 gzip python-devel \
-       unzip perl texinfo texi2html diffstat openjade zlib-devel \
-       docbook-style-dsssl sed docbook-style-xsl docbook-dtds \
-       docbook-utils bc glibc-devel pcre pcre-devel \
-       groff linuxdoc-tools patch cmake \
-       tcl-devel gettext ncurses apr \
-       SDL-devel mesa-libGL-devel mesa-libGLU-devel gnome-doc-utils \
-       autoconf automake libtool xterm dblatex
+     $ sudo yum -y install &CENTOS_HOST_PACKAGES_ESSENTIAL; SDL-devel xterm
                 </literallayout>
-            <note><para>
-                Depending on the CentOS version you are using, other requirements and dependencies
-                might exist. 
-                For details, you should look at the CentOS sections on the 
-                <ulink url='&YOCTO_WIKI_URL;/wiki/Poky/GettingStarted/Dependencies'>Poky/GettingStarted/Dependencies</ulink>
-                wiki page.
-            </para></note>
-
+            </para>
         </section>
     </section>