summaryrefslogtreecommitdiffstats
path: root/documentation/poky-ref-manual/ref-features.xml
diff options
context:
space:
mode:
authorRichard Purdie <rpurdie@linux.intel.com>2010-10-15 11:55:59 +0100
committerRichard Purdie <rpurdie@linux.intel.com>2010-10-15 11:55:59 +0100
commit22083287912ebd552e33b79f7c567bc966376d43 (patch)
treea16fa012a97a249e25a405d4092b0a89321bfaf6 /documentation/poky-ref-manual/ref-features.xml
parent13a702e9e572a2dc9f6b52a1531a2237d4d98ff1 (diff)
downloadpoky-22083287912ebd552e33b79f7c567bc966376d43.tar.gz
handbook: Move into documentation directory
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
Diffstat (limited to 'documentation/poky-ref-manual/ref-features.xml')
-rw-r--r--documentation/poky-ref-manual/ref-features.xml302
1 files changed, 302 insertions, 0 deletions
diff --git a/documentation/poky-ref-manual/ref-features.xml b/documentation/poky-ref-manual/ref-features.xml
new file mode 100644
index 0000000000..cde9588116
--- /dev/null
+++ b/documentation/poky-ref-manual/ref-features.xml
@@ -0,0 +1,302 @@
1<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
3
4<appendix id='ref-features'>
5 <title>Reference: Features</title>
6
7 <para>'Features' provide a mechanism for working out which packages
8 should be included in the generated images. Distributions can
9 select which features they want to support through the
10 <glossterm linkend='var-DISTRO_FEATURES'><link
11 linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></glossterm>
12 variable which is set in the distribution configuration file
13 (poky.conf for Poky). Machine features are set in the
14 <glossterm linkend='var-MACHINE_FEATURES'><link
15 linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></glossterm>
16 variable which is set in the machine configuration file and
17 specifies which hardware features a given machine has.
18 </para>
19
20 <para>These two variables are combined to work out which kernel modules,
21 utilities and other packages to include. A given distribution can
22 support a selected subset of features so some machine features might not
23 be included if the distribution itself doesn't support them.
24 </para>
25
26 <section id='ref-features-distro'>
27 <title>Distro</title>
28
29 <para>The items below are valid options for <glossterm linkend='var-DISTRO_FEATURES'><link
30 linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></glossterm>.
31 </para>
32
33 <itemizedlist>
34 <listitem>
35 <para>
36 alsa - ALSA support will be included (OSS compatibility
37 kernel modules will be installed if available)
38 </para>
39 </listitem>
40 <listitem>
41 <para>
42 bluetooth - Include bluetooth support (integrated BT only)
43 </para>
44 </listitem>
45 <listitem>
46 <para>
47 ext2 - Include tools for supporting for devices with internal
48 HDD/Microdrive for storing files (instead of Flash only devices)
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 irda - Include Irda support
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 keyboard - Include keyboard support (e.g. keymaps will be
59 loaded during boot).
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 pci - Include PCI bus support
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 pcmcia - Include PCMCIA/CompactFlash support
70 </para>
71 </listitem>
72 <listitem>
73 <para>
74 usbgadget - USB Gadget Device support (for USB
75 networking/serial/storage)
76 </para>
77 </listitem>
78 <listitem>
79 <para>
80 usbhost - USB Host support (allows to connect external
81 keyboard, mouse, storage, network etc)
82 </para>
83 </listitem>
84 <listitem>
85 <para>
86 wifi - WiFi support (integrated only)
87 </para>
88 </listitem>
89 <listitem>
90 <para>
91 cramfs - CramFS support
92 </para>
93 </listitem>
94 <listitem>
95 <para>
96 ipsec - IPSec support
97 </para>
98 </listitem>
99 <listitem>
100 <para>
101 ipv6 - IPv6 support
102 </para>
103 </listitem>
104 <listitem>
105 <para>
106 nfs - NFS client support (for mounting NFS exports on
107 device)
108 </para>
109 </listitem>
110 <listitem>
111 <para>
112 ppp - PPP dialup support
113 </para>
114 </listitem>
115 <listitem>
116 <para>
117 smbfs - SMB networks client support (for mounting
118 Samba/Microsoft Windows shares on device)
119 </para>
120 </listitem>
121 </itemizedlist>
122 </section>
123
124 <section id='ref-features-machine'>
125 <title>Machine</title>
126
127 <para>The items below are valid options for <glossterm linkend='var-MACHINE_FEATURES'><link
128 linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></glossterm>.
129 </para>
130
131 <itemizedlist>
132 <listitem>
133 <para>
134 acpi - Hardware has ACPI (x86/x86_64 only)
135 </para>
136 </listitem>
137 <listitem>
138 <para>
139 alsa - Hardware has ALSA audio drivers
140 </para>
141 </listitem>
142 <listitem>
143 <para>
144 apm - Hardware uses APM (or APM emulation)
145 </para>
146 </listitem>
147 <listitem>
148 <para>
149 bluetooth - Hardware has integrated BT
150 </para>
151 </listitem>
152 <listitem>
153 <para>
154 ext2 - Hardware HDD or Microdrive
155 </para>
156 </listitem>
157 <listitem>
158 <para>
159 irda - Hardware has Irda support
160 </para>
161 </listitem>
162 <listitem>
163 <para>
164 keyboard - Hardware has a keyboard
165 </para>
166 </listitem>
167 <listitem>
168 <para>
169 pci - Hardware has a PCI bus
170 </para>
171 </listitem>
172 <listitem>
173 <para>
174 pcmcia - Hardware has PCMCIA or CompactFlash sockets
175 </para>
176 </listitem>
177 <listitem>
178 <para>
179 screen - Hardware has a screen
180 </para>
181 </listitem>
182 <listitem>
183 <para>
184 serial - Hardware has serial support (usually RS232)
185 </para>
186 </listitem>
187 <listitem>
188 <para>
189 touchscreen - Hardware has a touchscreen
190 </para>
191 </listitem>
192 <listitem>
193 <para>
194 usbgadget - Hardware is USB gadget device capable
195 </para>
196 </listitem>
197 <listitem>
198 <para>
199 usbhost - Hardware is USB Host capable
200 </para>
201 </listitem>
202 <listitem>
203 <para>
204 wifi - Hardware has integrated WiFi
205 </para>
206 </listitem>
207 </itemizedlist>
208 </section>
209
210 <section id='ref-features-image'>
211 <title>Reference: Images</title>
212
213 <para>
214 The contents of images generated by Poky can be controlled by the <glossterm
215 linkend='var-IMAGE_FEATURES'><link
216 linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></glossterm>
217 variable in local.conf. Through this you can add several different
218 predefined packages such as development utilities or packages with debug
219 information needed to investigate application problems or profile applications.
220 </para>
221
222 <para>
223 Current list of <glossterm
224 linkend='var-IMAGE_FEATURES'><link
225 linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></glossterm> contains:
226 </para>
227
228 <itemizedlist>
229 <listitem>
230 <para>
231 apps-console-core - Core console applications such as ssh daemon,
232 avahi daemon, portmap (for mounting NFS shares)
233 </para>
234 </listitem>
235 <listitem>
236 <para>
237 x11-base - X11 server + minimal desktop
238 </para>
239 </listitem>
240 <listitem>
241 <para>
242 x11-sato - OpenedHand Sato environment
243 </para>
244 </listitem>
245 <listitem>
246 <para>
247 apps-x11-core - Core X11 applications such as an X Terminal, file manager, file editor
248 </para>
249 </listitem>
250 <listitem>
251 <para>
252 apps-x11-games - A set of X11 games
253 </para>
254 </listitem>
255 <listitem>
256 <para>
257 apps-x11-pimlico - OpenedHand Pimlico application suite
258 </para>
259 </listitem>
260 <listitem>
261 <para>
262 tools-sdk - A full SDK which runs on device
263 </para>
264 </listitem>
265 <listitem>
266 <para>
267 tools-debug - Debugging tools such as strace and gdb
268 </para>
269 </listitem>
270 <listitem>
271 <para>
272 tools-profile - Profiling tools such as oprofile, exmap and LTTng
273 </para>
274 </listitem>
275 <listitem>
276 <para>
277 tools-testapps - Device testing tools (e.g. touchscreen debugging)
278 </para>
279 </listitem>
280 <listitem>
281 <para>
282 nfs-server - NFS server (exports / over NFS to everybody)
283 </para>
284 </listitem>
285 <listitem>
286 <para>
287 dev-pkgs - Development packages (headers and extra library links) for all packages
288 installed in a given image
289 </para>
290 </listitem>
291 <listitem>
292 <para>
293 dbg-pkgs - Debug packages for all packages installed in a given image
294 </para>
295 </listitem>
296 </itemizedlist>
297 </section>
298</appendix>
299
300<!--
301vim: expandtab tw=80 ts=4 spell spelllang=en_gb
302-->
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-04-28 07:16:44 +0000