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 @@
System Requirements - For Yocto Project system requirements, see the + For general Yocto Project system requirements, see the What You Need and How You Get It 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. + +
+ Supported Linux Distributions + + + 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. + +
+ +
+ Required Packages for the Host Development System + + + 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. + + +
+ Ubuntu + + + The following list shows the required packages by function + given a supported Ubuntu Linux distribution: + + Essentials: + Packages needed to build an image for a headless + system: + + $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL; + + Graphical Extras: + Packages needed if you are going to have graphics + support when you run the image: + + $ sudo apt-get install libsdl1.2-dev xterm + + Documentation: + Packages needed if you are going to build out the + Yocto Project documentation manuals: + + $ sudo apt-get install make xsltproc docbook-utils fop + + Application Development Extras: + Packages needed if you are going to be developing + user-space applications: + + $ sudo apt-get install autoconf automake libtool libglib2.0-dev + + + +
+ +
+ Fedora Packages + + + The following list shows the required packages by function + given a supported Fedora Linux distribution: + + Essentials: + Packages needed to build an image for a headless + system: + + $ sudo yum install &FEDORA_HOST_PACKAGES_ESSENTIAL; + + Graphical Extras: + Packages needed if you are going to have graphics + support when you run the image: + + $ sudo yum install SDL-devel xterm + + Documentation: + Packages needed if you are going to build out the + Yocto Project documentation manuals: + + $ sudo yum install make docbook-style-dsssl docbook-style-xsl \ + docbook-dtds docbook-utils fop libxslt + + Application Development Extras: + Packages needed if you are going to be developing + user-space applications: + + $ sudo yum install autoconf automake libtool glib2-devel + + + +
+ +
+ OpenSUSE Packages + + + The following list shows the required packages by function + given a supported OpenSUSE Linux distribution: + + Essentials: + Packages needed to build an image for a headless + system: + + $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; + + Graphical Extras: + Packages needed if you are going to have graphics + support when you run the image: + + $ sudo zypper install libSDL-devel xterm + + Documentation: + Packages needed if you are going to build out the + Yocto Project documentation manuals: + + $ sudo zypper install make fop xsltproc + + Application Development Extras: + Packages needed if you are going to be developing + user-space applications: + + $ sudo zypper install autoconf automake libtool glib2-devel + + + +
+ +
+ CentOS Packages + + + The following list shows the required packages by function + given a supported CentOS Linux distribution: + + Essentials: + Packages needed to build an image for a headless + system: + + $ sudo yum -y install &CENTOS_HOST_PACKAGES_ESSENTIAL; + + Graphical Extras: + Packages needed if you are going to have graphics + support when you run the image: + + $ sudo yum -y install SDL-devel xterm + + Documentation: + Packages needed if you are going to build out the + Yocto Project documentation manuals: + + $ sudo yum -y install make docbook-style-dsssl docbook-style-xsl \ + docbook-dtds docbook-utils fop libxslt + + Application Development Extras: + Packages needed if you are going to be developing + user-space applications: + + $ sudo yum -y install autoconf automake libtool glib2-devel + + + +
+
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 @@ + + + + + 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 @@ The Packages - 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. + In general, you need to have root access and then install the + required packages. - + + + 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). + + + + For lists of required packages for other scenarios, see the + "Required Packages for the Host Development System" + section in the Yocto Project Reference Manual. + +
Ubuntu - The packages you need for a supported Ubuntu distribution are shown in the following command: - - + The essential packages you need for a supported Ubuntu distribution + are shown in the following command: - $ 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 +
Fedora - The packages you need for a supported Fedora distribution are shown in the following - commands: - - + The essential packages you need for a supported Fedora distribution + are shown in the following commands: - $ 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 - +
openSUSE - The packages you need for a supported openSUSE distribution are shown in the following - command: - - + The essential packages you need for a supported openSUSE + distribution are shown in the following command: - $ 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 +
CentOS - The packages you need for a supported CentOS distribution are shown in the following - commands: - - + The essential packages you need for a supported CentOS + distribution are shown in the following commands: - $ 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 - - 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 - Poky/GettingStarted/Dependencies - wiki page. - - +