summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/poky-ref-manual/introduction.xml169
-rw-r--r--documentation/poky.ent7
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs.xml97
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 @@
87<section id='intro-requirements'> 87<section id='intro-requirements'>
88<title>System Requirements</title> 88<title>System Requirements</title>
89 <para> 89 <para>
90 For Yocto Project system requirements, see the 90 For general Yocto Project system requirements, see the
91 <ulink url='&YOCTO_DOCS_QS_URL;#yp-resources'> 91 <ulink url='&YOCTO_DOCS_QS_URL;#yp-resources'>
92 What You Need and How You Get It</ulink> section in the Yocto Project Quick Start. 92 What You Need and How You Get It</ulink> section in the Yocto Project Quick Start.
93 The remainder of this section provides details on system requirements
94 not covered in the Yocto Project Quick Start.
93 </para> 95 </para>
96
97 <section id='detailed-supported-distros'>
98 <title>Supported Linux Distributions</title>
99
100 <para>
101 TBD - a list of very specific distros and versions.
102 The list will be kept up-to-date via a script provided that can
103 be run prior to a release.
104 The scripts output will yield the list and it can be copied
105 into this section.
106 </para>
107 </section>
108
109 <section id='required-packages-for-the-host-development-system'>
110 <title>Required Packages for the Host Development System</title>
111
112 <para>
113 The list of packages you need on the host development system can
114 be large when covering all build scenarios using the Yocto Project.
115 This section provides required packages by Linux distribution and
116 further categorized by function.
117 </para>
118
119 <section id='ubuntu-packages'>
120 <title>Ubuntu</title>
121
122 <para>
123 The following list shows the required packages by function
124 given a supported Ubuntu Linux distribution:
125 <itemizedlist>
126 <listitem><para><emphasis>Essentials:</emphasis>
127 Packages needed to build an image for a headless
128 system:
129 <literallayout class='monospaced'>
130 $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL;
131 </literallayout></para></listitem>
132 <listitem><para><emphasis>Graphical Extras:</emphasis>
133 Packages needed if you are going to have graphics
134 support when you run the image:
135 <literallayout class='monospaced'>
136 $ sudo apt-get install libsdl1.2-dev xterm
137 </literallayout></para></listitem>
138 <listitem><para><emphasis>Documentation:</emphasis>
139 Packages needed if you are going to build out the
140 Yocto Project documentation manuals:
141 <literallayout class='monospaced'>
142 $ sudo apt-get install make xsltproc docbook-utils fop
143 </literallayout></para></listitem>
144 <listitem><para><emphasis>Application Development Extras:</emphasis>
145 Packages needed if you are going to be developing
146 user-space applications:
147 <literallayout class='monospaced'>
148 $ sudo apt-get install autoconf automake libtool libglib2.0-dev
149 </literallayout></para></listitem>
150 </itemizedlist>
151 </para>
152 </section>
153
154 <section id='fedora-packages'>
155 <title>Fedora Packages</title>
156
157 <para>
158 The following list shows the required packages by function
159 given a supported Fedora Linux distribution:
160 <itemizedlist>
161 <listitem><para><emphasis>Essentials:</emphasis>
162 Packages needed to build an image for a headless
163 system:
164 <literallayout class='monospaced'>
165 $ sudo yum install &FEDORA_HOST_PACKAGES_ESSENTIAL;
166 </literallayout></para></listitem>
167 <listitem><para><emphasis>Graphical Extras:</emphasis>
168 Packages needed if you are going to have graphics
169 support when you run the image:
170 <literallayout class='monospaced'>
171 $ sudo yum install SDL-devel xterm
172 </literallayout></para></listitem>
173 <listitem><para><emphasis>Documentation:</emphasis>
174 Packages needed if you are going to build out the
175 Yocto Project documentation manuals:
176 <literallayout class='monospaced'>
177 $ sudo yum install make docbook-style-dsssl docbook-style-xsl \
178 docbook-dtds docbook-utils fop libxslt
179 </literallayout></para></listitem>
180 <listitem><para><emphasis>Application Development Extras:</emphasis>
181 Packages needed if you are going to be developing
182 user-space applications:
183 <literallayout class='monospaced'>
184 $ sudo yum install autoconf automake libtool glib2-devel
185 </literallayout></para></listitem>
186 </itemizedlist>
187 </para>
188 </section>
189
190 <section id='opensuse-packages'>
191 <title>OpenSUSE Packages</title>
192
193 <para>
194 The following list shows the required packages by function
195 given a supported OpenSUSE Linux distribution:
196 <itemizedlist>
197 <listitem><para><emphasis>Essentials:</emphasis>
198 Packages needed to build an image for a headless
199 system:
200 <literallayout class='monospaced'>
201 $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL;
202 </literallayout></para></listitem>
203 <listitem><para><emphasis>Graphical Extras:</emphasis>
204 Packages needed if you are going to have graphics
205 support when you run the image:
206 <literallayout class='monospaced'>
207 $ sudo zypper install libSDL-devel xterm
208 </literallayout></para></listitem>
209 <listitem><para><emphasis>Documentation:</emphasis>
210 Packages needed if you are going to build out the
211 Yocto Project documentation manuals:
212 <literallayout class='monospaced'>
213 $ sudo zypper install make fop xsltproc
214 </literallayout></para></listitem>
215 <listitem><para><emphasis>Application Development Extras:</emphasis>
216 Packages needed if you are going to be developing
217 user-space applications:
218 <literallayout class='monospaced'>
219 $ sudo zypper install autoconf automake libtool glib2-devel
220 </literallayout></para></listitem>
221 </itemizedlist>
222 </para>
223 </section>
224
225 <section id='centos-packages'>
226 <title>CentOS Packages</title>
227
228 <para>
229 The following list shows the required packages by function
230 given a supported CentOS Linux distribution:
231 <itemizedlist>
232 <listitem><para><emphasis>Essentials:</emphasis>
233 Packages needed to build an image for a headless
234 system:
235 <literallayout class='monospaced'>
236 $ sudo yum -y install &CENTOS_HOST_PACKAGES_ESSENTIAL;
237 </literallayout></para></listitem>
238 <listitem><para><emphasis>Graphical Extras:</emphasis>
239 Packages needed if you are going to have graphics
240 support when you run the image:
241 <literallayout class='monospaced'>
242 $ sudo yum -y install SDL-devel xterm
243 </literallayout></para></listitem>
244 <listitem><para><emphasis>Documentation:</emphasis>
245 Packages needed if you are going to build out the
246 Yocto Project documentation manuals:
247 <literallayout class='monospaced'>
248 $ sudo yum -y install make docbook-style-dsssl docbook-style-xsl \
249 docbook-dtds docbook-utils fop libxslt
250 </literallayout></para></listitem>
251 <listitem><para><emphasis>Application Development Extras:</emphasis>
252 Packages needed if you are going to be developing
253 user-space applications:
254 <literallayout class='monospaced'>
255 $ sudo yum -y install autoconf automake libtool glib2-devel
256 </literallayout></para></listitem>
257 </itemizedlist>
258 </para>
259 </section>
260 </section>
94</section> 261</section>
95 262
96<section id='intro-getit'> 263<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 @@
48<!ENTITY YOCTO_POKY_TARBALL "&YOCTO_POKY;.tar.bz2"> 48<!ENTITY YOCTO_POKY_TARBALL "&YOCTO_POKY;.tar.bz2">
49<!ENTITY OE_INIT_PATH "&YOCTO_POKY;/oe-init-build-env"> 49<!ENTITY OE_INIT_PATH "&YOCTO_POKY;/oe-init-build-env">
50<!ENTITY OE_INIT_FILE "oe-init-build-env"> 50<!ENTITY OE_INIT_FILE "oe-init-build-env">
51<!ENTITY UBUNTU_HOST_PACKAGES_ESSENTIAL "awk wget git-core diffstat unzip texinfo build-essential chrpath">
52<!ENTITY FEDORA_HOST_PACKAGES_ESSENTIAL "awk make wget tar bzip2 gzip python unzip perl patch diffutils diffstat git
53cpp gcc gcc-c++ eglibc-devel texinfo chrpath ccache">
54<!ENTITY OPENSUSE_HOST_PACKAGES_ESSENTIAL "python gcc gcc-c++ git chrpath make wget diffstat texinfo python-curses">
55<!ENTITY CENTOS_HOST_PACKAGES_ESSENTIAL "gawk make wget tar bzip2 gzip python unzip perl patch diffutils diffstat git
56cpp gcc gcc-c++ glibc-devel texinfo chrpath">
57
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 @@
211 <title>The Packages</title> 211 <title>The Packages</title>
212 212
213 <para> 213 <para>
214 Packages and package installation vary depending on your development system. 214 Packages and package installation vary depending on your development system
215 In general, you need to have root access and then install the required packages. 215 and on your intent.
216 The next few sections show you how to get set up with the right packages for 216 For example, if you want to build an image that can run
217 Ubuntu, Fedora, openSUSE, and CentOS. 217 on QEMU in graphical mode (a minimal, basic build
218 requirement), then the number of packages is different than if you want to
219 build an image for a headless system or build out the Yocto Project
220 documentation set.
221 Collectively, the number of required packages is large
222 if you want to be able to cover all cases.
223 <note>In general, you need to have root access and then install the
224 required packages.</note>
218 </para> 225 </para>
219 226
227 <para>
228 The next few sections list, by supported Linux Distributions, the required
229 packages needed to build an image that runs on QEMU in graphical mode
230 (e.g. essential plus graphics support).
231 </para>
232
233 <para>
234 For lists of required packages for other scenarios, see the
235 "<ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>Required Packages for the Host Development System</ulink>"
236 section in the Yocto Project Reference Manual.
237 </para>
238
220 <section id='ubuntu'> 239 <section id='ubuntu'>
221 <title>Ubuntu</title> 240 <title>Ubuntu</title>
222 241
223 <para> 242 <para>
224 The packages you need for a supported Ubuntu distribution are shown in the following command: 243 The essential packages you need for a supported Ubuntu distribution
225 </para> 244 are shown in the following command:
226
227 <literallayout class='monospaced'> 245 <literallayout class='monospaced'>
228 $ sudo apt-get install sed wget subversion git-core coreutils \ 246 $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL; libsdl1.2-dev xterm
229 unzip texi2html texinfo libsdl1.2-dev docbook-utils fop gawk \
230 python-pysqlite2 diffstat make gcc build-essential xsltproc \
231 g++ desktop-file-utils chrpath libgl1-mesa-dev libglu1-mesa-dev \
232 autoconf automake groff libtool xterm libxml-parser-perl dblatex
233 </literallayout> 247 </literallayout>
248 </para>
234 </section> 249 </section>
235 250
236 <section id='fedora'> 251 <section id='fedora'>
237 <title>Fedora</title> 252 <title>Fedora</title>
238 253
239 <para> 254 <para>
240 The packages you need for a supported Fedora distribution are shown in the following 255 The essential packages you need for a supported Fedora distribution
241 commands: 256 are shown in the following commands:
242 </para>
243
244 <literallayout class='monospaced'> 257 <literallayout class='monospaced'>
245 $ sudo yum groupinstall "development tools" 258 $ sudo yum install &FEDORA_HOST_PACKAGES_ESSENTIAL; SDL-devel xterm
246 $ sudo yum install python m4 make wget curl ftp tar bzip2 gzip \
247 unzip perl texinfo texi2html diffstat openjade \
248 docbook-style-dsssl sed docbook-style-xsl docbook-dtds fop libxslt \
249 docbook-utils sed bc eglibc-devel ccache pcre pcre-devel quilt \
250 groff linuxdoc-tools patch cmake \
251 perl-ExtUtils-MakeMaker tcl-devel gettext chrpath ncurses apr \
252 SDL-devel mesa-libGL-devel mesa-libGLU-devel gnome-doc-utils \
253 autoconf automake libtool xterm dblatex glib-gettextize
254 </literallayout> 259 </literallayout>
255 260 </para>
256 </section> 261 </section>
257 262
258 <section id='opensuse'> 263 <section id='opensuse'>
259 <title>openSUSE</title> 264 <title>openSUSE</title>
260 265
261 <para> 266 <para>
262 The packages you need for a supported openSUSE distribution are shown in the following 267 The essential packages you need for a supported openSUSE
263 command: 268 distribution are shown in the following command:
264 </para>
265
266 <literallayout class='monospaced'> 269 <literallayout class='monospaced'>
267 $ sudo zypper install python gcc gcc-c++ libtool fop \ 270 $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; libSDL-devel xterm
268 subversion git chrpath automake make wget xsltproc \
269 diffstat texinfo freeglut-devel libSDL-devel dblatex \
270 python-curses
271 </literallayout> 271 </literallayout>
272 </para>
272 </section> 273 </section>
273 274
274 <section id='centos'> 275 <section id='centos'>
275 <title>CentOS</title> 276 <title>CentOS</title>
276 277
277 <para> 278 <para>
278 The packages you need for a supported CentOS distribution are shown in the following 279 The essential packages you need for a supported CentOS
279 commands: 280 distribution are shown in the following commands:
280 </para>
281
282 <literallayout class='monospaced'> 281 <literallayout class='monospaced'>
283 $ sudo yum -y groupinstall "development tools" 282 $ sudo yum -y install &CENTOS_HOST_PACKAGES_ESSENTIAL; SDL-devel xterm
284 $ sudo yum -y install tetex gawk sqlite-devel vim-common redhat-lsb xz \
285 m4 make wget curl ftp tar bzip2 gzip python-devel \
286 unzip perl texinfo texi2html diffstat openjade zlib-devel \
287 docbook-style-dsssl sed docbook-style-xsl docbook-dtds \
288 docbook-utils bc glibc-devel pcre pcre-devel \
289 groff linuxdoc-tools patch cmake \
290 tcl-devel gettext ncurses apr \
291 SDL-devel mesa-libGL-devel mesa-libGLU-devel gnome-doc-utils \
292 autoconf automake libtool xterm dblatex
293 </literallayout> 283 </literallayout>
294 <note><para> 284 </para>
295 Depending on the CentOS version you are using, other requirements and dependencies
296 might exist.
297 For details, you should look at the CentOS sections on the
298 <ulink url='&YOCTO_WIKI_URL;/wiki/Poky/GettingStarted/Dependencies'>Poky/GettingStarted/Dependencies</ulink>
299 wiki page.
300 </para></note>
301
302 </section> 285 </section>
303 </section> 286 </section>
304 287