summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/yocto-project-qs/Makefile32
-rwxr-xr-xdocumentation/yocto-project-qs/figures/building-an-image.pngbin0 -> 13954 bytes
-rwxr-xr-xdocumentation/yocto-project-qs/figures/cropped-yocto-project-bw.pngbin0 -> 5453 bytes
-rwxr-xr-xdocumentation/yocto-project-qs/figures/using-a-pre-built-image.pngbin0 -> 12131 bytes
-rwxr-xr-xdocumentation/yocto-project-qs/figures/white-on-black.pngbin0 -> 18296 bytes
-rwxr-xr-xdocumentation/yocto-project-qs/figures/yocto-environment.pngbin0 -> 62764 bytes
-rwxr-xr-xdocumentation/yocto-project-qs/figures/yocto-project-transp.pngbin0 -> 8626 bytes
-rw-r--r--documentation/yocto-project-qs/style.css963
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs-customization.xsl8
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs.xml307
10 files changed, 1310 insertions, 0 deletions
diff --git a/documentation/yocto-project-qs/Makefile b/documentation/yocto-project-qs/Makefile
new file mode 100644
index 0000000000..9f45058c51
--- /dev/null
+++ b/documentation/yocto-project-qs/Makefile
@@ -0,0 +1,32 @@
1XSLTOPTS = --stringparam html.stylesheet style.css \
2 --xinclude
3
4XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
5XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
6
7all: html tarball
8
9##
10# These URI should be rewritten by your distribution's xml catalog to
11# match your localy installed XSL stylesheets.
12
13html:
14# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
15
16# xsltproc $(XSLTOPTS) -o yocto-project-qs.html $(XSL_XHTML_URI) yocto-project-qs.xml
17 xsltproc $(XSLTOPTS) -o yocto-project-qs.html yocto-project-qs-customization.xsl yocto-project-qs.xml
18
19tarball: html
20 tar -cvzf yocto-project-qs.tgz yocto-project-qs.html style.css figures/yocto-environment.png figures/building-an-image.png figures/using-a-pre-built-image.png figures/yocto-project-transp.png
21
22validate:
23 xmllint --postvalid --xinclude --noout yocto-project-qs.xml
24
25OUTPUTS = yocto-project-qs.tgz yocto-project-qs.html
26SOURCES = *.png *.xml *.css
27
28publish:
29 scp -r $(OUTPUTS) $(SOURCES) o-hand.com:/srv/www/pokylinux.org/doc/
30
31clean:
32 rm -f $(OUTPUTS)
diff --git a/documentation/yocto-project-qs/figures/building-an-image.png b/documentation/yocto-project-qs/figures/building-an-image.png
new file mode 100755
index 0000000000..eb0ee07a4c
--- /dev/null
+++ b/documentation/yocto-project-qs/figures/building-an-image.png
Binary files differ
diff --git a/documentation/yocto-project-qs/figures/cropped-yocto-project-bw.png b/documentation/yocto-project-qs/figures/cropped-yocto-project-bw.png
new file mode 100755
index 0000000000..561333b146
--- /dev/null
+++ b/documentation/yocto-project-qs/figures/cropped-yocto-project-bw.png
Binary files differ
diff --git a/documentation/yocto-project-qs/figures/using-a-pre-built-image.png b/documentation/yocto-project-qs/figures/using-a-pre-built-image.png
new file mode 100755
index 0000000000..2e8f295ad6
--- /dev/null
+++ b/documentation/yocto-project-qs/figures/using-a-pre-built-image.png
Binary files differ
diff --git a/documentation/yocto-project-qs/figures/white-on-black.png b/documentation/yocto-project-qs/figures/white-on-black.png
new file mode 100755
index 0000000000..075b4f2949
--- /dev/null
+++ b/documentation/yocto-project-qs/figures/white-on-black.png
Binary files differ
diff --git a/documentation/yocto-project-qs/figures/yocto-environment.png b/documentation/yocto-project-qs/figures/yocto-environment.png
new file mode 100755
index 0000000000..a3bf23e9c4
--- /dev/null
+++ b/documentation/yocto-project-qs/figures/yocto-environment.png
Binary files differ
diff --git a/documentation/yocto-project-qs/figures/yocto-project-transp.png b/documentation/yocto-project-qs/figures/yocto-project-transp.png
new file mode 100755
index 0000000000..31d2b147fd
--- /dev/null
+++ b/documentation/yocto-project-qs/figures/yocto-project-transp.png
Binary files differ
diff --git a/documentation/yocto-project-qs/style.css b/documentation/yocto-project-qs/style.css
new file mode 100644
index 0000000000..2abfa7b5bb
--- /dev/null
+++ b/documentation/yocto-project-qs/style.css
@@ -0,0 +1,963 @@
1/*
2 Generic XHTML / DocBook XHTML CSS Stylesheet.
3
4 Browser wrangling and typographic design by
5 Oyvind Kolas / pippin@gimp.org
6
7 Customised for Poky by
8 Matthew Allum / mallum@o-hand.com
9
10 Thanks to:
11 Liam R. E. Quin
12 William Skaggs
13 Jakub Steiner
14
15 Structure
16 ---------
17
18 The stylesheet is divided into the following sections:
19
20 Positioning
21 Margins, paddings, width, font-size, clearing.
22 Decorations
23 Borders, style
24 Colors
25 Colors
26 Graphics
27 Graphical backgrounds
28 Nasty IE tweaks
29 Workarounds needed to make it work in internet explorer,
30 currently makes the stylesheet non validating, but up until
31 this point it is validating.
32 Mozilla extensions
33 Transparency for footer
34 Rounded corners on boxes
35
36*/
37
38
39 /*************** /
40 / Positioning /
41/ ***************/
42
43body {
44 font-family: Verdana, Sans, sans-serif;
45
46 min-width: 640px;
47 width: 80%;
48 margin: 0em auto;
49 padding: 2em 5em 5em 5em;
50 color: #333;
51}
52
53h1,h2,h3,h4,h5,h6,h7 {
54 font-family: Arial, Sans;
55 color:#999999;
56 clear: both;
57}
58
59h1 {
60 font-size: 2em;
61 text-align: left;
62 padding: 0em 0em 0em 0em;
63 margin: 2em 0em 0em 0em;
64}
65
66h2.subtitle {
67 margin: 0.10em 0em 3.0em 0em;
68 padding: 0em 0em 0em 0em;
69 font-size: 1.8em;
70 padding-left: 20%;
71 font-weight: normal;
72 font-style: italic;
73}
74
75h2 {
76 margin: 2em 0em 0.66em 0em;
77 padding: 0.5em 0em 0em 0em;
78 font-size: 1.5em;
79 font-weight: normal;
80}
81
82h3.subtitle {
83 margin: 0em 0em 1em 0em;
84 padding: 0em 0em 0em 0em;
85 font-size: 142.14%;
86 text-align: right;
87}
88
89h3 {
90 margin: 1em 0em 0.5em 0em;
91 padding: 1em 0em 0em 0em;
92 font-size: 140%;
93 font-weight: normal;
94}
95
96h4 {
97 margin: 1em 0em 0.5em 0em;
98 padding: 1em 0em 0em 0em;
99 font-size: 120%;
100 font-weight: normal;
101}
102
103h5 {
104 margin: 1em 0em 0.5em 0em;
105 padding: 1em 0em 0em 0em;
106 font-size: 110.000%;
107 border-bottom: 1px solid black;
108}
109
110h6 {
111 margin: 1em 0em 0em 0em;
112 padding: 1em 0em 0em 0em;
113 font-size: 80%;
114 font-weight: normal;
115}
116
117.authorgroup {
118 background-color: transparent;
119 background-repeat: no-repeat;
120 padding-top: 256px;
121 background-image: url("../figures/yocto-project-bw.png");
122 background-position: top;
123 margin-top: -256px;
124 padding-right: 50px;
125 margin-left: 50px;
126 text-align: center;
127 width: 600px;
128}
129
130h3.author {
131 margin: 0em 0me 0em 0em;
132 padding: 0em 0em 0em 0em;
133 font-weight: normal;
134 font-size: 100%;
135 clear: both;
136}
137
138.author tt.email {
139 font-size: 66%;
140}
141
142.titlepage hr {
143 width: 0em;
144 clear: both;
145}
146
147.revhistory {
148 padding-top: 2em;
149 clear: both;
150}
151
152.toc,
153.list-of-tables,
154.list-of-examples,
155.list-of-figures {
156 padding: 1.33em 0em 2.5em 0em;
157}
158
159.toc p,
160.list-of-tables p,
161.list-of-figures p,
162.list-of-examples p {
163 padding: 0em 0em 0em 0em;
164 padding: 0em 0em 0.3em;
165 margin: 1.5em 0em 0em 0em;
166}
167
168.toc p b,
169.list-of-tables p b,
170.list-of-figures p b,
171.list-of-examples p b{
172 font-size: 100.0%;
173 font-weight: bold;
174}
175
176.toc dl,
177.list-of-tables dl,
178.list-of-figures dl,
179.list-of-examples dl {
180 margin: 0em 0em 0.5em 0em;
181 padding: 0em 0em 0em 0em;
182}
183
184.toc dt {
185 margin: 0em 0em 0em 0em;
186 padding: 0em 0em 0em 0em;
187}
188
189.toc dd {
190 margin: 0em 0em 0em 2.6em;
191 padding: 0em 0em 0em 0em;
192}
193
194div.glossary dl,
195div.variablelist dl {
196}
197
198.glossary dl dt,
199.variablelist dl dt,
200.variablelist dl dt span.term {
201 font-weight: normal;
202 width: 20em;
203 text-align: right;
204}
205
206.variablelist dl dt {
207 margin-top: 0.5em;
208}
209
210.glossary dl dd,
211.variablelist dl dd {
212 margin-top: -1em;
213 margin-left: 25.5em;
214}
215
216.glossary dd p,
217.variablelist dd p {
218 margin-top: 0em;
219 margin-bottom: 1em;
220}
221
222
223div.calloutlist table td {
224 padding: 0em 0em 0em 0em;
225 margin: 0em 0em 0em 0em;
226}
227
228div.calloutlist table td p {
229 margin-top: 0em;
230 margin-bottom: 1em;
231}
232
233div p.copyright {
234 text-align: left;
235}
236
237div.legalnotice p.legalnotice-title {
238 margin-bottom: 0em;
239}
240
241p {
242 line-height: 1.5em;
243 margin-top: 0em;
244 color: black; font-size: 100%;
245
246}
247
248dl {
249 padding-top: 0em;
250}
251
252hr {
253 border: solid 1px;
254}
255
256
257.mediaobject,
258.mediaobjectco {
259 text-align: center;
260}
261
262img {
263 border: none;
264}
265
266ul {
267 padding: 0em 0em 0em 1.5em;
268}
269
270ul li {
271 padding: 0em 0em 0em 0em;
272}
273
274ul li p {
275 text-align: left;
276}
277
278table {
279 width :100%;
280}
281
282th {
283 padding: 0.25em;
284 text-align: left;
285 font-weight: normal;
286 vertical-align: top;
287}
288
289td {
290 padding: 0.25em;
291 vertical-align: top;
292}
293
294p a[id] {
295 margin: 0px;
296 padding: 0px;
297 display: inline;
298 background-image: none;
299}
300
301a {
302 text-decoration: underline;
303 color: #444;
304}
305
306pre {
307 overflow: auto;
308}
309
310a:hover {
311 text-decoration: underline;
312 /*font-weight: bold;*/
313}
314
315
316div.informalfigure,
317div.informalexample,
318div.informaltable,
319div.figure,
320div.table,
321div.example {
322 margin: 1em 0em;
323 padding: 1em;
324 page-break-inside: avoid;
325}
326
327
328div.informalfigure p.title b,
329div.informalexample p.title b,
330div.informaltable p.title b,
331div.figure p.title b,
332div.example p.title b,
333div.table p.title b{
334 padding-top: 0em;
335 margin-top: 0em;
336 font-size: 100%;
337 font-weight: normal;
338}
339
340.mediaobject .caption,
341.mediaobject .caption p {
342 text-align: center;
343 font-size: 80%;
344 padding-top: 0.5em;
345 padding-bottom: 0.5em;
346}
347
348.epigraph {
349 padding-left: 55%;
350 margin-bottom: 1em;
351}
352
353.epigraph p {
354 text-align: left;
355}
356
357.epigraph .quote {
358 font-style: italic;
359}
360.epigraph .attribution {
361 font-style: normal;
362 text-align: right;
363}
364
365span.application {
366 font-style: italic;
367}
368
369.programlisting {
370 font-family: monospace;
371 font-size: 80%;
372 white-space: pre;
373 margin: 1.33em 0em;
374 padding: 1.33em;
375}
376
377.tip,
378.warning,
379.caution,
380.note {
381 margin-top: 1em;
382 margin-bottom: 1em;
383
384}
385
386/* force full width of table within div */
387.tip table,
388.warning table,
389.caution table,
390.note table {
391 border: none;
392 width: 100%;
393}
394
395
396.tip table th,
397.warning table th,
398.caution table th,
399.note table th {
400 padding: 0.8em 0.0em 0.0em 0.0em;
401 margin : 0em 0em 0em 0em;
402}
403
404.tip p,
405.warning p,
406.caution p,
407.note p {
408 margin-top: 0.5em;
409 margin-bottom: 0.5em;
410 padding-right: 1em;
411 text-align: left;
412}
413
414.acronym {
415 text-transform: uppercase;
416}
417
418b.keycap,
419.keycap {
420 padding: 0.09em 0.3em;
421 margin: 0em;
422}
423
424.itemizedlist li {
425 clear: none;
426}
427
428.filename {
429 font-size: medium;
430 font-family: Courier, monospace;
431}
432
433
434div.navheader, div.heading{
435 position: absolute;
436 left: 0em;
437 top: 0em;
438 width: 100%;
439 background-color: #cdf;
440 width: 100%;
441}
442
443div.navfooter, div.footing{
444 position: fixed;
445 left: 0em;
446 bottom: 0em;
447 background-color: #eee;
448 width: 100%;
449}
450
451
452div.navheader td,
453div.navfooter td {
454 font-size: 66%;
455}
456
457div.navheader table th {
458 /*font-family: Georgia, Times, serif;*/
459 /*font-size: x-large;*/
460 font-size: 80%;
461}
462
463div.navheader table {
464 border-left: 0em;
465 border-right: 0em;
466 border-top: 0em;
467 width: 100%;
468}
469
470div.navfooter table {
471 border-left: 0em;
472 border-right: 0em;
473 border-bottom: 0em;
474 width: 100%;
475}
476
477div.navheader table td a,
478div.navfooter table td a {
479 color: #777;
480 text-decoration: none;
481}
482
483/* normal text in the footer */
484div.navfooter table td {
485 color: black;
486}
487
488div.navheader table td a:visited,
489div.navfooter table td a:visited {
490 color: #444;
491}
492
493
494/* links in header and footer */
495div.navheader table td a:hover,
496div.navfooter table td a:hover {
497 text-decoration: underline;
498 background-color: transparent;
499 color: #33a;
500}
501
502div.navheader hr,
503div.navfooter hr {
504 display: none;
505}
506
507
508.qandaset tr.question td p {
509 margin: 0em 0em 1em 0em;
510 padding: 0em 0em 0em 0em;
511}
512
513.qandaset tr.answer td p {
514 margin: 0em 0em 1em 0em;
515 padding: 0em 0em 0em 0em;
516}
517.answer td {
518 padding-bottom: 1.5em;
519}
520
521.emphasis {
522 font-weight: bold;
523}
524
525
526 /************* /
527 / decorations /
528/ *************/
529
530.titlepage {
531}
532
533.part .title {
534}
535
536.subtitle {
537 border: none;
538}
539
540/*
541h1 {
542 border: none;
543}
544
545h2 {
546 border-top: solid 0.2em;
547 border-bottom: solid 0.06em;
548}
549
550h3 {
551 border-top: 0em;
552 border-bottom: solid 0.06em;
553}
554
555h4 {
556 border: 0em;
557 border-bottom: solid 0.06em;
558}
559
560h5 {
561 border: 0em;
562}
563*/
564
565.programlisting {
566 border: solid 1px;
567}
568
569div.figure,
570div.table,
571div.informalfigure,
572div.informaltable,
573div.informalexample,
574div.example {
575 border: 1px solid;
576}
577
578
579
580.tip,
581.warning,
582.caution,
583.note {
584 border: 1px solid;
585}
586
587.tip table th,
588.warning table th,
589.caution table th,
590.note table th {
591 border-bottom: 1px solid;
592}
593
594.question td {
595 border-top: 1px solid black;
596}
597
598.answer {
599}
600
601
602b.keycap,
603.keycap {
604 border: 1px solid;
605}
606
607
608div.navheader, div.heading{
609 border-bottom: 1px solid;
610}
611
612
613div.navfooter, div.footing{
614 border-top: 1px solid;
615}
616
617 /********* /
618 / colors /
619/ *********/
620
621body {
622 color: #333;
623 background: white;
624}
625
626a {
627 background: transparent;
628}
629
630a:hover {
631 background-color: #dedede;
632}
633
634
635h1,
636h2,
637h3,
638h4,
639h5,
640h6,
641h7,
642h8 {
643 background-color: transparent;
644}
645
646hr {
647 border-color: #aaa;
648}
649
650
651.tip, .warning, .caution, .note {
652 border-color: #aaa;
653}
654
655
656.tip table th,
657.warning table th,
658.caution table th,
659.note table th {
660 border-bottom-color: #aaa;
661}
662
663
664.warning {
665 background-color: #fea;
666}
667
668.caution {
669 background-color: #fea;
670}
671
672.tip {
673 background-color: #eff;
674}
675
676.note {
677 background-color: #dfc;
678}
679
680.glossary dl dt,
681.variablelist dl dt,
682.variablelist dl dt span.term {
683 color: #044;
684}
685
686div.figure,
687div.table,
688div.example,
689div.informalfigure,
690div.informaltable,
691div.informalexample {
692 border-color: #aaa;
693}
694
695pre.programlisting {
696 color: black;
697 background-color: #fff;
698 border-color: #aaa;
699 border-width: 2px;
700}
701
702.guimenu,
703.guilabel,
704.guimenuitem {
705 background-color: #eee;
706}
707
708
709b.keycap,
710.keycap {
711 background-color: #eee;
712 border-color: #999;
713}
714
715
716div.navheader {
717 border-color: black;
718}
719
720
721div.navfooter {
722 border-color: black;
723}
724
725
726 /*********** /
727 / graphics /
728/ ***********/
729
730/*
731body {
732 background-image: url("images/body_bg.jpg");
733 background-attachment: fixed;
734}
735
736.navheader,
737.note,
738.tip {
739 background-image: url("images/note_bg.jpg");
740 background-attachment: fixed;
741}
742
743.warning,
744.caution {
745 background-image: url("images/warning_bg.jpg");
746 background-attachment: fixed;
747}
748
749.figure,
750.informalfigure,
751.example,
752.informalexample,
753.table,
754.informaltable {
755 background-image: url("images/figure_bg.jpg");
756 background-attachment: fixed;
757}
758
759*/
760h1,
761h2,
762h3,
763h4,
764h5,
765h6,
766h7{
767}
768
769/*
770Example of how to stick an image as part of the title.
771
772div.article .titlepage .title
773{
774 background-image: url("figures/white-on-black.png");
775 background-position: center;
776 background-repeat: repeat-x;
777}
778*/
779
780div.preface .titlepage .title,
781div.colophon .title,
782div.chapter .titlepage .title,
783div.article .titlepage .title
784{
785}
786
787div.section div.section .titlepage .title,
788div.sect2 .titlepage .title {
789 background: none;
790}
791
792
793h1.title {
794 background-color: transparent;
795 background-image: url("figures/yocto-project-bw.png");
796 background-repeat: no-repeat;
797 height: 256px;
798 text-indent: -9000px;
799 overflow:hidden;
800}
801
802h2.subtitle {
803 background-color: transparent;
804 text-indent: -9000px;
805 overflow:hidden;
806 width: 0px;
807 display: none;
808}
809
810 /*************************************** /
811 / pippin.gimp.org specific alterations /
812/ ***************************************/
813
814/*
815div.heading, div.navheader {
816 color: #777;
817 font-size: 80%;
818 padding: 0;
819 margin: 0;
820 text-align: left;
821 position: absolute;
822 top: 0px;
823 left: 0px;
824 width: 100%;
825 height: 50px;
826 background: url('/gfx/heading_bg.png') transparent;
827 background-repeat: repeat-x;
828 background-attachment: fixed;
829 border: none;
830}
831
832div.heading a {
833 color: #444;
834}
835
836div.footing, div.navfooter {
837 border: none;
838 color: #ddd;
839 font-size: 80%;
840 text-align:right;
841
842 width: 100%;
843 padding-top: 10px;
844 position: absolute;
845 bottom: 0px;
846 left: 0px;
847
848 background: url('/gfx/footing_bg.png') transparent;
849}
850*/
851
852
853
854 /****************** /
855 / nasty ie tweaks /
856/ ******************/
857
858/*
859div.heading, div.navheader {
860 width:expression(document.body.clientWidth + "px");
861}
862
863div.footing, div.navfooter {
864 width:expression(document.body.clientWidth + "px");
865 margin-left:expression("-5em");
866}
867body {
868 padding:expression("4em 5em 0em 5em");
869}
870*/
871
872 /**************************************** /
873 / mozilla vendor specific css extensions /
874/ ****************************************/
875/*
876div.navfooter, div.footing{
877 -moz-opacity: 0.8em;
878}
879
880div.figure,
881div.table,
882div.informalfigure,
883div.informaltable,
884div.informalexample,
885div.example,
886.tip,
887.warning,
888.caution,
889.note {
890 -moz-border-radius: 0.5em;
891}
892
893b.keycap,
894.keycap {
895 -moz-border-radius: 0.3em;
896}
897*/
898
899table tr td table tr td {
900 display: none;
901}
902
903
904hr {
905 display: none;
906}
907
908table {
909 border: 0em;
910}
911
912 .photo {
913 float: right;
914 margin-left: 1.5em;
915 margin-bottom: 1.5em;
916 margin-top: 0em;
917 max-width: 17em;
918 border: 1px solid gray;
919 padding: 3px;
920 background: white;
921}
922 .seperator {
923 padding-top: 2em;
924 clear: both;
925 }
926
927 #validators {
928 margin-top: 5em;
929 text-align: right;
930 color: #777;
931 }
932 @media print {
933 body {
934 font-size: 8pt;
935 }
936 .noprint {
937 display: none;
938 }
939 }
940
941
942.tip,
943.note {
944 background: #91ae35;
945 color: #fff;
946 padding: 20px;
947 margin: 20px;
948}
949
950.tip h3,
951.note h3 {
952 padding: 0em;
953 margin: 0em;
954 font-size: 2em;
955 font-weight: bold;
956 color: #fff;
957}
958
959.tip a,
960.note a {
961 color: #fff;
962 text-decoration: underline;
963}
diff --git a/documentation/yocto-project-qs/yocto-project-qs-customization.xsl b/documentation/yocto-project-qs/yocto-project-qs-customization.xsl
new file mode 100644
index 0000000000..8e6ea34dd4
--- /dev/null
+++ b/documentation/yocto-project-qs/yocto-project-qs-customization.xsl
@@ -0,0 +1,8 @@
1<?xml version='1.0'?>
2<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0">
3
4 <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" />
5
6 <xsl:param name="generate.toc" select="'article nop'"></xsl:param>
7
8</xsl:stylesheet>
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml
new file mode 100644
index 0000000000..d67ff41edc
--- /dev/null
+++ b/documentation/yocto-project-qs/yocto-project-qs.xml
@@ -0,0 +1,307 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
3
4<article id='intro'>
5 <imagedata fileref="figures/yocto-project-transp.png" width="6in" depth="1in" align="right" scale="25" />
6
7<section id='fake-title'>
8 <title>Yocto Project Quick Start</title>
9</section>
10
11<section id='welcome'>
12 <title>Welcome!</title>
13 <para>
14 Welcome to the Yocto Project!
15 The Yocto Project is an open-source Linux development environment.
16 This short document will give you some basic information about the environment as well as let you experience it in its simplest form.
17 After reading this document you will have a basic understanding of what the Yocto Project is and how to work within it.
18 This document also steps you through a simple example showing you how to build a small image and run it using the QEMU emulator.
19 </para>
20 <para>
21 For complete information on the Yocto Project you should check out the <ulink url='http://www.yoctolinux.org'>Public Yocto Website</ulink>.
22 You can find the latest builds, breaking news, full development documentation, and a rich Yocto Project Development Community into which you can tap.
23 </para>
24</section>
25
26<section id='yp-intro'>
27 <title>Introducing the Yocto Project Development Environment</title>
28
29 <para>
30 Yocto Project is an open source development environment that creates Linux-based images suitable for many types of devices (large or small) based on architectures such as x86, x86-64, Xeon, ARM, and MIPS as well as PowerPC and device emulation.
31 You can use Yocto Project to design, develop, build, debug, simulate, and test the complete software stack using Linux, the X Window System, GNOME Mobile-based application frameworks, and Qt frameworks.
32 </para>
33
34 <para></para>
35 <para></para>
36
37 <mediaobject>
38 <imageobject>
39 <imagedata fileref="figures/yocto-environment.png" format="PNG" align='center' scalefit='1'/>
40 </imageobject>
41 <caption>
42 <para>The Yocto Project Development Environment</para>
43 </caption>
44 </mediaobject>
45
46 <para>
47 Yocto Project:
48 </para>
49
50 <itemizedlist>
51 <listitem>
52 <para>Provides an open source Linux kernel along with a set of system commands and libraries suitable for the embedded environment.</para>
53 </listitem>
54 <listitem>
55 <para>Makes available system components such as X11, Matchbox, GTK+, Pimlico, Clutter, and Qt (among others) so you can create a richer user interface experience on devices that use displays or have a GUI.
56For devices that don't have a GUI or display you simply would not employ these components.</para>
57 </listitem>
58 <listitem>
59 <para>Creates a focused and stable subset of OpenEmbedded on which you can easily and reliably build and develop.</para>
60 </listitem>
61 <listitem>
62 <para>Fully supports a wide range of hardware and device emulation through the QEMU Emulator or other supported emulators.</para>
63 </listitem>
64 </itemizedlist>
65
66 <para>
67 Yocto Project generates file system images based on open source software such as the Kdrive X server, the Matchbox Window Manager, the GTK+ Toolkit and the D-Bus Message Bus System.
68 Yocto Project can generate images for many kinds of devices.
69 However, the standard example machines target QEMU full system emulation for x86, ARM, MIPS, and PPC based architectures as well as specific hardware such as the Intel Desktop Board DH55TC.
70 Because an image developed with Yocto Project can boot inside a QEMU emulator, the development environment works nicely as a test platform for developing embedded software.
71 </para>
72
73 <para>
74 Another important Yocto Project feature is the Sato component.
75 The optional Sato component, a GNOME mobile-based user interface environment well suited for devices with restricted screen sizes, sits neatly on top of any device using the GNOME Mobile Stack providing a well defined user experience.
76 </para>
77</section>
78
79<section id='resources'>
80 <title>What You Need and How You Get It</title>
81
82 <para>
83 You need these things to develop in the Yocto Project environment:
84 </para>
85
86 <itemizedlist>
87 <listitem>
88 <para>A host system running a supported Linux distribution.
89 For information on distributions on which you can use Yocto Project refer to the information found at <ulink url='http://wiki.openembedded.net/index.php/OEandYourDistro'>http://wiki.openembedded.net/index.php/OEandYourDistro</ulink>.</para>
90 </listitem>
91 <listitem>
92 <para>The right packages.</para>
93 </listitem>
94 <listitem>
95 <para>A release of Yocto Project.</para>
96 </listitem>
97 </itemizedlist>
98
99 <section id='the-linux-distro'>
100 <title>The Linux Distribution</title>
101
102 <para>
103 While this document assumes a Debian-based host system you can develop in the Yocto Linux environment using many other Linux distributions.
104 For Debian-based systems we recommend you use the Ubuntu Release 10.04 or later.
105 </para>
106 </section>
107
108 <section id='packages'>
109 <title>The Packages</title>
110
111 <para>
112 The packages you need for a Debian-based host are shown in the following command:
113 </para>
114
115 <literallayout class='monospaced'>
116 Sudo apt-get install sed wget cvs subversion git-core coreutils
117 unzip texi2html texinfo libsdll.2-dev docbook-utils gawk
118 python-pysqlite2 diffstat help2man make gcc build-essential
119 g++ desktop-file-utils chrpath libgl1-mesa-dev libglu1-mesa-dev
120 libsdl1.2-dev
121 </literallayout>
122
123 <para>
124 <emphasis>NOTE:</emphasis> Packages vary in number and name for other Linux distributions.
125 For package requirements on other Linux distributions refer to the information found at <ulink url='http://wiki.openembedded.net/index.php/OEandYourDistro'>http://wiki.openembedded.net/index.php/OEandYourDistro</ulink>.
126 </para>
127 </section>
128
129 <section id='releases'>
130 <title>Yocto Project Release</title>
131
132 <para>
133 The latest releases for Yocto Project are kept at http://yoctoproject.org/releases.
134 Nightly and developmental builds are also maintained. However, for this document a released version of Yocto Project is used.
135 </para>
136 </section>
137</section>
138
139<section id='test-run'>
140 <title>A Quick Test Run</title>
141
142 <para>
143 Now that you have your system requirements in order you can give Yocto Project a try.
144 This section presents some steps that let you do the following:
145 </para>
146
147 <itemizedlist>
148 <listitem>
149 <para>Build an image and run it in the emulator</para>
150 </listitem>
151 <listitem>
152 <para>Or, use a pre-built image and run it in the emulator</para>
153 </listitem>
154 </itemizedlist>
155
156 <section id='building-image'>
157 <title>Building an Image</title>
158
159 <para>
160 In the development environment you will need to build an image whenever you change hardware support, add or change system libraries, or add or change services that have dependencies.
161 </para>
162
163 <mediaobject>
164 <imageobject>
165 <imagedata fileref="figures/building-an-image.png" format="PNG" align='center' scalefit='1'/>
166 </imageobject>
167 <caption>
168 <para>Building an Image</para>
169 </caption>
170 </mediaobject>
171
172 <para>
173 Use the following commands from a shell on your Debian-based host to build your image.
174 The build creates an entire Linux system including the Toolchain from the source.
175 </para>
176
177 <para><emphasis>NOTE:</emphasis> The build process using Sato currently consumes 50GB of disk space.
178 To allow for vbariations in the build process and for future package expansion we recommend 100GB of free disk space.
179 </para>
180
181 <para>
182 <literallayout class='monospaced'>
183 $ wget http://pokylinux.org/releases/poky-green-3.3.tar.bz2
184 $ tar xjvf poky-green-3.3.tar.bz2
185 $ cd green-3.3-build
186 $ source green-3.3/poky-init-build-env green-3.3-build
187 $ bitbake qemu-native
188 $ bitbake poky-image-sato
189 $ poky-qemu qemux86
190 </literallayout>
191 </para>
192
193 <para>
194 Here is some explanation for these commands:
195 </para>
196
197 <itemizedlist>
198 <listitem>
199 <para>
200 The first two commands extract the Yocto Project files from the release area and place them into your build area (green-3.3-build in this example).
201 </para>
202 </listitem>
203 <listitem>
204 <para>
205 After changing to the build directory the source command sets up the Yocto Project build environment.
206 The build directory contains all the object files used during the build.
207 The default build directory is poky-dir/build.
208 </para>
209 </listitem>
210 <listitem>
211 <para>
212 The two bitbake commands build the OS image and the emulator for the target.
213 Here poky-image-sato is the name of the target. The qemu-native target is the customized QEMU Emulator.</para>
214 </listitem>
215 <listitem>
216 <para>
217 Finally, the poky-qemu command launches the customized QEMU.
218 </para>
219 </listitem>
220 </itemizedlist>
221 </section>
222
223 <section id='using-pre-built'>
224 <title>Using a Pre-Built Linux Kernel for QEMU</title>
225 <para>
226 If hardware, libraries and services are stable you can use a pre-built image of the kernel and just run it on the target using the emulator QEMU.
227 This situation is perfect for developing application software.
228 </para>
229
230 <para></para>
231 <para></para>
232 <para></para>
233
234 <mediaobject>
235 <imageobject>
236 <imagedata fileref="figures/using-a-pre-built-image.png" format="PNG" align='center' scalefit='1'/>
237 </imageobject>
238 <caption>
239 <para>Using a Pre-Built Image</para>
240 </caption>
241 </mediaobject>
242
243 <para>
244 For this scenario you need to do three things:
245 </para>
246
247 <itemizedlist>
248 <listitem>
249 <para>
250 Install the Yocto Project Scripts
251 </para>
252 </listitem>
253 <listitem>
254 <para>
255 Download the pre-built kernel that will run on QEMU.
256 You need to be sure to get the QEMU image that matches your target machine’s architecture (e.g. x86, ARM, etc.).
257 </para>
258 </listitem>
259 <listitem>
260 <para>
261 Download and decompress the file image system.
262 </para>
263 </listitem>
264 </itemizedlist>
265
266 <para>
267 Use this command to install the patched Yocto Project QEMU scripts:
268 </para>
269
270 <para>
271 <literallayout class='monospaced'>
272 $ apt-get install qemu poky-scripts
273 </literallayout>
274 </para>
275
276 <para>
277 You can download the pre-built Linux kernel and the file image system from <ulink url='http://pokylinux.org/releases/blinky-3.0'></ulink>.
278 The kernel and file image system have the following forms, respectively:
279 </para>
280
281 <literallayout class='monospaced'>
282 *zImage*qemu*.bin
283 poky-image-*-qemu*.ext2.bz2
284 </literallayout>
285
286 <para>
287 You must decompress the file image system using the following command:
288 </para>
289
290 <literallayout class='monospaced'>
291 $ bzip2 -d
292 </literallayout>
293
294 <para>
295 You can now start the emulator using this command:
296 </para>
297
298 <literallayout class='monospaced'>
299 $ poky-qemu &lt;<emphasis>kernel</emphasis>&gt; &lt;<emphasis>image</emphasis>&gt;
300 </literallayout>
301 </section>
302</section>
303
304</article>
305<!--
306vim: expandtab tw=80 ts=4
307-->
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-10-30 18:48:25 +0000