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