From 92ee38410f9ef0737a425b082783e818c6f6cc5b Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 26 Feb 2018 13:20:27 -0800 Subject: brief-yoctoprojectqs, Makefile: New "First Build" article. I have created an brief article in the form of current YP docs that is a pared down version of the Quick Start (pre 2.5 release). The article fills a gap for a short (2-page), process-oriented article that steps the user through an initial build using YP. I had to make changes to the Makefile to support building the new article. (From yocto-docs rev: 47aace60cea4a892ae1efabb050b240c6abdaec9) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/Makefile | 19 +- .../brief-yoctoprojectqs-customization.xsl | 24 + .../brief-yoctoprojectqs-style.css | 989 +++++ .../brief-yoctoprojectqs-titlepage.xsl | 3820 ++++++++++++++++++++ .../brief-yoctoprojectqs/brief-yoctoprojectqs.html | 240 ++ .../brief-yoctoprojectqs/brief-yoctoprojectqs.tgz | Bin 0 -> 28833 bytes .../brief-yoctoprojectqs/brief-yoctoprojectqs.xml | 337 ++ .../figures/yocto-project-transp.png | Bin 0 -> 8626 bytes .../brief-yoctoprojectqs/figures/ypqs-title.png | Bin 0 -> 11700 bytes 9 files changed, 5427 insertions(+), 2 deletions(-) create mode 100644 documentation/brief-yoctoprojectqs/brief-yoctoprojectqs-customization.xsl create mode 100644 documentation/brief-yoctoprojectqs/brief-yoctoprojectqs-style.css create mode 100644 documentation/brief-yoctoprojectqs/brief-yoctoprojectqs-titlepage.xsl create mode 100644 documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.html create mode 100644 documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.tgz create mode 100644 documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml create mode 100755 documentation/brief-yoctoprojectqs/figures/yocto-project-transp.png create mode 100644 documentation/brief-yoctoprojectqs/figures/ypqs-title.png diff --git a/documentation/Makefile b/documentation/Makefile index bb8d6a5749..b55dddb85e 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -84,6 +84,21 @@ # for the 'denzil' branch. # +ifeq ($(DOC),brief-yoctoprojectqs) +XSLTOPTS = --stringparam html.stylesheet brief-yoctoprojectqs-style.css \ + --stringparam chapter.autolabel 1 \ + --stringparam section.autolabel 1 \ + --stringparam section.label.includes.component.label 1 \ + --xinclude +ALLPREQ = html tarball +TARFILES = brief-yoctoprojectqs-style.css brief-yoctoprojectqs.html figures/ypqs-title.png \ + figures/yocto-project-transp.png +MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse +FIGURES = figures +STYLESHEET = $(DOC)/*.css + +endif + ifeq ($(DOC),getting-started) XSLTOPTS = --xinclude ALLPREQ = html eclipse tarball @@ -384,9 +399,9 @@ XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl all: $(ALLPREQ) pdf: -ifeq ($(DOC),yocto-project-qs) +ifeq ($(DOC),yocto-project-qs brief-yoctoprojectqs) @echo " " - @echo "ERROR: You cannot generate a yocto-project-qs PDF file." + @echo "ERROR: You cannot generate yocto-project-qs or brief-yoctoprojectqs PDF files." @echo " " else ifeq ($(DOC),mega-manual) diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs-customization.xsl b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs-customization.xsl new file mode 100644 index 0000000000..0d57424b59 --- /dev/null +++ b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs-customization.xsl @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs-style.css b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs-style.css new file mode 100644 index 0000000000..5085b9d0be --- /dev/null +++ b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs-style.css @@ -0,0 +1,989 @@ +/* + 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; +} + +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: 110%; + font-weight: bold; +} + +.authorgroup { + background-color: transparent; + background-repeat: no-repeat; + padding-top: 256px; + background-image: url("figures/ypqs-title.png"); + background-position: left top; + margin-top: -256px; + padding-right: 50px; + margin-left: 0px; + text-align: right; + width: 740px; +} + +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;*/ +} + +/* This style defines how the permalink character + appears by itself and when hovered over with + the mouse. */ + +[alt='Permalink'] { color: #eee; } +[alt='Permalink']:hover { color: black; } + + +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: #fff; +} + + +.tip table th, +.warning table th, +.caution table th, +.note table th { + border-bottom-color: #fff; +} + + +.warning { + background-color: #f0f0f2; +} + +.caution { + background-color: #f0f0f2; +} + +.tip { + background-color: #f0f0f2; +} + +.note { + background-color: #f0f0f2; +} + +.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; +} + + +.writernotes { + color: red; +} + + + /*********** / + / 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 { + background-position: bottom; + background-repeat: repeat-x; +} + +div.section div.section .titlepage .title, +div.sect2 .titlepage .title { + background: none; +} + + +h1.title { + background-color: transparent; + 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: #f0f0f2; + color: #333; + padding: 20px; + margin: 20px; +} + +.tip h3, +.note h3 { + padding: 0em; + margin: 0em; + font-size: 2em; + font-weight: bold; + color: #333; +} + +.tip a, +.note a { + color: #333; + text-decoration: underline; +} + +.footnote { + font-size: small; + color: #333; +} + +/* Changes the announcement text */ +.tip h3, +.warning h3, +.caution h3, +.note h3 { + font-size:large; + color: #00557D; +} diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs-titlepage.xsl b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs-titlepage.xsl new file mode 100644 index 0000000000..a435ac77ab --- /dev/null +++ b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs-titlepage.xsl @@ -0,0 +1,3820 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ + + + +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 + + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 + + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 + + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 + + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 + + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 + + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 + + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + 1 + + + +
+ + + + + + + + + + + 1 + + + +
+ + +
+ + + + + + + + + + + + + + + +
+ + + +
+ + + +
+ +
+ + + + diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.html b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.html new file mode 100644 index 0000000000..8c259aa5a6 --- /dev/null +++ b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.html @@ -0,0 +1,240 @@ + +My First Yocto Project Build

My First Yocto Project Build

Copyright © 2010-2018 Linux Foundation

+ Permission is granted to copy, distribute and/or modify this document under + the terms of the Creative Commons Attribution-Share Alike 2.0 UK: England & Wales as published by Creative Commons. +

Manual Notes

  • + For the latest version of this document associated with + this Yocto Project release + (version 2.5), see the "My First + Yocto Project Build" from the + Yocto Project documentation page. +

  • + This version of the manual is version + 2.5. + For later releases of the Yocto Project (if they exist), + go to the + Yocto Project documentation page + and use the drop-down "Active Releases" button + and choose the Yocto Project version for which you want + the manual. +

1. Welcome!

+ Welcome! + This short document steps you through the process for a typical + image build using the Yocto Project. + The build uses Poky, which is the reference embedded OS that is + completely specified. +

Note

+ The examples in this paper assume you are using a native Linux + system running a recent Ubuntu Linux distribution. + If the machine you want to use + Yocto Project on to build an image is not a native Linux + system, you can still perform these steps by using CROss + PlatformS (CROPS) and setting up a Poky container. + See the + Setting Up to Use CROss PlatformS (CROPS)" + section in the Yocto Project Development Tasks Manual for more + information. +

+

+ If you want more conceptual or background information on the + Yocto Project, see the + Getting Started With Yocto Project Manual. +

2. Compatible Linux Distribution

+ Make sure your build system meets the following requirements: +

  • + 50 Gbytes of free disk space +

  • + Runs a supported Linux distribution (i.e. recent releases of + Fedora, openSUSE, CentOS, Debian, or Ubuntu). For a list of + Linux distributions that support the Yocto Project, see the + "Supported Linux Distributions" + section in the Yocto Project Reference Manual. +

  • +

    • + Git 1.8.3.1 or greater +

    • + tar 1.27 or greater +

    • + Python 3.4.0 or greater. +

    + If your build host does not meet any of these three listed + version requirements, you can take steps to prepare the + system so that you can still use the Yocto Project. + See the + "Required Git, tar, and Python Versions" + section in the Yocto Project Reference Manual for information. +

+

3. Build System Packages

+ You must install essential host packages on your + development host. + The following command installs the host packages based on an + Ubuntu distribution: +

Note

+ For host package requirements on all supported Linux + distributions, see the + "Required Packages for the Host Development System" + section in the Yocto Project Reference Manual. +

+ 

+     $ sudo apt-get install gawk wget git-core diffstat unzip texinfo gcc-multilib \
+     build-essential chrpath socat cpio python python3 python3-pip python3-pexpect \
+     xz-utils debianutils iputils-ping libsdl1.2-dev xterm
+

+

4. Use Git to Clone Poky

+ Once you complete the setup instructions for your machine, + you need to get a copy of the Poky repository on your build + system. + Use the following commands to clone the Poky + repository and then checkout the yocto-2.5 release: + 

+     $ git clone git://git.yoctoproject.org/poky
+     Cloning into 'poky'...
+     remote: Counting objects: 361782, done.
+     remote: Compressing objects: 100% (87100/87100), done.
+     remote: Total 361782 (delta 268619), reused 361439 (delta 268277)
+     Receiving objects: 100% (361782/361782), 131.94 MiB | 6.88 MiB/s, done.
+     Resolving deltas: 100% (268619/268619), done.
+     Checking connectivity... done.
+     $ git checkout tags/yocto-2.5 -b my-yocto-2.5
+

+ The previous Git checkout command creates a local branch + named my-yocto-2.5. The files available to you in that + branch exactly match the repository's files in the + "sumo" development branch at the time of the + Yocto Project 2.5 release. +

+ For more options and information about accessing Yocto + Project related repositories, see the + "Working With Yocto Project Source Files" + section in the Yocto Project Development Tasks Manual. +

5. Building Your Image

+ Use the following steps to build your image. + The OpenEmbedded build system creates an entire Linux + distribution, including the toolchain, from source. +

Note

  • + If you are working behind a firewall and your build + host is not set up for proxies, you could encounter + problems with the build process when fetching source + code (e.g. fetcher failures or Git failures). +

  • + If you do not know your proxy settings, consult your + local network infrastructure resources and get that + information. + A good starting point could also be to check your + web browser settings. + Finally, you can find more information on the + "Working Behind a Network Proxy" + wiki page. +

+

+

  1. + Initialize the Build Environment: + Run the + oe-init-build-env + environment setup script to define the OpenEmbedded + build environment on your build host. + 

    +     $ source oe-init-build-env
+

    + Among other things, the script creates the + Build Directory, + which is build in this case + and is located in the + Source Directory. + After the script runs, your current working directory + is set to the Build Directory. + Later, when the build completes, the Build Directory + contains all the files created during the build. +

  2. + Examine Your Local Configuration File: + When you set up the build environment, a local + configuration file named + local.conf becomes available in + a conf subdirectory of the + Build Directory. + For this quick start, the defaults are set to build + for a qemux86 target, which is + suitable for emulation. + The package manager used is set to the RPM package + manager. +

  3. + Start the Build: + Continue with the following command to build an OS image + for the target, which is + core-image-sato in this example: + 

    +     $ bitbake core-image-sato
+

    + For information on using the + bitbake command, see the + "BitBake" + section in the Yocto Project Overview Manual, or + see the + "BitBake Command" + section in the BitBake User Manual. +

  4. + Simulate Your Image Using QEMU: + Once this particular image is built, you can start + QEMU, which is a Quick EMUlator that ships with + the Yocto Project: + 

    +     $ runqemu qemux86
+

    + If you want to learn more about running QEMU, see the + "Using the Quick EMUlator (QEMU)" + chapter in the Yocto Project Development Tasks Manual. +

  5. + Exit QEMU: + Exit QEMU by either clicking on the shutdown icon or by + typing Ctrl-C in the QEMU + transcript window from which you evoked QEMU. +

+

6. Where To Go Next

+ Now that you have experienced using the Yocto Project, you might + be asking yourself "What now?" + The Yocto Project has many sources of information including + the website, wiki pages, and user manuals: +

  • + Website: + The + Yocto Project Website + provides background information, the latest builds, + breaking news, full development documentation, and + access to a rich Yocto Project Development Community + into which you can tap. +

  • + Developer Screencast: + The + Getting Started with the Yocto Project - New Developer Screencast Tutorial + provides a 30-minute video created for users unfamiliar + with the Yocto Project but familiar with Linux build + hosts. + While this screencast is somewhat dated, the + introductory and fundamental concepts are useful for + the beginner. +

  • + Yocto Project Wiki: + The + Yocto Project Wiki + provides additional information on where to go next + when ramping up with the Yocto Project, release + information, project planning, and QA information. +

  • + Yocto Project Mailing Lists: + Related mailing lists provide a forum for discussion, + patch submission and announcements. + Several mailing lists exist and are grouped according + to areas of concern. + See the + "Mailing lists" + section in the Yocto Project Reference Manual for a + complete list of Yocto Project mailing lists. +

  • + Comprehensive List of Links and Other Documentation: + The + "Links and Related Documentation" + section in the Yocto Project Reference Manual provides a + comprehensive list of all related links and other + user documentation. +

+

\ No newline at end of file diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.tgz b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.tgz new file mode 100644 index 0000000000..4bbcb288eb Binary files /dev/null and b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.tgz differ diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml new file mode 100644 index 0000000000..da497cc100 --- /dev/null +++ b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml @@ -0,0 +1,337 @@ + %poky; ] > + +
+ + My First Yocto Project Build + + + ©RIGHT_YEAR; + Linux Foundation + + + + + Permission is granted to copy, distribute and/or modify this document under + the terms of the Creative Commons Attribution-Share Alike 2.0 UK: England & Wales as published by Creative Commons. + + Manual Notes + + + For the latest version of this document associated with + this Yocto Project release + (version &YOCTO_DOC_VERSION;), see the "My First + Yocto Project Build" from the + Yocto Project documentation page. + + + This version of the manual is version + &YOCTO_DOC_VERSION;. + For later releases of the Yocto Project (if they exist), + go to the + Yocto Project documentation page + and use the drop-down "Active Releases" button + and choose the Yocto Project version for which you want + the manual. + + + + + + + + + + + +
+ Welcome! + + + Welcome! + This short document steps you through the process for a typical + image build using the Yocto Project. + The build uses Poky, which is the reference embedded OS that is + completely specified. + + The examples in this paper assume you are using a native Linux + system running a recent Ubuntu Linux distribution. + If the machine you want to use + Yocto Project on to build an image is not a native Linux + system, you can still perform these steps by using CROss + PlatformS (CROPS) and setting up a Poky container. + See the + Setting Up to Use CROss PlatformS (CROPS)" + section in the Yocto Project Development Tasks Manual for more + information. + + + + + If you want more conceptual or background information on the + Yocto Project, see the + Getting Started With Yocto Project Manual. + +
+ +
+ Compatible Linux Distribution + + + Make sure your build system meets the following requirements: + + + 50 Gbytes of free disk space + + + Runs a supported Linux distribution (i.e. recent releases of + Fedora, openSUSE, CentOS, Debian, or Ubuntu). For a list of + Linux distributions that support the Yocto Project, see the + "Supported Linux Distributions" + section in the Yocto Project Reference Manual. + + + + + Git 1.8.3.1 or greater + + + tar 1.27 or greater + + + Python 3.4.0 or greater. + + + If your build host does not meet any of these three listed + version requirements, you can take steps to prepare the + system so that you can still use the Yocto Project. + See the + "Required Git, tar, and Python Versions" + section in the Yocto Project Reference Manual for information. + + + +
+ +
+ Build System Packages + + + You must install essential host packages on your + development host. + The following command installs the host packages based on an + Ubuntu distribution: + + For host package requirements on all supported Linux + distributions, see the + "Required Packages for the Host Development System" + section in the Yocto Project Reference Manual. + + + $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL; libsdl1.2-dev xterm + + +
+ +
+ Use Git to Clone Poky + + + Once you complete the setup instructions for your machine, + you need to get a copy of the Poky repository on your build + system. + Use the following commands to clone the Poky + repository and then checkout the &DISTRO_REL_TAG; release: + + $ git clone git://git.yoctoproject.org/poky + Cloning into 'poky'... + remote: Counting objects: 361782, done. + remote: Compressing objects: 100% (87100/87100), done. + remote: Total 361782 (delta 268619), reused 361439 (delta 268277) + Receiving objects: 100% (361782/361782), 131.94 MiB | 6.88 MiB/s, done. + Resolving deltas: 100% (268619/268619), done. + Checking connectivity... done. + $ git checkout tags/yocto-2.5 -b my-yocto-2.5 + + The previous Git checkout command creates a local branch + named my-&DISTRO_REL_TAG;. The files available to you in that + branch exactly match the repository's files in the + "&DISTRO_NAME_NO_CAP;" development branch at the time of the + Yocto Project &DISTRO; release. + + + + For more options and information about accessing Yocto + Project related repositories, see the + "Working With Yocto Project Source Files" + section in the Yocto Project Development Tasks Manual. + +
+ +
+ Building Your Image + + + Use the following steps to build your image. + The OpenEmbedded build system creates an entire Linux + distribution, including the toolchain, from source. + + + + If you are working behind a firewall and your build + host is not set up for proxies, you could encounter + problems with the build process when fetching source + code (e.g. fetcher failures or Git failures). + + + If you do not know your proxy settings, consult your + local network infrastructure resources and get that + information. + A good starting point could also be to check your + web browser settings. + Finally, you can find more information on the + "Working Behind a Network Proxy" + wiki page. + + + + + + + + + Initialize the Build Environment: + Run the + &OE_INIT_FILE; + environment setup script to define the OpenEmbedded + build environment on your build host. + + $ source &OE_INIT_FILE; + + Among other things, the script creates the + Build Directory, + which is build in this case + and is located in the + Source Directory. + After the script runs, your current working directory + is set to the Build Directory. + Later, when the build completes, the Build Directory + contains all the files created during the build. + + + Examine Your Local Configuration File: + When you set up the build environment, a local + configuration file named + local.conf becomes available in + a conf subdirectory of the + Build Directory. + For this quick start, the defaults are set to build + for a qemux86 target, which is + suitable for emulation. + The package manager used is set to the RPM package + manager. + + + Start the Build: + Continue with the following command to build an OS image + for the target, which is + core-image-sato in this example: + + $ bitbake core-image-sato + + For information on using the + bitbake command, see the + "BitBake" + section in the Yocto Project Overview Manual, or + see the + "BitBake Command" + section in the BitBake User Manual. + + + Simulate Your Image Using QEMU: + Once this particular image is built, you can start + QEMU, which is a Quick EMUlator that ships with + the Yocto Project: + + $ runqemu qemux86 + + If you want to learn more about running QEMU, see the + "Using the Quick EMUlator (QEMU)" + chapter in the Yocto Project Development Tasks Manual. + + + Exit QEMU: + Exit QEMU by either clicking on the shutdown icon or by + typing Ctrl-C in the QEMU + transcript window from which you evoked QEMU. + + + +
+ +
+ Where To Go Next + + + Now that you have experienced using the Yocto Project, you might + be asking yourself "What now?" + The Yocto Project has many sources of information including + the website, wiki pages, and user manuals: + + + Website: + The + Yocto Project Website + provides background information, the latest builds, + breaking news, full development documentation, and + access to a rich Yocto Project Development Community + into which you can tap. + + + Developer Screencast: + The + Getting Started with the Yocto Project - New Developer Screencast Tutorial + provides a 30-minute video created for users unfamiliar + with the Yocto Project but familiar with Linux build + hosts. + While this screencast is somewhat dated, the + introductory and fundamental concepts are useful for + the beginner. + + + Yocto Project Wiki: + The + Yocto Project Wiki + provides additional information on where to go next + when ramping up with the Yocto Project, release + information, project planning, and QA information. + + + Yocto Project Mailing Lists: + Related mailing lists provide a forum for discussion, + patch submission and announcements. + Several mailing lists exist and are grouped according + to areas of concern. + See the + "Mailing lists" + section in the Yocto Project Reference Manual for a + complete list of Yocto Project mailing lists. + + + Comprehensive List of Links and Other Documentation: + The + "Links and Related Documentation" + section in the Yocto Project Reference Manual provides a + comprehensive list of all related links and other + user documentation. + + + +
+
+ diff --git a/documentation/brief-yoctoprojectqs/figures/yocto-project-transp.png b/documentation/brief-yoctoprojectqs/figures/yocto-project-transp.png new file mode 100755 index 0000000000..31d2b147fd Binary files /dev/null and b/documentation/brief-yoctoprojectqs/figures/yocto-project-transp.png differ diff --git a/documentation/brief-yoctoprojectqs/figures/ypqs-title.png b/documentation/brief-yoctoprojectqs/figures/ypqs-title.png new file mode 100644 index 0000000000..0156e261b1 Binary files /dev/null and b/documentation/brief-yoctoprojectqs/figures/ypqs-title.png differ -- cgit v1.2.3-54-g00ecf