doc: add version, add gitwebs
[opendreambox.git] / doc / opendreambox.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"  
2   "http://www.w3.org/TR/html4/loose.dtd">  
3 <html > 
4 <head><title>opendreambox</title> 
5 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> 
6 <meta name="generator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)"> 
7 <meta name="originator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)"> 
8 <!-- html --> 
9 <meta name="src" content="opendreambox.tex"> 
10 <meta name="date" content="2012-05-05 01:12:00"> 
11 <link rel="stylesheet" type="text/css" href="opendreambox.css"> 
12 </head><body 
13 >
14 <div class="maketitle">
15                                                                   
16
17                                                                   
18                                                                   
19
20                                                                   
21
22 <h2 class="titleHead">opendreambox</h2>
23 <div class="author" ><span 
24 class="cmr-12">Andreas Oberritter </span><span 
25 class="cmtt-9">&#x003C;obi@opendreambox.org&#x003E;</span></div>
26 <br />
27 <div class="date" ><span 
28 class="cmr-12">May 2012</span></div>
29 </div>
30 <h3 class="likesectionHead"><a 
31  id="x1-1000"></a>Contents</h3>
32 <div class="tableofcontents">
33 <span class="sectionToc" >1 <a 
34 href="#x1-20001" id="QQ2-1-2">Introduction</a></span>
35 <br />&#x00A0;<span class="subsectionToc" >1.1 <a 
36 href="#x1-30001.1" id="QQ2-1-3">Target audience</a></span>
37 <br />&#x00A0;<span class="subsectionToc" >1.2 <a 
38 href="#x1-40001.2" id="QQ2-1-4">Supported products</a></span>
39 <br />&#x00A0;<span class="subsectionToc" >1.3 <a 
40 href="#x1-50001.3" id="QQ2-1-5">License</a></span>
41 <br />&#x00A0;<span class="subsectionToc" >1.4 <a 
42 href="#x1-60001.4" id="QQ2-1-6">Obtaining the source code</a></span>
43 <br />&#x00A0;<span class="subsectionToc" >1.5 <a 
44 href="#x1-70001.5" id="QQ2-1-7">Quick start</a></span>
45 <br />&#x00A0;<span class="subsectionToc" >1.6 <a 
46 href="#x1-80001.6" id="QQ2-1-8">Directory structure</a></span>
47 <br />&#x00A0;&#x00A0;<span class="subsubsectionToc" >1.6.1 <a 
48 href="#x1-90001.6.1" id="QQ2-1-9">openembedded-core and meta-openembedded</a></span>
49 <br />&#x00A0;&#x00A0;<span class="subsubsectionToc" >1.6.2 <a 
50 href="#x1-100001.6.2" id="QQ2-1-10">meta-opendreambox</a></span>
51 <br />&#x00A0;&#x00A0;<span class="subsubsectionToc" >1.6.3 <a 
52 href="#x1-110001.6.3" id="QQ2-1-11">meta-bsp</a></span>
53 <br /><span class="sectionToc" >2 <a 
54 href="#x1-120002" id="QQ2-1-12">Prerequisites</a></span>
55 <br />&#x00A0;<span class="subsectionToc" >2.1 <a 
56 href="#x1-130002.1" id="QQ2-1-13">Required software</a></span>
57 <br /><span class="sectionToc" >3 <a 
58 href="#x1-140003" id="QQ2-1-14">Major changes since previous releases</a></span>
59 <br />&#x00A0;<span class="subsectionToc" >3.1 <a 
60 href="#x1-150003.1" id="QQ2-1-15">Changes since release 1.6</a></span>
61 <br /><span class="sectionToc" >4 <a 
62 href="#x1-160004" id="QQ2-1-16">Known Issues</a></span>
63 <br /><span class="sectionToc" >5 <a 
64 href="#x1-170005" id="QQ2-1-17">Building OpenDreambox</a></span>
65 <br />&#x00A0;<span class="subsectionToc" >5.1 <a 
66 href="#x1-180005.1" id="QQ2-1-18">Makefile targets</a></span>
67                                                                   
68
69                                                                   
70 <br />&#x00A0;<span class="subsectionToc" >5.2 <a 
71 href="#x1-190005.2" id="QQ2-1-19">Configuration variables</a></span>
72 <br />&#x00A0;&#x00A0;<span class="subsubsectionToc" >5.2.1 <a 
73 href="#x1-200005.2.1" id="QQ2-1-20">BB_NUMBER_THREADS</a></span>
74 <br />&#x00A0;&#x00A0;<span class="subsubsectionToc" >5.2.2 <a 
75 href="#x1-210005.2.2" id="QQ2-1-21">MACHINE</a></span>
76 <br />&#x00A0;&#x00A0;<span class="subsubsectionToc" >5.2.3 <a 
77 href="#x1-220005.2.3" id="QQ2-1-22">PARALLEL_MAKE</a></span>
78 <br />&#x00A0;<span class="subsectionToc" >5.3 <a 
79 href="#x1-230005.3" id="QQ2-1-23">Adding custom layers</a></span>
80 <br />&#x00A0;<span class="subsectionToc" >5.4 <a 
81 href="#x1-240005.4" id="QQ2-1-24">Adding custom options</a></span>
82 <br />&#x00A0;&#x00A0;<span class="subsubsectionToc" >5.4.1 <a 
83 href="#x1-250005.4.1" id="QQ2-1-25">DISTRO_FEED_PREFIX</a></span>
84 <br />&#x00A0;&#x00A0;<span class="subsubsectionToc" >5.4.2 <a 
85 href="#x1-260005.4.2" id="QQ2-1-26">DISTRO_FEED_URI</a></span>
86 <br />&#x00A0;&#x00A0;<span class="subsubsectionToc" >5.4.3 <a 
87 href="#x1-270005.4.3" id="QQ2-1-27">INHERIT</a></span>
88 <br />&#x00A0;<span class="subsectionToc" >5.5 <a 
89 href="#x1-280005.5" id="QQ2-1-28">Setting up a build directory</a></span>
90 <br />&#x00A0;<span class="subsectionToc" >5.6 <a 
91 href="#x1-290005.6" id="QQ2-1-29">Building a firmware image</a></span>
92 <br />&#x00A0;<span class="subsectionToc" >5.7 <a 
93 href="#x1-300005.7" id="QQ2-1-30">Building a package</a></span>
94 <br /><span class="sectionToc" >6 <a 
95 href="#x1-310006" id="QQ2-1-31">Development hints</a></span>
96 <br />&#x00A0;<span class="subsectionToc" >6.1 <a 
97 href="#x1-320006.1" id="QQ2-1-32">Cross-compilation of external software</a></span>
98 <br />&#x00A0;<span class="subsectionToc" >6.2 <a 
99 href="#x1-330006.2" id="QQ2-1-33">Coding style</a></span>
100 <br />&#x00A0;<span class="subsectionToc" >6.3 <a 
101 href="#x1-340006.3" id="QQ2-1-34">Package architecture</a></span>
102 <br /><span class="sectionToc" >7 <a 
103 href="#x1-350007" id="QQ2-1-35">Bug reports and patches</a></span>
104 </div>
105                                                                   
106
107                                                                   
108 <!--l. 54--><p class="noindent" >
109 <h3 class="sectionHead"><span class="titlemark">1   </span> <a 
110  id="x1-20001"></a>Introduction</h3>
111 <div class="flushleft" 
112 >
113 <!--l. 55--><p class="noindent" >
114  This document briefly describes the OpenDreambox distribution, an
115 embedded Linux distribution for Set-Top-Boxes manufactured by <a 
116 href="http://www.dream-multimedia-tv.de/" >Dream
117 Multimedia GmbH</a>.
118 <!--l. 59--><p class="noindent" >OpenDreambox is based on the <a 
119 href="http://www.openembedded.org/" >OpenEmbedded</a> build framework, which uses
120 <a 
121 href="http://bitbake.berlios.de/" >BitBake</a> to transform build instructions into distributable firmare images and
122 software packages.
123 <!--l. 63--><p class="noindent" >The current version, OpenDreambox 2.0, is based on OpenEmbedded &#8221;denzil&#8221;.</div>
124 <!--l. 66--><p class="noindent" >
125 <h4 class="subsectionHead"><span class="titlemark">1.1   </span> <a 
126  id="x1-30001.1"></a>Target audience</h4>
127 <div class="flushleft" 
128 >
129 <!--l. 67--><p class="noindent" >
130  Developers familiar with previous versions of OpenDreambox or
131 OpenEmbedded in general.</div>
132 <!--l. 72--><p class="noindent" >
133 <h4 class="subsectionHead"><span class="titlemark">1.2   </span> <a 
134  id="x1-40001.2"></a>Supported products</h4>
135 <div class="flushleft" 
136 >
137 <!--l. 74--><p class="noindent" >
138  The current version includes support for the following machines:
139 <div class="tabular"> <table id="TBL-2" class="tabular" 
140 cellspacing="0" cellpadding="0" rules="groups" 
141 ><colgroup id="TBL-2-1g"><col 
142 id="TBL-2-1"></colgroup><colgroup id="TBL-2-2g"><col 
143 id="TBL-2-2"></colgroup><tr 
144 class="hline"><td><hr></td><td><hr></td></tr><tr  
145  style="vertical-align:baseline;" id="TBL-2-1-"><td  style="white-space:nowrap; text-align:left;" id="TBL-2-1-1"  
146 class="td11"><span 
147 class="cmbx-10">Product name  </span></td><td  style="white-space:nowrap; text-align:left;" id="TBL-2-1-2"  
148 class="td11"><span 
149 class="cmbx-10">Environment variable</span></td></tr><tr 
150 class="hline"><td><hr></td><td><hr></td></tr><tr  
151  style="vertical-align:baseline;" id="TBL-2-2-"><td  style="white-space:nowrap; text-align:left;" id="TBL-2-2-1"  
152 class="td11"> </td><td  style="white-space:nowrap; text-align:left;" id="TBL-2-2-2"  
153 class="td11"></td>
154 </tr><tr  
155  style="vertical-align:baseline;" id="TBL-2-3-"><td  style="white-space:nowrap; text-align:left;" id="TBL-2-3-1"  
156 class="td11">DM 500 HD         </td><td  style="white-space:nowrap; text-align:left;" id="TBL-2-3-2"  
157 class="td11"><span 
158 class="cmtt-9">MACHINE=dm500hd        </span></td>
159 </tr><tr  
160  style="vertical-align:baseline;" id="TBL-2-4-"><td  style="white-space:nowrap; text-align:left;" id="TBL-2-4-1"  
161 class="td11">DM 800 HD PVR  </td><td  style="white-space:nowrap; text-align:left;" id="TBL-2-4-2"  
162 class="td11"><span 
163 class="cmtt-9">MACHINE=dm800          </span></td>
164 </tr><tr  
165  style="vertical-align:baseline;" id="TBL-2-5-"><td  style="white-space:nowrap; text-align:left;" id="TBL-2-5-1"  
166 class="td11">DM 800 HD SE    </td><td  style="white-space:nowrap; text-align:left;" id="TBL-2-5-2"  
167 class="td11"><span 
168 class="cmtt-9">MACHINE=dm800se        </span></td>
169 </tr><tr  
170  style="vertical-align:baseline;" id="TBL-2-6-"><td  style="white-space:nowrap; text-align:left;" id="TBL-2-6-1"  
171 class="td11">DM 7020 HD       </td><td  style="white-space:nowrap; text-align:left;" id="TBL-2-6-2"  
172 class="td11"><span 
173 class="cmtt-9">MACHINE=dm7020hd       </span></td>
174 </tr><tr  
175  style="vertical-align:baseline;" id="TBL-2-7-"><td  style="white-space:nowrap; text-align:left;" id="TBL-2-7-1"  
176 class="td11">DM 8000 HD PVR</td><td  style="white-space:nowrap; text-align:left;" id="TBL-2-7-2"  
177 class="td11"><span 
178 class="cmtt-9">MACHINE=dm8000         </span></td>
179 </tr><tr  
180  style="vertical-align:baseline;" id="TBL-2-8-"><td  style="white-space:nowrap; text-align:left;" id="TBL-2-8-1"  
181 class="td11">                </td><td  style="white-space:nowrap; text-align:left;" id="TBL-2-8-2"  
182 class="td11">                     </td>
183 </tr><tr 
184 class="hline"><td><hr></td><td><hr></td></tr><tr  
185  style="vertical-align:baseline;" id="TBL-2-9-"><td  style="white-space:nowrap; text-align:left;" id="TBL-2-9-1"  
186 class="td11">                </td>
187 </tr></table></div></div>
188                                                                   
189
190                                                                   
191 <!--l. 91--><p class="noindent" >
192 <h4 class="subsectionHead"><span class="titlemark">1.3   </span> <a 
193  id="x1-50001.3"></a>License</h4>
194                                                                   
195
196                                                                   
197 <div class="verbatim" id="verbatim-1">
198 Copyright&#x00A0;(c)&#x00A0;2010-2012&#x00A0;Dream&#x00A0;Multimedia&#x00A0;GmbH,&#x00A0;Germany
199 &#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;http://www.dream-multimedia-tv.de/
200 &#x00A0;<br />Authors:
201 &#x00A0;<br />&#x00A0;&#x00A0;Andreas&#x00A0;Frisch&#x00A0;&#x003C;fraxinas@opendreambox.org&#x003E;
202 &#x00A0;<br />&#x00A0;&#x00A0;Andreas&#x00A0;Monzner&#x00A0;&#x003C;ghost@opendreambox.org&#x003E;
203 &#x00A0;<br />&#x00A0;&#x00A0;Andreas&#x00A0;Oberritter&#x00A0;&#x003C;obi@opendreambox.org&#x003E;
204 &#x00A0;<br />&#x00A0;&#x00A0;Mladen&#x00A0;Horvat&#x00A0;&#x003C;acid-burn@opendreambox.org&#x003E;
205 &#x00A0;<br />&#x00A0;&#x00A0;Stefan&#x00A0;Pluecken&#x00A0;&#x003C;thedoc@opendreambox.org&#x003E;
206 &#x00A0;<br />&#x00A0;&#x00A0;Stephan&#x00A0;Reichholf&#x00A0;&#x003C;reichi@opendreambox.org&#x003E;
207 &#x00A0;<br />
208 &#x00A0;<br />Permission&#x00A0;is&#x00A0;hereby&#x00A0;granted,&#x00A0;free&#x00A0;of&#x00A0;charge,&#x00A0;to&#x00A0;any&#x00A0;person&#x00A0;obtaining&#x00A0;a&#x00A0;copy
209 &#x00A0;<br />of&#x00A0;this&#x00A0;software&#x00A0;and&#x00A0;associated&#x00A0;documentation&#x00A0;files&#x00A0;(the&#x00A0;"Software"),&#x00A0;to&#x00A0;deal
210 &#x00A0;<br />in&#x00A0;the&#x00A0;Software&#x00A0;without&#x00A0;restriction,&#x00A0;including&#x00A0;without&#x00A0;limitation&#x00A0;the&#x00A0;rights
211 &#x00A0;<br />to&#x00A0;use,&#x00A0;copy,&#x00A0;modify,&#x00A0;merge,&#x00A0;publish,&#x00A0;distribute,&#x00A0;sublicense,&#x00A0;and/or&#x00A0;sell
212 &#x00A0;<br />copies&#x00A0;of&#x00A0;the&#x00A0;Software,&#x00A0;and&#x00A0;to&#x00A0;permit&#x00A0;persons&#x00A0;to&#x00A0;whom&#x00A0;the&#x00A0;Software&#x00A0;is
213 &#x00A0;<br />furnished&#x00A0;to&#x00A0;do&#x00A0;so,&#x00A0;subject&#x00A0;to&#x00A0;the&#x00A0;following&#x00A0;conditions:
214 &#x00A0;<br />
215 &#x00A0;<br />The&#x00A0;above&#x00A0;copyright&#x00A0;notice&#x00A0;and&#x00A0;this&#x00A0;permission&#x00A0;notice&#x00A0;shall&#x00A0;be&#x00A0;included&#x00A0;in
216 &#x00A0;<br />all&#x00A0;copies&#x00A0;or&#x00A0;substantial&#x00A0;portions&#x00A0;of&#x00A0;the&#x00A0;Software.
217 &#x00A0;<br />
218 &#x00A0;<br />THE&#x00A0;SOFTWARE&#x00A0;IS&#x00A0;PROVIDED&#x00A0;"AS&#x00A0;IS",&#x00A0;WITHOUT&#x00A0;WARRANTY&#x00A0;OF&#x00A0;ANY&#x00A0;KIND,&#x00A0;EXPRESS&#x00A0;OR
219 &#x00A0;<br />IMPLIED,&#x00A0;INCLUDING&#x00A0;BUT&#x00A0;NOT&#x00A0;LIMITED&#x00A0;TO&#x00A0;THE&#x00A0;WARRANTIES&#x00A0;OF&#x00A0;MERCHANTABILITY,
220 &#x00A0;<br />FITNESS&#x00A0;FOR&#x00A0;A&#x00A0;PARTICULAR&#x00A0;PURPOSE&#x00A0;AND&#x00A0;NONINFRINGEMENT.&#x00A0;IN&#x00A0;NO&#x00A0;EVENT&#x00A0;SHALL&#x00A0;THE
221 &#x00A0;<br />AUTHORS&#x00A0;OR&#x00A0;COPYRIGHT&#x00A0;HOLDERS&#x00A0;BE&#x00A0;LIABLE&#x00A0;FOR&#x00A0;ANY&#x00A0;CLAIM,&#x00A0;DAMAGES&#x00A0;OR&#x00A0;OTHER
222 &#x00A0;<br />LIABILITY,&#x00A0;WHETHER&#x00A0;IN&#x00A0;AN&#x00A0;ACTION&#x00A0;OF&#x00A0;CONTRACT,&#x00A0;TORT&#x00A0;OR&#x00A0;OTHERWISE,&#x00A0;ARISING&#x00A0;FROM,
223 &#x00A0;<br />OUT&#x00A0;OF&#x00A0;OR&#x00A0;IN&#x00A0;CONNECTION&#x00A0;WITH&#x00A0;THE&#x00A0;SOFTWARE&#x00A0;OR&#x00A0;THE&#x00A0;USE&#x00A0;OR&#x00A0;OTHER&#x00A0;DEALINGS&#x00A0;IN
224 &#x00A0;<br />THE&#x00A0;SOFTWARE.
225 &#x00A0;<br />&#x00A0;&#x00A0;&#x00A0;&#x00A0;</div>
226 <!--l. 121--><p class="nopar" >
227 <!--l. 123--><p class="noindent" >
228 <h4 class="subsectionHead"><span class="titlemark">1.4   </span> <a 
229  id="x1-60001.4"></a>Obtaining the source code</h4>
230 <!--l. 124--><p class="noindent" >OpenDreambox uses the Git version control system. To obtain the source code, it is
231 required to install Git. See <a 
232 href="http://git-scm.com/" class="url" ><span 
233 class="cmtt-10">http://git-scm.com/</span></a>.
234 <!--l. 127--><p class="noindent" >To initially download the source into the current directory, issue the following
235 command:
236 <!--l. 130--><p class="noindent" ><span 
237 class="cmtt-9">git clone git://git.opendreambox.org/git/opendreambox.git</span>
238 <!--l. 132--><p class="noindent" >The Git repository can be viewed online at:
239 <!--l. 134--><p class="noindent" ><a 
240 href="http://cgit.opendreambox.org/opendreambox.git" class="url" ><span 
241 class="cmtt-10">http://cgit.opendreambox.org/opendreambox.git</span></a>
242                                                                   
243
244                                                                   
245 <!--l. 136--><p class="noindent" >
246 <h4 class="subsectionHead"><span class="titlemark">1.5   </span> <a 
247  id="x1-70001.5"></a>Quick start</h4>
248 <!--l. 137--><p class="noindent" >For the impatient:
249 <!--l. 139--><p class="noindent" ><span 
250 class="cmtt-9">make -C opendreambox image</span>
251 <!--l. 141--><p class="noindent" >If this command fails, prerequisites my be missing. See section <a 
252 href="#x1-120002">2<!--tex4ht:ref: prerequisites --></a>.
253 <!--l. 143--><p class="noindent" >
254 <h4 class="subsectionHead"><span class="titlemark">1.6   </span> <a 
255  id="x1-80001.6"></a>Directory structure</h4>
256 <!--l. 144--><p class="noindent" >OpenDreambox consists of a set of layers containing build instructions. This meta
257 data is used by BitBake to download and compile source code and to assemble
258 installable software packages and firmware images.
259 <!--l. 148--><p class="noindent" >Currently, there are five layers, ordered by priority from lowest to highest:
260      <ul class="itemize1">
261      <li class="itemize"><span 
262 class="cmtt-9">openembedded-core</span>
263      </li>
264      <li class="itemize"><span 
265 class="cmtt-9">meta-openembedded</span>
266      </li>
267      <li class="itemize"><span 
268 class="cmtt-9">meta-opendreambox</span>
269      </li>
270      <li class="itemize"><span 
271 class="cmtt-9">meta-bsp/common</span>
272      </li>
273      <li class="itemize"><span 
274 class="cmtt-9">meta-bsp/$</span><span 
275 class="cmsy-9">{</span><span 
276 class="cmtt-9">MACHINE</span><span 
277 class="cmsy-9">}</span></li></ul>
278 <!--l. 159--><p class="noindent" >If a recipe for the same package exists in multiple layers, then the higher priority
279 layer takes precedence over the lower priority layer.
280 <!--l. 163--><p class="noindent" >For example, <span 
281 class="cmtt-9">libmad</span><span 
282 class="cmtt-9">_0.15.1b.bb </span>exists in both <span 
283 class="cmtt-9">meta-openembedded </span>and
284 <span 
285 class="cmtt-9">openembedded-core</span>. The recipe in <span 
286 class="cmtt-9">meta-openembedded </span>will be used, because
287 <span 
288 class="cmtt-9">openembedded-core </span>has lower priority.
289 <!--l. 168--><p class="noindent" ><span 
290 class="cmbx-10">NOTE: </span>This would still be true even if the version of <span 
291 class="cmtt-9">libmad </span>in <span 
292 class="cmtt-9">openembeded-core</span>
293 was higher than the version in <span 
294 class="cmtt-9">meta-openembedded</span>, unless <span 
295 class="cmtt-9">PREFERRED</span><span 
296 class="cmtt-9">_VERSION</span><span 
297 class="cmtt-9">_libmad</span>
298 was set to the version in <span 
299 class="cmtt-9">openembedded-core</span>. There is currently no way to prefer a
300 version of a lower priority layer, if the same version is present in a higher priority
301 layer.
302                                                                   
303
304                                                                   
305 <!--l. 174--><p class="noindent" >
306 <h5 class="subsubsectionHead"><span class="titlemark">1.6.1   </span> <a 
307  id="x1-90001.6.1"></a>openembedded-core and meta-openembedded</h5>
308 <!--l. 175--><p class="noindent" >These directories contain copies of Git repositories from git.openembedded.org,
309 including the OpenEmbedded-Core layer (&#8221;meta&#8221;) and the OpenEmbedded layer
310 (&#8221;meta-oe&#8221;). They get created automatically when building the distribution for the
311 first time.
312 <!--l. 179--><p class="noindent" >Throughout this document, the combination of these directories will be referred to as
313 OpenEmbedded.
314 <!--l. 182--><p class="noindent" >The latest changes to these Git repositories can be seen at:
315 <!--l. 184--><p class="noindent" ><a 
316 href="http://git.openembedded.org/openembedded-core-contrib/log/?h=obi/current" class="url" ><span 
317 class="cmtt-10">http://git.openembedded.org/openembedded-core-contrib/log/?h=obi/current</span></a>
318 <!--l. 186--><p class="noindent" ><a 
319 href="http://git.openembedded.org/meta-openembedded-contrib/log/?h=obi/current" class="url" ><span 
320 class="cmtt-10">http://git.openembedded.org/meta-openembedded-contrib/log/?h=obi/current</span></a>
321 <!--l. 188--><p class="noindent" >
322 <h5 class="subsubsectionHead"><span class="titlemark">1.6.2   </span> <a 
323  id="x1-100001.6.2"></a>meta-opendreambox</h5>
324 <!--l. 189--><p class="noindent" >This directory contains:
325      <ul class="itemize1">
326      <li class="itemize">Recipes   for   packages   written   specifically   for   the   OpenDreambox
327      distribution
328      </li>
329      <li class="itemize">Modifications to recipes from OpenEmbedded
330      </li>
331      <li class="itemize">Recipes   for   software   versions   older   than   those   available   from
332      OpenEmbedded
333      </li>
334      <li class="itemize">Recipes   for   software   versions   newer   than   those   available   from
335      OpenEmbedded</li></ul>
336 <!--l. 198--><p class="noindent" >
337 <h5 class="subsubsectionHead"><span class="titlemark">1.6.3   </span> <a 
338  id="x1-110001.6.3"></a>meta-bsp</h5>
339 <!--l. 199--><p class="noindent" >The directory <span 
340 class="cmtt-9">meta-bsp </span>contains Board Support Packages (BSP) for the supported
341 Dreambox models. This includes:
342      <ul class="itemize1">
343      <li class="itemize">Hardware drivers
344                                                                   
345
346                                                                   
347      </li>
348      <li class="itemize">Machine specific overrides
349      </li>
350      <li class="itemize">The Linux kernel
351      </li>
352      <li class="itemize">The boot loader
353      </li>
354      <li class="itemize">Splash images</li></ul>
355 <!--l. 210--><p class="noindent" >
356 <h3 class="sectionHead"><span class="titlemark">2   </span> <a 
357  id="x1-120002"></a>Prerequisites</h3>
358 <!--l. 213--><p class="noindent" >
359 <h4 class="subsectionHead"><span class="titlemark">2.1   </span> <a 
360  id="x1-130002.1"></a>Required software</h4>
361 <!--l. 215--><p class="noindent" >The OpenEmbedded project provides a general list of prerequisites for many Linux
362 distributions and also for some other operating systems.
363      <ul class="itemize1">
364      <li class="itemize"><a 
365 href="http://www.openembedded.org/index.php/OEandYourDistro" class="url" ><span 
366 class="cmtt-10">http://www.openembedded.org/index.php/OEandYourDistro</span></a>
367      </li>
368      <li class="itemize"><a 
369 href="http://www.openembedded.org/index.php/Required\_software" class="url" ><span 
370 class="cmtt-10">http://www.openembedded.org/index.php/Required\_software</span></a></li></ul>
371 <!--l. 223--><p class="noindent" >It is highly recommended to use Linux to build OpenDreambox. In theory, any recent
372 distribution will do, but not many distributions have been verified to build
373 OpenDreambox without errors. Tested distributions include:
374      <ul class="itemize1">
375      <li class="itemize">Arch Linux 2011.08.19 [amd64]
376      </li>
377      <li class="itemize">Debian 6.0 (Squeeze) [i386]
378      </li>
379      <li class="itemize">Debian &#8221;Testing&#8221; (Wheezy) [i386]
380      </li>
381      <li class="itemize">Fedora 16 [i386, amd64]
382      </li>
383      <li class="itemize">Ubuntu 10.04 LTS (Lucid Lynx) [i386]
384                                                                   
385
386                                                                   
387      </li>
388      <li class="itemize">Ubuntu 11.10 (Oneiric Ocelot) [amd64]
389      </li>
390      <li class="itemize">Ubuntu 12.04 LTS (Precise Pangolin) [i386, amd64]</li></ul>
391 <!--l. 238--><p class="noindent" >Distributions known not to work:
392      <ul class="itemize1">
393      <li class="itemize">Debian 5.0 (Lenny): Comes with Python 2.5, which is too old.</li></ul>
394                                                                   
395
396                                                                   
397 <!--l. 246--><p class="noindent" >
398 <h3 class="sectionHead"><span class="titlemark">3   </span> <a 
399  id="x1-140003"></a>Major changes since previous releases</h3>
400 <!--l. 248--><p class="noindent" >
401 <h4 class="subsectionHead"><span class="titlemark">3.1   </span> <a 
402  id="x1-150003.1"></a>Changes since release 1.6</h4>
403      <ul class="itemize1">
404      <li class="itemize">Recipes were split across multiple layers and categorized.
405      </li>
406      <li class="itemize"><span 
407 class="cmtt-9">env.source  </span>has   been   replaced   by   two   files,   <span 
408 class="cmtt-9">bitbake.env  </span>and
409      <span 
410 class="cmtt-9">cross-compile.env</span>. The former sets a minimal environment that is needed
411      to execute bitbake. The latter creates machine-specific command aliases,
412      in order to compile external software.
413      </li>
414      <li class="itemize">All machines share a common <span 
415 class="cmtt-9">tmp </span>directory.
416      </li>
417      <li class="itemize"><span 
418 class="cmtt-9">$</span><span 
419 class="cmsy-9">{</span><span 
420 class="cmtt-9">MACHINE</span><span 
421 class="cmsy-9">}</span><span 
422 class="cmtt-9">/build </span>directories were renamed to <span 
423 class="cmtt-9">build/$</span><span 
424 class="cmsy-9">{</span><span 
425 class="cmtt-9">MACHINE</span><span 
426 class="cmsy-9">}</span>.
427      </li>
428      <li class="itemize">Kernel packages were renamed from <span 
429 class="cmtt-9">linux-$</span><span 
430 class="cmsy-9">{</span><span 
431 class="cmtt-9">MACHINE</span><span 
432 class="cmsy-9">} </span>to <span 
433 class="cmtt-9">linux-dreambox</span>.
434      </li>
435      <li class="itemize">Support for machines based on ATI Xilleon or IBM STB was dropped.</li></ul>
436 <!--l. 261--><p class="noindent" >
437 <h3 class="sectionHead"><span class="titlemark">4   </span> <a 
438  id="x1-160004"></a>Known Issues</h3>
439      <ul class="itemize1">
440      <li class="itemize">Building on eCryptfs fails, because it doesn&#8217;t support sufficiently long
441      filenames (<a 
442 href="https://bugs.launchpad.net/ecryptfs/+bug/344878" >eCryptfs bug #344878</a>).</li></ul>
443                                                                   
444
445                                                                   
446 <!--l. 269--><p class="noindent" >
447 <h3 class="sectionHead"><span class="titlemark">5   </span> <a 
448  id="x1-170005"></a>Building OpenDreambox</h3>
449 <!--l. 271--><p class="noindent" >In the top level directory, there is a <span 
450 class="cmtt-9">Makefile</span>, which is used to set up build
451 directories and to fetch or update all used repositories. The Makefile can
452 be influenced by environment variables, either by specifing them on the
453 command-line or by storing them in a file called <span 
454 class="cmtt-9">conf/make.conf</span>. It is not
455 recommended to edit the <span 
456 class="cmtt-9">Makefile </span>directly in order to avoid conflicts with future
457 updates.
458 <!--l. 278--><p class="noindent" >When the <span 
459 class="cmtt-9">Makefile </span>is run for the first time, the following steps will be executed:
460      <ul class="itemize1">
461      <li class="itemize">Creation of configuration files
462          <ul class="itemize2">
463          <li class="itemize"><span 
464 class="cmtt-9">bitbake.env</span>
465          </li>
466          <li class="itemize"><span 
467 class="cmtt-9">conf/opendreambox.conf</span>
468          </li>
469          <li class="itemize"><span 
470 class="cmtt-9">build/$</span><span 
471 class="cmsy-9">{</span><span 
472 class="cmtt-9">MACHINE</span><span 
473 class="cmsy-9">}</span><span 
474 class="cmtt-9">/conf/bblayers.conf</span>
475          </li>
476          <li class="itemize"><span 
477 class="cmtt-9">build/$</span><span 
478 class="cmsy-9">{</span><span 
479 class="cmtt-9">MACHINE</span><span 
480 class="cmsy-9">}</span><span 
481 class="cmtt-9">/conf/local.conf</span></li></ul>
482      </li>
483      <li class="itemize">Update or checkout of Git repositories
484          <ul class="itemize2">
485          <li class="itemize">OpenDreambox
486          </li>
487          <li class="itemize">BitBake
488          </li>
489          <li class="itemize">OpenEmbedded</li></ul>
490      </li></ul>
491 <!--l. 297--><p class="noindent" >
492 <h4 class="subsectionHead"><span class="titlemark">5.1   </span> <a 
493  id="x1-180005.1"></a>Makefile targets</h4>
494 <!--l. 298--><p class="noindent" >Run <span 
495 class="cmtt-9">make help </span>to get a list of targets of the top level Makefile, together with a brief
496 description.
497                                                                   
498
499                                                                   
500 <!--l. 300--><p class="noindent" >
501 <h4 class="subsectionHead"><span class="titlemark">5.2   </span> <a 
502  id="x1-190005.2"></a>Configuration variables</h4>
503 <!--l. 301--><p class="noindent" >
504 <h5 class="subsubsectionHead"><span class="titlemark">5.2.1   </span> <a 
505  id="x1-200005.2.1"></a>BB_NUMBER_THREADS</h5>
506 <!--l. 302--><p class="noindent" >Controls how many BitBake tasks may run at a time. Defaults to the number of cores
507 available on the build system. The number of cores is obtained from <span 
508 class="cmtt-9">/proc/cpuinfo</span>. If
509 this file is unavailable, the default value is 1.
510 <!--l. 307--><p class="noindent" >
511 <h5 class="subsubsectionHead"><span class="titlemark">5.2.2   </span> <a 
512  id="x1-210005.2.2"></a>MACHINE</h5>
513 <!--l. 308--><p class="noindent" >Controls the target machine to build packages for. See section <a 
514 href="#x1-40001.2">1.2<!--tex4ht:ref: products --></a> for a list of
515 supported products.
516 <!--l. 311--><p class="noindent" >
517 <h5 class="subsubsectionHead"><span class="titlemark">5.2.3   </span> <a 
518  id="x1-220005.2.3"></a>PARALLEL_MAKE</h5>
519 <!--l. 312--><p class="noindent" >Controls how many processes per recipe <span 
520 class="cmtt-9">make </span>may use. Defaults to the number of
521 cores available on the build system. The number of cores is obtained from
522 <span 
523 class="cmtt-9">/proc/cpuinfo</span>. If this file is unavailable, the default value is 1.
524 <!--l. 317--><p class="noindent" >NOTE: If you see seemingly random build failures, try setting this variable to
525 1.
526 <!--l. 319--><p class="noindent" >
527 <h4 class="subsectionHead"><span class="titlemark">5.3   </span> <a 
528  id="x1-230005.3"></a>Adding custom layers</h4>
529 <!--l. 321--><p class="noindent" >It is possible to add custom layers to the build system. This can be done globally and
530 per machine. To add a layer globally, edit <span 
531 class="cmtt-9">conf/bblayers-ext.conf</span>. To add a
532 machine-specific layer, edit <span 
533 class="cmtt-9">conf/bblayers-$</span><span 
534 class="cmsy-9">{</span><span 
535 class="cmtt-9">MACHINE</span><span 
536 class="cmsy-9">}</span><span 
537 class="cmtt-9">-ext.conf</span>. Assuming that an
538 additional layer is available at <span 
539 class="cmtt-9">$</span><span 
540 class="cmsy-9">{</span><span 
541 class="cmtt-9">HOME</span><span 
542 class="cmsy-9">}</span><span 
543 class="cmtt-9">/custom-layer</span>, the entry to add to the file will
544 look like this:
545 <!--l. 327--><p class="noindent" ><span 
546 class="cmtt-9">BBLAYERS =+ "$</span><span 
547 class="cmsy-9">{</span><span 
548 class="cmtt-9">HOME</span><span 
549 class="cmsy-9">}</span><span 
550 class="cmtt-9">/custom-layer"</span>
551                                                                   
552
553                                                                   
554 <!--l. 329--><p class="noindent" >
555 <h4 class="subsectionHead"><span class="titlemark">5.4   </span> <a 
556  id="x1-240005.4"></a>Adding custom options</h4>
557 <!--l. 330--><p class="noindent" >It is possible to tweak a lot more options than those used by the <span 
558 class="cmtt-9">Makefile </span>by editing
559 <span 
560 class="cmtt-9">conf/local-ext.conf </span>or <span 
561 class="cmtt-9">conf/local-$</span><span 
562 class="cmsy-9">{</span><span 
563 class="cmtt-9">MACHINE</span><span 
564 class="cmsy-9">}</span><span 
565 class="cmtt-9">-ext.conf</span>.
566 <!--l. 333--><p class="noindent" >For example, if the firmware shall use the package feed built on the develoment
567 machine, which happens to be 192.168.1.1 and has a webserver configured to point to
568 <span 
569 class="cmtt-9">tmp/deploy/ipk</span>, a line like the following may be added:
570 <!--l. 337--><p class="noindent" ><span 
571 class="cmtt-9">DISTRO</span><span 
572 class="cmtt-9">_FEED</span><span 
573 class="cmtt-9">_URI = "http://192.168.1.1/$</span><span 
574 class="cmsy-9">{</span><span 
575 class="cmtt-9">DISTRO</span><span 
576 class="cmsy-9">}</span><span 
577 class="cmtt-9">/$</span><span 
578 class="cmsy-9">{</span><span 
579 class="cmtt-9">DISTRO</span><span 
580 class="cmtt-9">_VERSION</span><span 
581 class="cmsy-9">}</span><span 
582 class="cmtt-9">"</span>
583 <!--l. 339--><p class="noindent" >In general, any variable in OpenEmbedded that uses weak assignment (<span 
584 class="cmtt-9">?=</span>) may be
585 overridden from these files.
586 <!--l. 342--><p class="noindent" >The following sections list some commonly used options.
587 <!--l. 344--><p class="noindent" >
588 <h5 class="subsubsectionHead"><span class="titlemark">5.4.1   </span> <a 
589  id="x1-250005.4.1"></a>DISTRO_FEED_PREFIX</h5>
590 <!--l. 346--><p class="noindent" ><span 
591 class="cmtt-9">DISTRO</span><span 
592 class="cmtt-9">_FEED</span><span 
593 class="cmtt-9">_PREFIX </span>specifies the name of the package update feed. This name may be
594 arbitarily chosen.
595 <!--l. 349--><p class="noindent" >Default: <span 
596 class="cmtt-9">DISTRO</span><span 
597 class="cmtt-9">_FEED</span><span 
598 class="cmtt-9">_PREFIX = "remote"</span>
599 <!--l. 351--><p class="noindent" >
600 <h5 class="subsubsectionHead"><span class="titlemark">5.4.2   </span> <a 
601  id="x1-260005.4.2"></a>DISTRO_FEED_URI</h5>
602 <!--l. 353--><p class="noindent" ><span 
603 class="cmtt-9">DISTRO</span><span 
604 class="cmtt-9">_FEED</span><span 
605 class="cmtt-9">_URI </span>specifies the URI of the package update feed.
606 <!--l. 355--><p class="noindent" >Default: <span 
607 class="cmtt-9">DISTRO</span><span 
608 class="cmtt-9">_FEED</span><span 
609 class="cmtt-9">_URI = "http://my-distribution.example/remote-feed/"</span>
610 <!--l. 357--><p class="noindent" >
611 <h5 class="subsubsectionHead"><span class="titlemark">5.4.3   </span> <a 
612  id="x1-270005.4.3"></a>INHERIT</h5>
613 <!--l. 359--><p class="noindent" ><span 
614 class="cmtt-9">INHERIT </span>specifies bbclasses to include from a configuration file. Usually, this variable
615 gets appended to by using the <span 
616 class="cmtt-9">+= </span>operator.
617 <!--l. 362--><p class="noindent" >The OpenDreambox distribution automatically appends <span 
618 class="cmtt-9">"buildhistory recipe</span><span 
619 class="cmtt-9">_sanity</span>
620 <span 
621 class="cmtt-9">testlab" </span>to <span 
622 class="cmtt-9">INHERIT</span>.
623 <!--l. 364--><p class="noindent" >Default: <span 
624 class="cmtt-9">INHERIT = ""</span>
625 <!--l. 366--><p class="noindent" ><span 
626 class="cmbx-10">Some examples:</span>
627 <!--l. 368--><p class="noindent" >Always build the latest versions of OpenDreambox-related projects from
628 Git:
629 <!--l. 370--><p class="noindent" ><span 
630 class="cmtt-9">INHERIT += "opendreambox-autorev"</span>
631                                                                   
632
633                                                                   
634 <!--l. 372--><p class="noindent" >Remove temporary files of previous versions of a recipe before a newer version gets
635 built:
636 <!--l. 374--><p class="noindent" ><span 
637 class="cmtt-9">INHERIT += "rm</span><span 
638 class="cmtt-9">_old</span><span 
639 class="cmtt-9">_work"</span>
640 <!--l. 376--><p class="noindent" >Remove temporary files of a recipe after it has been built and packaged
641 successfully.
642 <!--l. 378--><p class="noindent" ><span 
643 class="cmtt-9">INHERIT += "rm</span><span 
644 class="cmtt-9">_work"</span>
645 <!--l. 380--><p class="noindent" >
646 <h4 class="subsectionHead"><span class="titlemark">5.5   </span> <a 
647  id="x1-280005.5"></a>Setting up a build directory</h4>
648 <!--l. 381--><p class="noindent" >To set up a build directory for e.g. <span 
649 class="cmbx-10">DM 500 HD </span>run <span 
650 class="cmtt-9">make MACHINE=dm500hd</span>. If
651 <span 
652 class="cmtt-9">MACHINE=dm500hd </span>has been set in <span 
653 class="cmtt-9">conf/make.conf</span>, you can simply run <span 
654 class="cmtt-9">make </span>with no
655 arguments instead. This will create and initialize the directory <span 
656 class="cmtt-9">build/dm500hd</span>.
657 <!--l. 385--><p class="noindent" >
658 <h4 class="subsectionHead"><span class="titlemark">5.6   </span> <a 
659  id="x1-290005.6"></a>Building a firmware image</h4>
660 <!--l. 386--><p class="noindent" >To build a firmware image for e.g. <span 
661 class="cmbx-10">DM 500 HD </span>run <span 
662 class="cmtt-9">make MACHINE=dm500hd image</span>. If
663 <span 
664 class="cmtt-9">MACHINE=dm500hd </span>has been set in <span 
665 class="cmtt-9">conf/make.conf</span>, you can simply run <span 
666 class="cmtt-9">make image</span>
667 instead.
668 <!--l. 390--><p class="noindent" >
669 <h4 class="subsectionHead"><span class="titlemark">5.7   </span> <a 
670  id="x1-300005.7"></a>Building a package</h4>
671 <!--l. 391--><p class="noindent" >To build a single package, BitBake has to be used directly. First, the environment has
672 to be set up, in order to make BitBake available to the shell. This can be done with
673 the following command:
674 <!--l. 395--><p class="noindent" ><span 
675 class="cmtt-9">source bitbake.env</span>
676 <!--l. 397--><p class="noindent" >BitBake must be run from the machine&#8217;s build directory. For <span 
677 class="cmbx-10">DM 500 HD</span>
678 run:
679 <!--l. 399--><p class="noindent" ><span 
680 class="cmtt-9">cd build/dm500hd</span>
681 <!--l. 401--><p class="noindent" >In order to build enigma2, run:
682 <!--l. 403--><p class="noindent" ><span 
683 class="cmtt-9">bitbake enigma2</span>.
684                                                                   
685
686                                                                   
687 <!--l. 405--><p class="noindent" >
688 <h3 class="sectionHead"><span class="titlemark">6   </span> <a 
689  id="x1-310006"></a>Development hints</h3>
690 <!--l. 407--><p class="noindent" >
691 <h4 class="subsectionHead"><span class="titlemark">6.1   </span> <a 
692  id="x1-320006.1"></a>Cross-compilation of external software</h4>
693 <!--l. 408--><p class="noindent" >OpenDreambox provides a script called <span 
694 class="cmtt-9">cross-compile.env</span>. Once run, the script will
695 create the following commands (shell aliases), aiming to ease cross-compilation of
696 external source trees:
697      <ul class="itemize1">
698      <li class="itemize"><span 
699 class="cmtt-9">oe</span><span 
700 class="cmtt-9">_autoreconf </span>- Calls OE&#8217;s version of <span 
701 class="cmtt-9">autoreconf</span>. Useful for projects based
702      on GNU autotools.
703      </li>
704      <li class="itemize"><span 
705 class="cmtt-9">oe</span><span 
706 class="cmtt-9">_runconf </span>- Calls <span 
707 class="cmtt-9">./configure </span>with parameters suitable for OE. Useful
708      for projects based on GNU autotools.
709      </li>
710      <li class="itemize"><span 
711 class="cmtt-9">oe</span><span 
712 class="cmtt-9">_runmake </span>-  Calls  <span 
713 class="cmtt-9">make </span>with  parameters  suitable  for  OE.  Useful  for
714      projects based on GNU autotools or GNU make.
715      </li>
716      <li class="itemize"><span 
717 class="cmtt-9">oe</span><span 
718 class="cmtt-9">_env </span>- Useful to execute arbitrary commands in the OE environment
719      (e.g. <span 
720 class="cmtt-9">oe</span><span 
721 class="cmtt-9">_env env</span>).
722      </li>
723      <li class="itemize"><span 
724 class="cmtt-9">oe</span><span 
725 class="cmtt-9">_setenv </span>- Exports the OE environment to the currently running shell
726      session.</li></ul>
727 <!--l. 419--><p class="noindent" >The script needs to know the target machine, which can be one of the supported
728 products (see <a 
729 href="#x1-40001.2">1.2<!--tex4ht:ref: products --></a>). Because the script adds aliases to your currently running shell
730 session, it has to be invoked using <span 
731 class="cmtt-9">source </span>or <span 
732 class="cmtt-9">. </span>(the dot operator), e.g.:
733 <!--l. 422--><p class="noindent" ><span 
734 class="cmtt-9">source cross-compile.env dm7020hd</span>
735 <!--l. 424--><p class="noindent" >The script may be called from any location, but must reside inside the OpenDreambox
736 Git tree. You may want to create a symlink to <span 
737 class="cmtt-9">cross-compile.env </span>somewhere in your
738 <span 
739 class="cmtt-9">PATH</span>.
740 <!--l. 427--><p class="noindent" >
741 <h4 class="subsectionHead"><span class="titlemark">6.2   </span> <a 
742  id="x1-330006.2"></a>Coding style</h4>
743 <!--l. 428--><p class="noindent" >Run <span 
744 class="cmtt-9">scripts/do</span><span 
745 class="cmtt-9">_stylize.sh </span>on new recipes to ensure proper coding style.
746                                                                   
747
748                                                                   
749 <!--l. 430--><p class="noindent" >
750 <h4 class="subsectionHead"><span class="titlemark">6.3   </span> <a 
751  id="x1-340006.3"></a>Package architecture</h4>
752 <!--l. 431--><p class="noindent" >Set <span 
753 class="cmtt-9">PACKAGE</span><span 
754 class="cmtt-9">_ARCH = "$</span><span 
755 class="cmsy-9">{</span><span 
756 class="cmtt-9">MACHINE</span><span 
757 class="cmtt-9">_ARCH</span><span 
758 class="cmsy-9">}</span><span 
759 class="cmtt-9">" </span>if either condition is met:
760      <ul class="itemize1">
761      <li class="itemize">The     recipe     uses     <span 
762 class="cmtt-9">COMBINED</span><span 
763 class="cmtt-9">_FEATURES</span>,     <span 
764 class="cmtt-9">MACHINE</span><span 
765 class="cmtt-9">_FEATURES    </span>or
766      <span 
767 class="cmtt-9">DREAMBOX</span><span 
768 class="cmtt-9">_FEATURES</span>.
769      </li>
770      <li class="itemize">The recipe is part of <span 
771 class="cmtt-9">meta-bsp</span>.</li></ul>
772 <!--l. 437--><p class="noindent" >
773 <h3 class="sectionHead"><span class="titlemark">7   </span> <a 
774  id="x1-350007"></a>Bug reports and patches</h3>
775 <!--l. 439--><p class="noindent" >Please send bug reports and patches to the Enigma2 development mailing list
776 <span 
777 class="cmtt-9">&#x003C;enigma2-devel@lists.elitedvb.net&#x003E;</span>.
778 <!--l. 441--><p class="noindent" >A comfortable way to create patches is to use <span 
779 class="cmtt-9">git format-patch</span>, after all changes
780 have been committed to your local copy of the repository.
781  
782 </body></html> 
783
784                                                                   
785
786