summaryrefslogtreecommitdiff
path: root/documentation/yocto-project-qs
diff options
context:
space:
mode:
authorRichard Purdie <richard.purdie@linuxfoundation.org>2011-04-20 14:20:19 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2011-04-20 15:49:17 +0100
commit50021cba20a09b1ed685db5466f940b17d4880ac (patch)
tree3bdafb797e6466ad58727b002f1235933010ab11 /documentation/yocto-project-qs
parent690e87a2ffe8caa16379be26eb356c5bded17c1f (diff)
downloadopenembedded-core-50021cba20a09b1ed685db5466f940b17d4880ac.tar.gz
openembedded-core-50021cba20a09b1ed685db5466f940b17d4880ac.tar.bz2
openembedded-core-50021cba20a09b1ed685db5466f940b17d4880ac.zip
Drop documentation directory, this is replaced by the new yocto-docs repository
Diffstat (limited to 'documentation/yocto-project-qs')
-rw-r--r--documentation/yocto-project-qs/Makefile32
-rwxr-xr-xdocumentation/yocto-project-qs/figures/building-an-image.pngbin14891 -> 0 bytes
-rwxr-xr-xdocumentation/yocto-project-qs/figures/cropped-yocto-project-bw.pngbin5453 -> 0 bytes
-rw-r--r--documentation/yocto-project-qs/figures/using-a-pre-built-image.pngbin12733 -> 0 bytes
-rwxr-xr-xdocumentation/yocto-project-qs/figures/white-on-black.pngbin18296 -> 0 bytes
-rwxr-xr-xdocumentation/yocto-project-qs/figures/yocto-environment.pngbin63851 -> 0 bytes
-rwxr-xr-xdocumentation/yocto-project-qs/figures/yocto-project-transp.pngbin8626 -> 0 bytes
-rw-r--r--documentation/yocto-project-qs/style.css968
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs-customization.xsl8
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs.xml525
10 files changed, 0 insertions, 1533 deletions
diff --git a/documentation/yocto-project-qs/Makefile b/documentation/yocto-project-qs/Makefile
deleted file mode 100644
index a267edc0c8..0000000000
--- a/documentation/yocto-project-qs/Makefile
+++ /dev/null
@@ -1,32 +0,0 @@
-XSLTOPTS = --stringparam html.stylesheet style.css \
- --xinclude
-
-XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
-XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
-
-all: html tarball
-
-##
-# These URI should be rewritten by your distribution's xml catalog to
-# match your localy installed XSL stylesheets.
-
-html:
-# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
-
-# xsltproc $(XSLTOPTS) -o yocto-project-qs.html $(XSL_XHTML_URI) yocto-project-qs.xml
- xsltproc $(XSLTOPTS) -o yocto-project-qs.html yocto-project-qs-customization.xsl yocto-project-qs.xml
-
-tarball: html
- tar -cvzf yocto-project-qs.tgz yocto-project-qs.html ypqs.pdf style.css figures/yocto-environment.png figures/building-an-image.png figures/using-a-pre-built-image.png figures/yocto-project-transp.png
-
-validate:
- xmllint --postvalid --xinclude --noout yocto-project-qs.xml
-
-OUTPUTS = yocto-project-qs.tgz yocto-project-qs.html ypqs.pdf
-SOURCES = *.png *.xml *.css
-
-publish:
- scp -r $(OUTPUTS) $(SOURCES) o-hand.com:/srv/www/pokylinux.org/doc/
-
-clean:
- 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
deleted file mode 100755
index 1fbea5ab00..0000000000
--- a/documentation/yocto-project-qs/figures/building-an-image.png
+++ /dev/null
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
deleted file mode 100755
index 561333b146..0000000000
--- a/documentation/yocto-project-qs/figures/cropped-yocto-project-bw.png
+++ /dev/null
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
deleted file mode 100644
index b03130d123..0000000000
--- a/documentation/yocto-project-qs/figures/using-a-pre-built-image.png
+++ /dev/null
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
deleted file mode 100755
index 075b4f2949..0000000000
--- a/documentation/yocto-project-qs/figures/white-on-black.png
+++ /dev/null
Binary files differ
diff --git a/documentation/yocto-project-qs/figures/yocto-environment.png b/documentation/yocto-project-qs/figures/yocto-environment.png
deleted file mode 100755
index 04e6092749..0000000000
--- a/documentation/yocto-project-qs/figures/yocto-environment.png
+++ /dev/null
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
deleted file mode 100755
index 31d2b147fd..0000000000
--- a/documentation/yocto-project-qs/figures/yocto-project-transp.png
+++ /dev/null
Binary files differ
diff --git a/documentation/yocto-project-qs/style.css b/documentation/yocto-project-qs/style.css
deleted file mode 100644
index 21caf85da4..0000000000
--- a/documentation/yocto-project-qs/style.css
+++ /dev/null
@@ -1,968 +0,0 @@
-/*
- Generic XHTML / DocBook XHTML CSS Stylesheet.
-
- Browser wrangling and typographic design by
- Oyvind Kolas / pippin@gimp.org
-
- Customised for Poky by
- Matthew Allum / mallum@o-hand.com
-
- Thanks to:
- Liam R. E. Quin
- William Skaggs
- Jakub Steiner
-
- Structure
- ---------
-
- The stylesheet is divided into the following sections:
-
- Positioning
- Margins, paddings, width, font-size, clearing.
- Decorations
- Borders, style
- Colors
- Colors
- Graphics
- Graphical backgrounds
- Nasty IE tweaks
- Workarounds needed to make it work in internet explorer,
- currently makes the stylesheet non validating, but up until
- this point it is validating.
- Mozilla extensions
- Transparency for footer
- Rounded corners on boxes
-
-*/
-
-
- /*************** /
- / Positioning /
-/ ***************/
-
-body {
- font-family: Verdana, Sans, sans-serif;
-
- min-width: 640px;
- width: 80%;
- margin: 0em auto;
- padding: 2em 5em 5em 5em;
- color: #333;
-}
-
-.reviewer {
- color: red;
-}
-
-h1,h2,h3,h4,h5,h6,h7 {
- font-family: Arial, Sans;
- color: #00557D;
- clear: both;
-}
-
-h1 {
- font-size: 2em;
- text-align: left;
- padding: 0em 0em 0em 0em;
- margin: 2em 0em 0em 0em;
-}
-
-h2.subtitle {
- margin: 0.10em 0em 3.0em 0em;
- padding: 0em 0em 0em 0em;
- font-size: 1.8em;
- padding-left: 20%;
- font-weight: normal;
- font-style: italic;
-}
-
-h2 {
- margin: 2em 0em 0.66em 0em;
- padding: 0.5em 0em 0em 0em;
- font-size: 1.5em;
- font-weight: bold;
-}
-
-h3.subtitle {
- margin: 0em 0em 1em 0em;
- padding: 0em 0em 0em 0em;
- font-size: 142.14%;
- text-align: right;
-}
-
-h3 {
- margin: 1em 0em 0.5em 0em;
- padding: 1em 0em 0em 0em;
- font-size: 140%;
- font-weight: bold;
-}
-
-h4 {
- margin: 1em 0em 0.5em 0em;
- padding: 1em 0em 0em 0em;
- font-size: 120%;
- font-weight: bold;
-}
-
-h5 {
- margin: 1em 0em 0.5em 0em;
- padding: 1em 0em 0em 0em;
- font-size: 110%;
- font-weight: bold;
-}
-
-h6 {
- margin: 1em 0em 0em 0em;
- padding: 1em 0em 0em 0em;
- font-size: 80%;
- font-weight: bold;
-}
-
-.authorgroup {
- background-color: transparent;
- background-repeat: no-repeat;
- padding-top: 256px;
- background-image: url("../figures/yocto-project-bw.png");
- background-position: top;
- margin-top: -256px;
- padding-right: 50px;
- margin-left: 50px;
- text-align: center;
- width: 600px;
-}
-
-h3.author {
- margin: 0em 0me 0em 0em;
- padding: 0em 0em 0em 0em;
- font-weight: normal;
- font-size: 100%;
- color: #333;
- clear: both;
-}
-
-.author tt.email {
- font-size: 66%;
-}
-
-.titlepage hr {
- width: 0em;
- clear: both;
-}
-
-.revhistory {
- padding-top: 2em;
- clear: both;
-}
-
-.toc,
-.list-of-tables,
-.list-of-examples,
-.list-of-figures {
- padding: 1.33em 0em 2.5em 0em;
- color: #00557D;
-}
-
-.toc p,
-.list-of-tables p,
-.list-of-figures p,
-.list-of-examples p {
- padding: 0em 0em 0em 0em;
- padding: 0em 0em 0.3em;
- margin: 1.5em 0em 0em 0em;
-}
-
-.toc p b,
-.list-of-tables p b,
-.list-of-figures p b,
-.list-of-examples p b{
- font-size: 100.0%;
- font-weight: bold;
-}
-
-.toc dl,
-.list-of-tables dl,
-.list-of-figures dl,
-.list-of-examples dl {
- margin: 0em 0em 0.5em 0em;
- padding: 0em 0em 0em 0em;
-}
-
-.toc dt {
- margin: 0em 0em 0em 0em;
- padding: 0em 0em 0em 0em;
-}
-
-.toc dd {
- margin: 0em 0em 0em 2.6em;
- padding: 0em 0em 0em 0em;
-}
-
-div.glossary dl,
-div.variablelist dl {
-}
-
-.glossary dl dt,
-.variablelist dl dt,
-.variablelist dl dt span.term {
- font-weight: normal;
- width: 20em;
- text-align: right;
-}
-
-.variablelist dl dt {
- margin-top: 0.5em;
-}
-
-.glossary dl dd,
-.variablelist dl dd {
- margin-top: -1em;
- margin-left: 25.5em;
-}
-
-.glossary dd p,
-.variablelist dd p {
- margin-top: 0em;
- margin-bottom: 1em;
-}
-
-
-div.calloutlist table td {
- padding: 0em 0em 0em 0em;
- margin: 0em 0em 0em 0em;
-}
-
-div.calloutlist table td p {
- margin-top: 0em;
- margin-bottom: 1em;
-}
-
-div p.copyright {
- text-align: left;
-}
-
-div.legalnotice p.legalnotice-title {
- margin-bottom: 0em;
-}
-
-p {
- line-height: 1.5em;
- margin-top: 0em;
-
-}
-
-dl {
- padding-top: 0em;
-}
-
-hr {
- border: solid 1px;
-}
-
-
-.mediaobject,
-.mediaobjectco {
- text-align: center;
-}
-
-img {
- border: none;
-}
-
-ul {
- padding: 0em 0em 0em 1.5em;
-}
-
-ul li {
- padding: 0em 0em 0em 0em;
-}
-
-ul li p {
- text-align: left;
-}
-
-table {
- width :100%;
-}
-
-th {
- padding: 0.25em;
- text-align: left;
- font-weight: normal;
- vertical-align: top;
-}
-
-td {
- padding: 0.25em;
- vertical-align: top;
-}
-
-p a[id] {
- margin: 0px;
- padding: 0px;
- display: inline;
- background-image: none;
-}
-
-a {
- text-decoration: underline;
- color: #444;
-}
-
-pre {
- overflow: auto;
-}
-
-a:hover {
- text-decoration: underline;
- /*font-weight: bold;*/
-}
-
-
-div.informalfigure,
-div.informalexample,
-div.informaltable,
-div.figure,
-div.table,
-div.example {
- margin: 1em 0em;
- padding: 1em;
- page-break-inside: avoid;
-}
-
-
-div.informalfigure p.title b,
-div.informalexample p.title b,
-div.informaltable p.title b,
-div.figure p.title b,
-div.example p.title b,
-div.table p.title b{
- padding-top: 0em;
- margin-top: 0em;
- font-size: 100%;
- font-weight: normal;
-}
-
-.mediaobject .caption,
-.mediaobject .caption p {
- text-align: center;
- font-size: 80%;
- padding-top: 0.5em;
- padding-bottom: 0.5em;
-}
-
-.epigraph {
- padding-left: 55%;
- margin-bottom: 1em;
-}
-
-.epigraph p {
- text-align: left;
-}
-
-.epigraph .quote {
- font-style: italic;
-}
-.epigraph .attribution {
- font-style: normal;
- text-align: right;
-}
-
-span.application {
- font-style: italic;
-}
-
-.programlisting {
- font-family: monospace;
- font-size: 80%;
- white-space: pre;
- margin: 1.33em 0em;
- padding: 1.33em;
-}
-
-.tip,
-.warning,
-.caution,
-.note {
- margin-top: 1em;
- margin-bottom: 1em;
-
-}
-
-/* force full width of table within div */
-.tip table,
-.warning table,
-.caution table,
-.note table {
- border: none;
- width: 100%;
-}
-
-
-.tip table th,
-.warning table th,
-.caution table th,
-.note table th {
- padding: 0.8em 0.0em 0.0em 0.0em;
- margin : 0em 0em 0em 0em;
-}
-
-.tip p,
-.warning p,
-.caution p,
-.note p {
- margin-top: 0.5em;
- margin-bottom: 0.5em;
- padding-right: 1em;
- text-align: left;
-}
-
-.acronym {
- text-transform: uppercase;
-}
-
-b.keycap,
-.keycap {
- padding: 0.09em 0.3em;
- margin: 0em;
-}
-
-.itemizedlist li {
- clear: none;
-}
-
-.filename {
- font-size: medium;
- font-family: Courier, monospace;
-}
-
-
-div.navheader, div.heading{
- position: absolute;
- left: 0em;
- top: 0em;
- width: 100%;
- background-color: #cdf;
- width: 100%;
-}
-
-div.navfooter, div.footing{
- position: fixed;
- left: 0em;
- bottom: 0em;
- background-color: #eee;
- width: 100%;
-}
-
-
-div.navheader td,
-div.navfooter td {
- font-size: 66%;
-}
-
-div.navheader table th {
- /*font-family: Georgia, Times, serif;*/
- /*font-size: x-large;*/
- font-size: 80%;
-}
-
-div.navheader table {
- border-left: 0em;
- border-right: 0em;
- border-top: 0em;
- width: 100%;
-}
-
-div.navfooter table {
- border-left: 0em;
- border-right: 0em;
- border-bottom: 0em;
- width: 100%;
-}
-
-div.navheader table td a,
-div.navfooter table td a {
- color: #777;
- text-decoration: none;
-}
-
-/* normal text in the footer */
-div.navfooter table td {
- color: black;
-}
-
-div.navheader table td a:visited,
-div.navfooter table td a:visited {
- color: #444;
-}
-
-
-/* links in header and footer */
-div.navheader table td a:hover,
-div.navfooter table td a:hover {
- text-decoration: underline;
- background-color: transparent;
- color: #33a;
-}
-
-div.navheader hr,
-div.navfooter hr {
- display: none;
-}
-
-
-.qandaset tr.question td p {
- margin: 0em 0em 1em 0em;
- padding: 0em 0em 0em 0em;
-}
-
-.qandaset tr.answer td p {
- margin: 0em 0em 1em 0em;
- padding: 0em 0em 0em 0em;
-}
-.answer td {
- padding-bottom: 1.5em;
-}
-
-.emphasis {
- font-weight: bold;
-}
-
-
- /************* /
- / decorations /
-/ *************/
-
-.titlepage {
-}
-
-.part .title {
-}
-
-.subtitle {
- border: none;
-}
-
-/*
-h1 {
- border: none;
-}
-
-h2 {
- border-top: solid 0.2em;
- border-bottom: solid 0.06em;
-}
-
-h3 {
- border-top: 0em;
- border-bottom: solid 0.06em;
-}
-
-h4 {
- border: 0em;
- border-bottom: solid 0.06em;
-}
-
-h5 {
- border: 0em;
-}
-*/
-
-.programlisting {
- border: solid 1px;
-}
-
-div.figure,
-div.table,
-div.informalfigure,
-div.informaltable,
-div.informalexample,
-div.example {
- border: 1px solid;
-}
-
-
-
-.tip,
-.warning,
-.caution,
-.note {
- border: 1px solid;
-}
-
-.tip table th,
-.warning table th,
-.caution table th,
-.note table th {
- border-bottom: 1px solid;
-}
-
-.question td {
- border-top: 1px solid black;
-}
-
-.answer {
-}
-
-
-b.keycap,
-.keycap {
- border: 1px solid;
-}
-
-
-div.navheader, div.heading{
- border-bottom: 1px solid;
-}
-
-
-div.navfooter, div.footing{
- border-top: 1px solid;
-}
-
- /********* /
- / colors /
-/ *********/
-
-body {
- color: #333;
- background: white;
-}
-
-a {
- background: transparent;
-}
-
-a:hover {
- background-color: #dedede;
-}
-
-
-h1,
-h2,
-h3,
-h4,
-h5,
-h6,
-h7,
-h8 {
- background-color: transparent;
-}
-
-hr {
- border-color: #aaa;
-}
-
-
-.tip, .warning, .caution, .note {
- border-color: #aaa;
-}
-
-
-.tip table th,
-.warning table th,
-.caution table th,
-.note table th {
- border-bottom-color: #aaa;
-}
-
-
-.warning {
- background-color: #fea;
-}
-
-.caution {
- background-color: #fea;
-}
-
-.tip {
- background-color: #eff;
-}
-
-.note {
- background-color: #dfc;
-}
-
-.glossary dl dt,
-.variablelist dl dt,
-.variablelist dl dt span.term {
- color: #044;
-}
-
-div.figure,
-div.table,
-div.example,
-div.informalfigure,
-div.informaltable,
-div.informalexample {
- border-color: #aaa;
-}
-
-pre.programlisting {
- color: black;
- background-color: #fff;
- border-color: #aaa;
- border-width: 2px;
-}
-
-.guimenu,
-.guilabel,
-.guimenuitem {
- background-color: #eee;
-}
-
-
-b.keycap,
-.keycap {
- background-color: #eee;
- border-color: #999;
-}
-
-
-div.navheader {
- border-color: black;
-}
-
-
-div.navfooter {
- border-color: black;
-}
-
-
- /*********** /
- / graphics /
-/ ***********/
-
-/*
-body {
- background-image: url("images/body_bg.jpg");
- background-attachment: fixed;
-}
-
-.navheader,
-.note,
-.tip {
- background-image: url("images/note_bg.jpg");
- background-attachment: fixed;
-}
-
-.warning,
-.caution {
- background-image: url("images/warning_bg.jpg");
- background-attachment: fixed;
-}
-
-.figure,
-.informalfigure,
-.example,
-.informalexample,
-.table,
-.informaltable {
- background-image: url("images/figure_bg.jpg");
- background-attachment: fixed;
-}
-
-*/
-h1,
-h2,
-h3,
-h4,
-h5,
-h6,
-h7{
-}
-
-/*
-Example of how to stick an image as part of the title.
-
-div.article .titlepage .title
-{
- background-image: url("figures/white-on-black.png");
- background-position: center;
- background-repeat: repeat-x;
-}
-*/
-
-div.preface .titlepage .title,
-div.colophon .title,
-div.chapter .titlepage .title,
-div.article .titlepage .title
-{
-}
-
-div.section div.section .titlepage .title,
-div.sect2 .titlepage .title {
- background: none;
-}
-
-
-h1.title {
- background-color: transparent;
- background-image: url("figures/yocto-project-bw.png");
- background-repeat: no-repeat;
- height: 256px;
- text-indent: -9000px;
- overflow:hidden;
-}
-
-h2.subtitle {
- background-color: transparent;
- text-indent: -9000px;
- overflow:hidden;
- width: 0px;
- display: none;
-}
-
- /*************************************** /
- / pippin.gimp.org specific alterations /
-/ ***************************************/
-
-/*
-div.heading, div.navheader {
- color: #777;
- font-size: 80%;
- padding: 0;
- margin: 0;
- text-align: left;
- position: absolute;
- top: 0px;
- left: 0px;
- width: 100%;
- height: 50px;
- background: url('/gfx/heading_bg.png') transparent;
- background-repeat: repeat-x;
- background-attachment: fixed;
- border: none;
-}
-
-div.heading a {
- color: #444;
-}
-
-div.footing, div.navfooter {
- border: none;
- color: #ddd;
- font-size: 80%;
- text-align:right;
-
- width: 100%;
- padding-top: 10px;
- position: absolute;
- bottom: 0px;
- left: 0px;
-
- background: url('/gfx/footing_bg.png') transparent;
-}
-*/
-
-
-
- /****************** /
- / nasty ie tweaks /
-/ ******************/
-
-/*
-div.heading, div.navheader {
- width:expression(document.body.clientWidth + "px");
-}
-
-div.footing, div.navfooter {
- width:expression(document.body.clientWidth + "px");
- margin-left:expression("-5em");
-}
-body {
- padding:expression("4em 5em 0em 5em");
-}
-*/
-
- /**************************************** /
- / mozilla vendor specific css extensions /
-/ ****************************************/
-/*
-div.navfooter, div.footing{
- -moz-opacity: 0.8em;
-}
-
-div.figure,
-div.table,
-div.informalfigure,
-div.informaltable,
-div.informalexample,
-div.example,
-.tip,
-.warning,
-.caution,
-.note {
- -moz-border-radius: 0.5em;
-}
-
-b.keycap,
-.keycap {
- -moz-border-radius: 0.3em;
-}
-*/
-
-table tr td table tr td {
- display: none;
-}
-
-
-hr {
- display: none;
-}
-
-table {
- border: 0em;
-}
-
- .photo {
- float: right;
- margin-left: 1.5em;
- margin-bottom: 1.5em;
- margin-top: 0em;
- max-width: 17em;
- border: 1px solid gray;
- padding: 3px;
- background: white;
-}
- .seperator {
- padding-top: 2em;
- clear: both;
- }
-
- #validators {
- margin-top: 5em;
- text-align: right;
- color: #777;
- }
- @media print {
- body {
- font-size: 8pt;
- }
- .noprint {
- display: none;
- }
- }
-
-
-.tip,
-.note {
- background: #666666;
- color: #fff;
- padding: 20px;
- margin: 20px;
-}
-
-.tip h3,
-.note h3 {
- padding: 0em;
- margin: 0em;
- font-size: 2em;
- font-weight: bold;
- color: #fff;
-}
-
-.tip a,
-.note a {
- color: #fff;
- text-decoration: underline;
-}
diff --git a/documentation/yocto-project-qs/yocto-project-qs-customization.xsl b/documentation/yocto-project-qs/yocto-project-qs-customization.xsl
deleted file mode 100644
index 8e6ea34dd4..0000000000
--- a/documentation/yocto-project-qs/yocto-project-qs-customization.xsl
+++ /dev/null
@@ -1,8 +0,0 @@
-<?xml version='1.0'?>
-<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">
-
- <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" />
-
- <xsl:param name="generate.toc" select="'article nop'"></xsl:param>
-
-</xsl:stylesheet>
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml
deleted file mode 100644
index f011f09860..0000000000
--- a/documentation/yocto-project-qs/yocto-project-qs.xml
+++ /dev/null
@@ -1,525 +0,0 @@
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
-"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
-
-<article id='intro'>
- <imagedata fileref="figures/yocto-project-transp.png" width="6in" depth="1in" align="right" scale="25" />
-
-<section id='fake-title'>
- <title>Yocto Project Quick Start</title>
- <para>Copyright &copy; 2010-2011 Linux Foundation</para>
-</section>
-
-<section id='welcome'>
- <title>Welcome!</title>
- <para>
- Welcome to the Yocto Project!
- The Yocto Project is an open-source collaboration project focused on embedded Linux
- developers.
- Amongst other things, the Yocto Project uses the Poky build tool to
- construct complete Linux images.
- </para>
- <para>
- This short document will give you some basic information about the environment as well
- as let you experience it in its simplest form.
- After reading this document you will have a basic understanding of what the Yocto Project is
- and how to use some of its core components.
- This document steps you through a simple example showing you how to build a small image
- and run it using the QEMU emulator.
- </para>
- <para>
- For complete information on the Yocto Project, you should check out the
- <ulink url='http://www.yoctoproject.org'>Yocto Project Website</ulink>.
- You can find the latest builds, breaking news, full development documentation, and a
- rich Yocto Project Development Community into which you can tap.
- </para>
- <para>
- Finally, you might find the Frequently Asked Questions (FAQ) for the Yocto Project
- at <ulink url='https://wiki.yoctoproject.org/wiki/FAQ'>Yocto Project FAQ</ulink> and
- the FAQ appendix located in the
- <ulink url='http://www.yoctoproject.org/docs/poky-ref-manual/poky-ref-manual.html'>
- Poky Reference Manual</ulink> helpful.
- </para>
-</section>
-
-<section id='yp-intro'>
- <title>Introducing the Yocto Project Development Environment</title>
- <para>
- The Yocto Project through the Poky build tool provides an open source development
- environment targeting the ARM, MIPS, PowerPC and x86 architectures for a variety of
- platforms including x86-64 and emulated ones.
- You can use components from the the 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.
- </para>
-
- <para></para>
- <para></para>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="figures/yocto-environment.png"
- format="PNG" align='center' scalefit='1' width="100%"/>
- </imageobject>
- <caption>
- <para>The Yocto Project Development Environment</para>
- </caption>
- </mediaobject>
-
- <para>
- Yocto Project:
- </para>
-
- <itemizedlist>
- <listitem>
- <para>Provides a recent Linux kernel along with a set of system commands and libraries suitable for the embedded environment.</para>
- </listitem>
- <listitem>
- <para>Makes available system components such as X11, Matchbox, GTK+, Pimlico, Clutter,
- GuPNP and Qt (among others) so you can create a richer user interface experience on
- devices that use displays or have a GUI.
- For devices that don't have a GUI or display you simply would not employ these
- components.</para>
- </listitem>
- <listitem>
- <para>Creates a focused and stable core compatible with the OpenEmbedded
- project with which you can easily and reliably build and develop.</para>
- </listitem>
- <listitem>
- <para>Fully supports a wide range of hardware and device emulation through the QEMU
- Emulator.</para>
- </listitem>
- </itemizedlist>
-
- <para>
- The Yocto Project can generate images for many kinds of devices.
- 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.
- Because an image developed with the Yocto Project can boot inside a QEMU emulator, the
- development environment works nicely as a test platform for developing embedded software.
- </para>
-
- <para>
- Another important Yocto Project feature is the Sato reference User Interface.
- This optional GNOME mobile-based UI, which is intended for devices with
- resolution but restricted size screens, sits neatly on top of a device using the
- GNOME Mobile Stack providing a well-defined user experience.
- Implemented in its own layer, it makes it clear to developers how they can implement
- their own UIs on top of Yocto Linux.
- </para>
-</section>
-
-<section id='resources'>
- <title>What You Need and How You Get It</title>
-
- <para>
- You need these things to develop in the Yocto Project environment:
- </para>
-
- <itemizedlist>
- <listitem>
- <para>A host system running a supported Linux distribution (i.e. recent releases of
- Fedora, OpenSUSE, Debian, and Ubuntu).
- <note>
- For notes about using the Yocto Project on development systems that use
- older Linux distributions see
- <ulink url='https://wiki.yoctoproject.org/wiki/BuildingOnRHEL4'></ulink>
- </note></para>
- </listitem>
- <listitem>
- <para>The right packages.</para>
- </listitem>
- <listitem>
- <para>A release of Yocto Project.</para>
- </listitem>
- </itemizedlist>
-
- <section id='the-linux-distro'>
- <title>The Linux Distribution</title>
-
- <para>
- This document assumes you are running a reasonably current Linux-based host system.
- The examples work for both Debian-based and RPM-based distributions.
- </para>
- </section>
-
- <section id='packages'>
- <title>The Packages</title>
-
- <para>
- The packages you need for a Debian-based host are shown in the following command:
- </para>
-
- <literallayout class='monospaced'>
- $ sudo apt-get install sed wget cvs subversion git-core coreutils \
- unzip texi2html texinfo libsdl1.2-dev docbook-utils gawk \
- python-pysqlite2 diffstat help2man make gcc build-essential \
- g++ desktop-file-utils chrpath libgl1-mesa-dev libglu1-mesa-dev \
- mercurial autoconf automake groff
- </literallayout>
-
- <para>
- The packages you need for an RPM-based host like Fedora are shown in these commands:
- </para>
-
- <literallayout class='monospaced'>
- $ sudo yum groupinstall "development tools"
- $ sudo yum install python m4 make wget curl ftp hg tar bzip2 gzip \
- unzip python-psyco perl texinfo texi2html diffstat openjade \
- docbook-style-dsssl sed docbook-style-xsl docbook-dtds \
- docbook-utils sed bc glibc-devel ccache pcre pcre-devel quilt \
- groff linuxdoc-tools patch linuxdoc-tools cmake help2man \
- perl-ExtUtils-MakeMaker tcl-devel gettext chrpath ncurses apr \
- SDL-devel mesa-libGL-devel mesa-libGLU-devel gnome-doc-utils \
- autoconf automake
- </literallayout>
-
- <note><para>
- Packages vary in number and name for other Linux distributions.
- The commands here should work. We are interested, though, to learn what works for you.
- You can find more information for package requirements on common Linux distributions
- at <ulink url="http://wiki.openembedded.net/index.php/OEandYourDistro"></ulink>.
- However, you should be careful when using this information as the information applies
- to old Linux distributions that are known to not work with a current Poky install.
- </para></note>
- </section>
-
- <section id='releases'>
- <title>Yocto Project Release</title>
-
- <para>
- The latest release images for the Yocto Project are kept at
- <ulink url="http://yoctoproject.org/downloads/yocto-1.0/"></ulink>.
- Nightly and developmental builds are also maintained. However, for this
- document a released version of Yocto Project is used.
- </para>
- </section>
-</section>
-
-<section id='test-run'>
- <title>A Quick Test Run</title>
-
- <para>
- Now that you have your system requirements in order you can give Yocto Project a try.
- This section presents some steps that let you do the following:
- </para>
-
- <itemizedlist>
- <listitem>
- <para>Build an image and run it in the emulator</para>
- </listitem>
- <listitem>
- <para>Or, use a pre-built image and run it in the emulator</para>
- </listitem>
- </itemizedlist>
-
- <section id='building-image'>
- <title>Building an Image</title>
-
- <para>
- 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.
- </para>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="figures/building-an-image.png" format="PNG" align='center' scalefit='1'/>
- </imageobject>
- <caption>
- <para>Building an Image</para>
- </caption>
- </mediaobject>
-
- <para>
- Use the following commands to build your image.
- The build process creates an entire Linux distribution, including the toolchain, from source.
- </para>
-
- <note><para>
- The build process using Sato currently consumes
- about 50GB of disk space.
- To allow for variations in the build process and for future package expansion, we
- recommend having at least 100GB of free disk space.
- </para></note>
-
- <note><para>
- By default, Poky searches for source code using a pre-determined order
- through a set of locations.
- If you encounter problems with Poky finding and downloading source code, see
- the FAQ entry "How does Poky obtain source code and will it work behind my
- firewall or proxy server?" in the
- <ulink url='http://www.yoctoproject.org/docs/poky-ref-manual/poky-ref-manual.html'>
- Poky Reference Manual</ulink>.
- </para></note>
-
- <para>
- <literallayout class='monospaced'>
- $ wget http://www.yoctoproject.org/downloads/poky/poky-bernard-5.0.tar.bz2
- $ tar xjf poky-bernard-5.0.tar.bz2
- $ source poky-bernard-5.0/poky-init-build-env poky-5.0-build
- </literallayout>
- </para>
-
- <tip><para>
- To help conserve disk space during builds you can add the following statement
- to your <filename>local.conf</filename> file.
- Adding this statement deletes the work directory used for building a package
- once the package is built.
- <literallayout class='monospaced'>
- INHERIT += rm_work
- </literallayout>
- </para></tip>
-
- <itemizedlist>
- <listitem><para>The first two commands extract the Yocto Project files from the
- release tarball and place them into a subdirectory of your current directory.</para></listitem>
- <listitem><para>The <command>source</command> command creates the
- <filename>poky-5.0-build</filename> directory and executes the <command>cd</command>
- command to make <filename>poky-5.0-build</filename> the working directory.
- The resulting build directory contains all the files created during the build.
- By default the target architecture is qemux86.
- To change this default, edit the value of the MACHINE variable in the
- <filename>conf/local.conf</filename> file.</para></listitem>
- </itemizedlist>
- <para>
- Take some time to examine your <filename>conf/local.conf</filename> file.
- The defaults should work fine.
- However, if you have a multi-core CPU you might want to set the variables
- BB_NUMBER_THREADS and PARALLEL_MAKE to the number of processor cores on your build machine.
- By default, these variables are commented out.
- </para>
- <para>
- Continue with the following command to build an OS image for the target, which is
- <filename>poky-image-sato</filename> in this example.
- <literallayout class='monospaced'>
- $ bitbake poky-image-sato
- </literallayout>
- <note><para>
- BitBake requires Python 2.6. For more information on this requirement,
- see the FAQ appendix in the
- <ulink url='http://www.yoctoproject.org/docs/poky-ref-manual/poky-ref-manual.html'>
- Poky Reference Manual</ulink>.
- </para></note>
- The final command runs the image:
- <literallayout class='monospaced'>
- $ poky-qemu qemux86
- </literallayout>
- <note><para>
- Depending on the number of processors and cores, the amount or RAM, the speed of your
- Internet connection and other factors, the build process could take several hours the first
- time you run it.
- Subsequent builds run much faster since parts of the build are cached.
- </para></note>
- </para>
- </section>
-
- <section id='using-pre-built'>
- <title>Using Pre-Built Binaries and QEMU</title>
- <para>
- If hardware, libraries and services are stable you can get started by using a pre-built binary
- of the image, kernel and toolchain and run it using the emulator QEMU.
- This scenario is useful for developing application software.
- </para>
-
- <para></para>
- <para></para>
- <para></para>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="figures/using-a-pre-built-image.png" format="PNG" align='center' scalefit='1'/>
- </imageobject>
- <caption>
- <para>Using a Pre-Built Image</para>
- </caption>
- </mediaobject>
-
- <para>
- For this scenario you need to do several things:
- </para>
-
- <itemizedlist>
- <listitem>
- <para>
- Install the stand-alone Yocto toolchain tarball.
- </para>
- </listitem>
- <listitem>
- <para>
- Download the pre-built kernel that will boot with QEMU.
- You need to be sure to get the QEMU image that matches your target machine’s
- architecture (e.g. x86, ARM, etc.).
- </para>
- </listitem>
- <listitem>
- <para>
- Download the filesystem image for your target machine's architecture.
- </para>
- </listitem>
- <listitem>
- <para>
- Set up the environment to emulate the hardware and then start the QEMU emulator.
- </para>
- </listitem>
-
- </itemizedlist>
-
- <section id='installing-the-toolchain'>
- <title>Installing the Toolchain</title>
- <para>
- You can download the pre-built toolchain, which includes the poky-qemu script and
- support files, from
- <ulink url='http://yoctoproject.org/downloads/yocto-1.0/toolchain/'></ulink>.
- Toolchains are available for 32-bit and 64-bit development systems from the
- <filename>i686</filename> and <filename>x86_64</filename> folders, respectively.
- Each type of development system supports five target architectures.
- The tarball files are named such that a string representing the host system appears
- first in the filename and then is immediately followed by a string representing
- the target architecture.
- </para>
-
- <literallayout class='monospaced'>
- yocto-eglibc&lt;<emphasis>host_system</emphasis>&gt;-&lt;<emphasis>arch</emphasis>&gt;-toolchain-sdk-&lt;<emphasis>release</emphasis>&gt;.tar.bz2
-
- Where:
- &lt;<emphasis>host_system</emphasis>&gt; is a string representing your development system:
- i686 or x86_64.
-
- &lt;<emphasis>arch</emphasis>&gt; is a string representing the target architecture:
- i686, x86_64, powerpc, mips, or arm.
-
- &lt;<emphasis>release</emphasis>&gt; is the version of Yocto Project.
- </literallayout>
-
- <para>
- For example, the following toolchain tarball is for a 64-bit development
- host system and a 32-bit target architecture:
- </para>
-
- <literallayout class='monospaced'>
- yocto-eglibc-x86_64-i686-toolchain-sdk-1.0.tar.bz2
- </literallayout>
-
- <para>
- The toolchain tarballs are self-contained and should be installed into <filename>/opt/poky</filename>.
- The following commands show how you install the toolchain tarball given a 64-bit development host system
- and a 32-bit target architecture.
- </para>
-
- <para>
- <literallayout class='monospaced'>
- $ cd /
- $ sudo tar -xvjf yocto-eglibc-x86_64-i686-toolchain-sdk-1.0.tar.bz2
- </literallayout>
- </para>
- </section>
-
- <section id='downloading-the-pre-built-linux-kernel'>
- <title>Downloading the Pre-Built Linux Kernel</title>
- <para>
- You can download the pre-built Linux kernel and the filesystem image suitable for
- running in the emulator QEMU from
- <ulink url='http://yoctoproject.org/downloads/yocto-1.0/machines/qemu'></ulink>.
- Be sure to use the kernel and filesystem image that matches the architecture you want
- to simulate.
- </para>
-
- <para>
- Most kernel files have the following form:
- </para>
-
- <literallayout class='monospaced'>
- *zImage*qemu&lt;<emphasis>arch</emphasis>&gt;*.bin
-
- Where:
- &lt;<emphasis>arch</emphasis>&gt; is a string representing the target architecture:
- x86, x86-64, ppc, mips, or arm.
- </literallayout>
- </section>
-
- <section id='downloading-the-filesystem'>
- <title>Downloading the Filesystem</title>
- <para>
- The filesystem image has two forms.
- One form is an <filename>ext3</filename> filesystem image.
- The other form is a tarball of the filesystem and is booted using user-space NFS.
- Here are the respective forms:
- </para>
-
- <literallayout class='monospaced'>
- yocto-image-&lt;<emphasis>profile</emphasis>&gt;-qemu&lt;<emphasis>arch</emphasis>&gt;.rootfs.ext3
- yocto-image-&lt;<emphasis>profile</emphasis>&gt;-qemu&lt;<emphasis>arch</emphasis>&gt;.rootfs.tar.bz2
-
- Where:
- &lt;<emphasis>profile</emphasis>&gt; is the filesystem image's profile:
- sdk, sato, minimal, or lsb.
-
- &lt;<emphasis>arch</emphasis>&gt; is a string representing the target architecture:
- x86, x86-64, ppc, mips, or arm.
- </literallayout>
- </section>
-
- <section id='setting-up-the-environment-and-starting-the-qemu-emulator'>
- <title>Setting Up the Environment and Starting the QEMU Emulator</title>
- <para>
- Before you start the QEMU emulator you need to set up the emulation environment.
- The following command form sets up the emulation environment.
- </para>
-
- <literallayout class='monospaced'>
- $ source /opt/poky/environment-setup-&lt;<emphasis>arch</emphasis>&gt;-poky-linux-&lt;<emphasis>if</emphasis>&gt;
-
- Where:
- &lt;<emphasis>arch</emphasis>&gt; is a string representing the target architecture:
- i686, x86_64, ppc603e, mips, or armv5te.
-
- &lt;<emphasis>if</emphasis>&gt; is a string representing an embedded application binary interface.
- Not all setup scripts include this string.
- </literallayout>
-
- <para>
- Finally, this command form invokes the QEMU emulator
- </para>
-
- <literallayout class='monospaced'>
- $ poky-qemu &lt;<emphasis>qemuarch</emphasis>&gt; &lt;<emphasis>kernel</emphasis>&gt; &lt;<emphasis>filesystem_image</emphasis>&gt;
-
- Where:
- &lt;<emphasis>qemuarch</emphasis>&gt; is a string representing the target architecture: qemux86, qemux86-64,
- qemuppc, qemumips, or qemuarm.
-
- &lt;<emphasis>kernel</emphasis>&gt; is the architecture-specific kernel.
-
- &lt;<emphasis>filesystem_image</emphasis>&gt; is the .ext3 filesystem image.
-
- </literallayout>
-
- <para>
- Continuing with the example, the following two commands setup the emulation
- environment and launch QEMU.
- The kernel and filesystem are for a 32-bit target architecture.
- </para>
-
- <literallayout class='monospaced'>
- $ source /opt/poky/environment-setup-i686-poky-linux
- $ poky-qemu qemux86 zImage-2.6.34-qemux86-1.0.bin yocto-image-sdk-qemux86-1.0.rootfs.ext3
- </literallayout>
-
- <para>
- The environment in which QEMU launches varies depending on the filesystem image and on the
- target architecture. For example, if you source the environment for the ARM target
- architecture and then boot the minimal QEMU image, the emulator comes up in a new
- shell in command-line mode. However, if you boot the SDK image QEMU comes up with
- a GUI.
- </para>
-
- <note><para>
- Booting the PPC image results in QEMU launching in the same shell in command-line mode.
- </para></note>
- </section>
- </section>
-</section>
-
-</article>
-<!--
-vim: expandtab tw=80 ts=4
--->