Compare commits
40 Commits
bernard-5.
...
bernard
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c006044611 | ||
|
|
69cf476e36 | ||
|
|
0283822752 | ||
|
|
15c05fc10c | ||
|
|
cc6e20ea98 | ||
|
|
fc7f4b9711 | ||
|
|
4f1611cb8d | ||
|
|
5347bf352b | ||
|
|
d81e13a138 | ||
|
|
3d9db8b275 | ||
|
|
3faa84f835 | ||
|
|
10a8fb437e | ||
|
|
2c24e6b9b9 | ||
|
|
7f0a98f9ee | ||
|
|
47b2f03955 | ||
|
|
a02537187f | ||
|
|
78d092fe7a | ||
|
|
361eda901c | ||
|
|
373d73c7e7 | ||
|
|
b154d10232 | ||
|
|
00af854e96 | ||
|
|
4005aaf3f8 | ||
|
|
5c78a2b02d | ||
|
|
11355f3a7f | ||
|
|
a2283defe2 | ||
|
|
7ce789de38 | ||
|
|
4194c83a56 | ||
|
|
decb8953cd | ||
|
|
d6b531e6a1 | ||
|
|
d412b923ac | ||
|
|
cb69e75b7b | ||
|
|
9b33f20a73 | ||
|
|
00a8552b2b | ||
|
|
ec3aab7b04 | ||
|
|
5c51a88346 | ||
|
|
53bbe30ee7 | ||
|
|
1ca2d4316e | ||
|
|
87d0a3b594 | ||
|
|
c2c0b9f861 | ||
|
|
d1c356ad3d |
142
documentation/Makefile
Normal file
@@ -0,0 +1,142 @@
|
|||||||
|
# This is a single Makefile to handle all generated Yocto Project documents.
|
||||||
|
# The Makefile needs to live in the documents directory and all figures used
|
||||||
|
# in any manuals must be PNG files and live in the individual book's figures
|
||||||
|
# directory.
|
||||||
|
#
|
||||||
|
# The Makefile has these targets:
|
||||||
|
#
|
||||||
|
# pdf: generates a PDF version of a manual. Not valid for the Quick Start
|
||||||
|
# html: generates an HTML version of a manual.
|
||||||
|
# tarball: creates a tarball for the doc files.
|
||||||
|
# validate: validates
|
||||||
|
# publish: pushes generated files to the Yocto Project website
|
||||||
|
# clean: removes files
|
||||||
|
#
|
||||||
|
# The Makefile generates an HTML and PDF version of every document except the
|
||||||
|
# Yocto Project Quick Start. The Quick Start is in HTML form only. The variable
|
||||||
|
# The command-line argument DOC represents the folder name in which a particular
|
||||||
|
# document is stored. The command-line argument VER represents the distro
|
||||||
|
# version of the Yocto Release for which the manuals are being generated.
|
||||||
|
# You must invoke the Makefile with the DOC and VER arguments.
|
||||||
|
# Examples:
|
||||||
|
#
|
||||||
|
# make DOC=bsp-guide VER=1.1
|
||||||
|
# make DOC=yocto-project-qs VER=1.1
|
||||||
|
# make pdf DOC=yocto-project-qs VER=1.1
|
||||||
|
#
|
||||||
|
# The first example generates the HTML and PDF versions of the BSP Guide for
|
||||||
|
# the Yocto Project 1.1 Release. The second example generates the HTML version
|
||||||
|
# of the Quick Start. The third example generates an error because you cannot
|
||||||
|
# generate a PDF version of the Quick Start.
|
||||||
|
#
|
||||||
|
# Use the publish target to push the generated manuals to the Yocto Project
|
||||||
|
# website. All files needed for the manual's HTML form are pushed as well as the
|
||||||
|
# PDF version (if applicable).
|
||||||
|
# Examples:
|
||||||
|
#
|
||||||
|
# make publish DOC=bsp-guide VER=1.1
|
||||||
|
# make publish DOC=adt-manual VER=1.1
|
||||||
|
#
|
||||||
|
|
||||||
|
ifeq ($(DOC),bsp-guide)
|
||||||
|
XSLTOPTS = --stringparam html.stylesheet style.css \
|
||||||
|
--stringparam chapter.autolabel 1 \
|
||||||
|
--stringparam section.autolabel 1 \
|
||||||
|
--stringparam section.label.includes.component.label 1 \
|
||||||
|
--xinclude
|
||||||
|
ALLPREQ = html pdf tarball
|
||||||
|
TARFILES = style.css bsp-guide.html bsp-guide.pdf figures/bsp-title.png
|
||||||
|
MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
|
||||||
|
FIGURES = figures
|
||||||
|
STYLESHEET = $(DOC)/*.css
|
||||||
|
|
||||||
|
endif
|
||||||
|
|
||||||
|
ifeq ($(DOC),yocto-project-qs)
|
||||||
|
XSLTOPTS = --stringparam html.stylesheet style.css \
|
||||||
|
--xinclude
|
||||||
|
ALLPREQ = html tarball
|
||||||
|
TARFILES = 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
|
||||||
|
MANUALS = $(DOC)/$(DOC).html
|
||||||
|
FIGURES = figures
|
||||||
|
STYLESHEET = $(DOC)/*.css
|
||||||
|
endif
|
||||||
|
|
||||||
|
ifeq ($(DOC),poky-ref-manual)
|
||||||
|
XSLTOPTS = --stringparam html.stylesheet style.css \
|
||||||
|
--stringparam chapter.autolabel 1 \
|
||||||
|
--stringparam appendix.autolabel A \
|
||||||
|
--stringparam section.autolabel 1 \
|
||||||
|
--stringparam section.label.includes.component.label 1 \
|
||||||
|
--xinclude
|
||||||
|
ALLPREQ = html pdf tarball
|
||||||
|
TARFILES = poky-ref-manual.html style.css figures/poky-title.png figures/ss-sato.png
|
||||||
|
MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
|
||||||
|
FIGURES = figures
|
||||||
|
STYLESHEET = $(DOC)/*.css
|
||||||
|
endif
|
||||||
|
|
||||||
|
|
||||||
|
ifeq ($(DOC),adt-manual)
|
||||||
|
XSLTOPTS = --stringparam html.stylesheet style.css \
|
||||||
|
--stringparam chapter.autolabel 1 \
|
||||||
|
--stringparam appendix.autolabel A \
|
||||||
|
--stringparam section.autolabel 1 \
|
||||||
|
--stringparam section.label.includes.component.label 1 \
|
||||||
|
--xinclude
|
||||||
|
ALLPREQ = html pdf tarball
|
||||||
|
TARFILES = adt-manual.html adt-manual.pdf style.css figures/adt-title.png
|
||||||
|
MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
|
||||||
|
FIGURES = figures
|
||||||
|
STYLESHEET = $(DOC)/*.css
|
||||||
|
endif
|
||||||
|
|
||||||
|
ifeq ($(DOC),kernel-manual)
|
||||||
|
XSLTOPTS = --stringparam html.stylesheet style.css \
|
||||||
|
--stringparam chapter.autolabel 1 \
|
||||||
|
--stringparam appendix.autolabel A \
|
||||||
|
--stringparam section.autolabel 1 \
|
||||||
|
--stringparam section.label.includes.component.label 1 \
|
||||||
|
--xinclude
|
||||||
|
ALLPREQ = html pdf tarball
|
||||||
|
TARFILES = kernel-manual.html kernel-manual.pdf style.css figures/kernel-title.png figures/kernel-architecture-overview.png
|
||||||
|
MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
|
||||||
|
FIGURES = figures
|
||||||
|
STYLESHEET = $(DOC)/*.css
|
||||||
|
endif
|
||||||
|
|
||||||
|
|
||||||
|
##
|
||||||
|
# These URI should be rewritten by your distribution's xml catalog to
|
||||||
|
# match your localy installed XSL stylesheets.
|
||||||
|
XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
|
||||||
|
XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
|
||||||
|
|
||||||
|
all: $(ALLPREQ)
|
||||||
|
|
||||||
|
pdf:
|
||||||
|
ifeq ($(DOC),yocto-project-qs)
|
||||||
|
@echo " "
|
||||||
|
@echo "ERROR: You cannot generate a PDF file for the Yocto Project Quick Start"
|
||||||
|
@echo " "
|
||||||
|
else
|
||||||
|
cd $(DOC); ../tools/poky-docbook-to-pdf $(DOC).xml ../template; cd ..
|
||||||
|
endif
|
||||||
|
|
||||||
|
html:
|
||||||
|
# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
|
||||||
|
cd $(DOC); xsltproc $(XSLTOPTS) -o $(DOC).html $(DOC)-customization.xsl $(DOC).xml; cd ..
|
||||||
|
|
||||||
|
tarball: html
|
||||||
|
cd $(DOC); tar -cvzf $(DOC).tgz $(TARFILES); cd ..
|
||||||
|
|
||||||
|
validate:
|
||||||
|
cd $(DOC); xmllint --postvalid --xinclude --noout $(DOC).xml; cd ..
|
||||||
|
|
||||||
|
|
||||||
|
publish:
|
||||||
|
scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)
|
||||||
|
cd $(DOC); scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)/figures
|
||||||
|
|
||||||
|
clean:
|
||||||
|
rm -f $(MANUALS)
|
||||||
@@ -1,64 +0,0 @@
|
|||||||
# You must call this Makefile using the following form:
|
|
||||||
#
|
|
||||||
# make
|
|
||||||
# make html
|
|
||||||
# make pdf
|
|
||||||
# make tarball
|
|
||||||
# make clean
|
|
||||||
# make publish
|
|
||||||
#
|
|
||||||
# "make" creates the HTML, PDF, and tarballs.
|
|
||||||
# "make html" creates just the HTML
|
|
||||||
# "make pdf" creates just the PDF
|
|
||||||
# "make tarball" creates the tarball
|
|
||||||
# "make clean" removes the HTML and PDF files
|
|
||||||
# "make publish" pushes the HTML, PDF, figures, and stylesheet to the web server
|
|
||||||
#
|
|
||||||
|
|
||||||
XSLTOPTS = --stringparam html.stylesheet style.css \
|
|
||||||
--stringparam chapter.autolabel 1 \
|
|
||||||
--stringparam appendix.autolabel A \
|
|
||||||
--stringparam section.autolabel 1 \
|
|
||||||
--stringparam section.label.includes.component.label 1 \
|
|
||||||
--xinclude
|
|
||||||
VER = 1.0
|
|
||||||
DOC = adt-manual
|
|
||||||
ALLPREQ = html pdf tarball
|
|
||||||
TARFILES = adt-manual.html adt-manual.pdf style.css figures/adt-title.png
|
|
||||||
MANUALS = $(DOC).html $(DOC).pdf
|
|
||||||
FIGURES = figures
|
|
||||||
STYLESHEET = *.css
|
|
||||||
|
|
||||||
##
|
|
||||||
# These URI should be rewritten by your distribution's xml catalog to
|
|
||||||
# match your localy installed XSL stylesheets.
|
|
||||||
XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
|
|
||||||
XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
|
|
||||||
|
|
||||||
all: html pdf tarball
|
|
||||||
|
|
||||||
pdf:
|
|
||||||
../tools/poky-docbook-to-pdf adt-manual.xml ../template
|
|
||||||
|
|
||||||
##
|
|
||||||
# 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 adt-manual.html $(XSL_XHTML_URI) adt-manual.xml
|
|
||||||
xsltproc $(XSLTOPTS) -o adt-manual.html adt-manual-customization.xsl adt-manual.xml
|
|
||||||
|
|
||||||
tarball: html
|
|
||||||
cd $(DOC); tar -cvzf $(DOC).tgz $(TARFILES); cd ..
|
|
||||||
|
|
||||||
validate:
|
|
||||||
xmllint --postvalid --xinclude --noout adt-manual.xml
|
|
||||||
|
|
||||||
publish:
|
|
||||||
scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)
|
|
||||||
scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)/figures
|
|
||||||
|
|
||||||
clean:
|
|
||||||
rm -f $(MANUALS)
|
|
||||||
@@ -33,6 +33,16 @@
|
|||||||
<date>6 April 2011</date>
|
<date>6 April 2011</date>
|
||||||
<revremark>Initial Document released with Yocto Project 1.0 on 6 April 2011.</revremark>
|
<revremark>Initial Document released with Yocto Project 1.0 on 6 April 2011.</revremark>
|
||||||
</revision>
|
</revision>
|
||||||
|
<revision>
|
||||||
|
<revnumber>1.0.1</revnumber>
|
||||||
|
<date>23 May 2011</date>
|
||||||
|
<revremark>Released with Yocto Project 1.0.1 on 23 May 2011.</revremark>
|
||||||
|
</revision>
|
||||||
|
<revision>
|
||||||
|
<revnumber>1.0.2</revnumber>
|
||||||
|
<date>20 December 2011</date>
|
||||||
|
<revremark>Released with Yocto Project 1.0.2 on 20 December 2011.</revremark>
|
||||||
|
</revision>
|
||||||
</revhistory>
|
</revhistory>
|
||||||
|
|
||||||
<copyright>
|
<copyright>
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 8.4 KiB |
@@ -1,58 +0,0 @@
|
|||||||
# You must call this Makefile using the following form:
|
|
||||||
#
|
|
||||||
# make
|
|
||||||
# make html
|
|
||||||
# make pdf
|
|
||||||
# make tarball
|
|
||||||
# make clean
|
|
||||||
# make publish
|
|
||||||
#
|
|
||||||
# "make" creates the HTML, PDF, and tarballs.
|
|
||||||
# "make html" creates just the HTML
|
|
||||||
# "make pdf" creates just the PDF
|
|
||||||
# "make tarball" creates the tarball
|
|
||||||
# "make clean" removes the HTML and PDF files
|
|
||||||
# "make publish" pushes the HTML, PDF, figures, and stylesheet to the web server
|
|
||||||
#
|
|
||||||
|
|
||||||
XSLTOPTS = --stringparam html.stylesheet style.css \
|
|
||||||
--stringparam chapter.autolabel 1 \
|
|
||||||
--stringparam section.autolabel 1 \
|
|
||||||
--stringparam section.label.includes.component.label 1 \
|
|
||||||
--xinclude
|
|
||||||
|
|
||||||
VER = 1.0
|
|
||||||
DOC = bsp-guide
|
|
||||||
ALLPREQ = html pdf tarball
|
|
||||||
TARFILES = bsp-guide.html bsp-guide.pdf style.css figures/bsp-title.png
|
|
||||||
MANUALS = $(DOC).html $(DOC).pdf
|
|
||||||
FIGURES = figures
|
|
||||||
STYLESHEET = *.css
|
|
||||||
|
|
||||||
##
|
|
||||||
# These URI should be rewritten by your distribution's xml catalog to
|
|
||||||
# match your localy installed XSL stylesheets.
|
|
||||||
XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
|
|
||||||
XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
|
|
||||||
|
|
||||||
all: html pdf tarball
|
|
||||||
|
|
||||||
pdf:
|
|
||||||
../tools/poky-docbook-to-pdf bsp-guide.xml ../template
|
|
||||||
|
|
||||||
html:
|
|
||||||
# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
|
|
||||||
xsltproc $(XSLTOPTS) -o bsp-guide.html bsp-guide-customization.xsl bsp-guide.xml
|
|
||||||
|
|
||||||
tarball: html
|
|
||||||
cd $(DOC); tar -cvzf $(DOC).tgz $(TARFILES); cd ..
|
|
||||||
|
|
||||||
validate:
|
|
||||||
xmllint --postvalid --xinclude --noout bsp-guide.xml
|
|
||||||
|
|
||||||
publish:
|
|
||||||
scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)
|
|
||||||
scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)/figures
|
|
||||||
|
|
||||||
clean:
|
|
||||||
rm -f $(MANUALS)
|
|
||||||
@@ -39,6 +39,16 @@
|
|||||||
<date>6 April 2011</date>
|
<date>6 April 2011</date>
|
||||||
<revremark>This manual revision corresponds to the Yocto Project 1.0 Release.</revremark>
|
<revremark>This manual revision corresponds to the Yocto Project 1.0 Release.</revremark>
|
||||||
</revision>
|
</revision>
|
||||||
|
<revision>
|
||||||
|
<revnumber>1.0.1</revnumber>
|
||||||
|
<date>23 May 2011</date>
|
||||||
|
<revremark>Released with Yocto Project 1.0.1 on 23 May 2011.</revremark>
|
||||||
|
</revision>
|
||||||
|
<revision>
|
||||||
|
<revnumber>1.0.2</revnumber>
|
||||||
|
<date>20 December 2011</date>
|
||||||
|
<revremark>Released with Yocto Project 1.0.2 on 20 December 2011.</revremark>
|
||||||
|
</revision>
|
||||||
</revhistory>
|
</revhistory>
|
||||||
|
|
||||||
<copyright>
|
<copyright>
|
||||||
|
|||||||
@@ -60,15 +60,35 @@
|
|||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
meta-<bsp_name>
|
meta-<bsp_name>
|
||||||
</literallayout>
|
</literallayout>
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
"bsp_name" is a placeholder for the machine or platform name.
|
"bsp_name" is a placeholder for the machine or platform name.
|
||||||
Here are some example base directory names:
|
Here are some example base directory names:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
meta-emenlow
|
meta-emenlow
|
||||||
meta-intel_n450
|
meta-n450
|
||||||
meta-beagleboard
|
meta-beagleboard
|
||||||
</literallayout>
|
</literallayout>
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
The base directory (<filename>meta-<bsp_name></filename>) is the root of the BSP layer.
|
||||||
|
This root is what you add to the BBLAYERS variable in <filename>build/conf/bblayers.conf</filename>
|
||||||
|
so that the build system recognizes the BSP definition and from it can build an image.
|
||||||
|
Here is an example:
|
||||||
|
<literallayout class='monospaced'>
|
||||||
|
BBLAYERS = " \
|
||||||
|
/usr/local/src/yocto/meta \
|
||||||
|
/usr/local/src/yocto/meta-yocto \
|
||||||
|
/usr/local/src/yocto/meta-<bsp_name> \
|
||||||
|
"
|
||||||
|
</literallayout>
|
||||||
|
For more detailed information on layers, see the
|
||||||
|
<ulink url='http://www.yoctoproject.org/docs/poky-ref-manual/poky-ref-manual.html#usingpoky-changes-layers'>
|
||||||
|
BitBake Layers</ulink> section of the Poky Reference Manual.
|
||||||
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
Below is the common form for the file structure inside a base directory.
|
Below is the common form for the file structure inside a base directory.
|
||||||
While you can use this basic form for the standard, realize that the actual structures
|
While you can use this basic form for the standard, realize that the actual structures
|
||||||
@@ -162,8 +182,8 @@ meta-<bsp_name>/binary/<bootable_images>
|
|||||||
<para>
|
<para>
|
||||||
This optional area contains useful pre-built kernels and user-space filesystem
|
This optional area contains useful pre-built kernels and user-space filesystem
|
||||||
images appropriate to the target system.
|
images appropriate to the target system.
|
||||||
This directory contains the Application Development Toolkit (ADT) and minimal
|
This directory typically contains graphical (e.g. sato) and minimal live images
|
||||||
live images when the BSP is has been "tar-balled" and placed on the Yocto Project website.
|
when the BSP tarball has been created and made available in the Yocto Project website.
|
||||||
You can use these kernels and images to get a system running and quickly get started
|
You can use these kernels and images to get a system running and quickly get started
|
||||||
on development tasks.
|
on development tasks.
|
||||||
</para>
|
</para>
|
||||||
@@ -197,7 +217,8 @@ meta-<bsp_name>/conf/layer.conf
|
|||||||
BBPATH := "${BBPATH}:${LAYERDIR}"
|
BBPATH := "${BBPATH}:${LAYERDIR}"
|
||||||
|
|
||||||
# We have a recipes directory containing .bb and .bbappend files, add to BBFILES
|
# We have a recipes directory containing .bb and .bbappend files, add to BBFILES
|
||||||
BBFILES := "${BBFILES} ${LAYERDIR}/recipes/*/*.bb \ ${LAYERDIR}/recipes/*/*.bbappend"
|
BBFILES := "${BBFILES} ${LAYERDIR}/recipes/*/*.bb \
|
||||||
|
${LAYERDIR}/recipes/*/*.bbappend"
|
||||||
|
|
||||||
BBFILE_COLLECTIONS += "bsp"
|
BBFILE_COLLECTIONS += "bsp"
|
||||||
BBFILE_PATTERN_bsp := "^${LAYERDIR}/"
|
BBFILE_PATTERN_bsp := "^${LAYERDIR}/"
|
||||||
@@ -535,14 +556,14 @@ FILESEXTRAPATHS := "${THISDIR}/${PN}"
|
|||||||
|
|
||||||
<para>
|
<para>
|
||||||
For cases where you can substitute something and still maintain functionality,
|
For cases where you can substitute something and still maintain functionality,
|
||||||
the Yocto Project website at
|
the Yocto Project website's
|
||||||
<ulink url='http://yoctoproject.org/download/board-support-package-bsp-downloads'></ulink>
|
<ulink url='http://www.yoctoproject.org/download/all?keys=&download_type=1&download_version='>BSP Download Page</ulink>
|
||||||
will make available a 'de-featured' BSP completely free of the encumbered IP.
|
makes available 'de-featured' BSPs that are completely free of any IP encumbrances.
|
||||||
In that case you can use the substitution directly and without any further licensing
|
For these cases you can use the substitution directly and without any further licensing
|
||||||
requirements.
|
requirements.
|
||||||
If present, this fully 'de-featured' BSP will be named appropriately different
|
If present, these fully 'de-featured' BSPs are named appropriately different
|
||||||
than the normal encumbered BSP.
|
as compared to the names of the respective encumbered BSPs.
|
||||||
If available, this substitution is the simplest and most preferred option.
|
If available, these substitutions are the simplest and most preferred options.
|
||||||
This, of course, assumes the resulting functionality meets requirements.
|
This, of course, assumes the resulting functionality meets requirements.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 17 KiB |
@@ -1,65 +0,0 @@
|
|||||||
# You must call this Makefile using the following form:
|
|
||||||
#
|
|
||||||
# make
|
|
||||||
# make html
|
|
||||||
# make pdf
|
|
||||||
# make tarball
|
|
||||||
# make clean
|
|
||||||
# make publish
|
|
||||||
#
|
|
||||||
# "make" creates the HTML, PDF, and tarballs.
|
|
||||||
# "make html" creates just the HTML
|
|
||||||
# "make pdf" creates just the PDF
|
|
||||||
# "make tarball" creates the tarball
|
|
||||||
# "make clean" removes the HTML and PDF files
|
|
||||||
# "make publish" pushes the HTML, PDF, figures, and stylesheet to the web server
|
|
||||||
#
|
|
||||||
|
|
||||||
XSLTOPTS = --stringparam html.stylesheet style.css \
|
|
||||||
--stringparam chapter.autolabel 1 \
|
|
||||||
--stringparam appendix.autolabel A \
|
|
||||||
--stringparam section.autolabel 1 \
|
|
||||||
--stringparam section.label.includes.component.label 1 \
|
|
||||||
--xinclude
|
|
||||||
|
|
||||||
VER = 1.0
|
|
||||||
DOC = kernel-manual
|
|
||||||
ALLPREQ = html pdf tarball
|
|
||||||
TARFILES = kernel-manual.html kernel-manual.pdf style.css figures/kernel-title.png figures/kernel-architecture-overview.png
|
|
||||||
MANUALS = $(DOC).html $(DOC).pdf
|
|
||||||
FIGURES = figures
|
|
||||||
STYLESHEET = *.css
|
|
||||||
|
|
||||||
##
|
|
||||||
# These URI should be rewritten by your distribution's xml catalog to
|
|
||||||
# match your localy installed XSL stylesheets.
|
|
||||||
XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
|
|
||||||
XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
|
|
||||||
|
|
||||||
all: html pdf tarball
|
|
||||||
|
|
||||||
pdf:
|
|
||||||
../tools/poky-docbook-to-pdf kernel-manual.xml ../template
|
|
||||||
|
|
||||||
##
|
|
||||||
# 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 kernel-manual.html yocto-project-kernel-manual-customization.xsl kernel-manual.xml
|
|
||||||
|
|
||||||
tarball: html
|
|
||||||
cd $(DOC); tar -cvzf $(DOC).tgz $(TARFILES); cd ..
|
|
||||||
|
|
||||||
validate:
|
|
||||||
xmllint --postvalid --xinclude --noout kernel-manual.xml
|
|
||||||
|
|
||||||
publish:
|
|
||||||
scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)
|
|
||||||
scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)/figures
|
|
||||||
|
|
||||||
clean:
|
|
||||||
rm -f $(MANUALS)
|
|
||||||
|
Before Width: | Height: | Size: 169 KiB |
|
Before Width: | Height: | Size: 8.4 KiB |
@@ -39,6 +39,16 @@
|
|||||||
<date>6 April 2011</date>
|
<date>6 April 2011</date>
|
||||||
<revremark>This revision corresponds with the Yocto Project 1.0 Release.</revremark>
|
<revremark>This revision corresponds with the Yocto Project 1.0 Release.</revremark>
|
||||||
</revision>
|
</revision>
|
||||||
|
<revision>
|
||||||
|
<revnumber>1.0.1</revnumber>
|
||||||
|
<date>23 May 2011</date>
|
||||||
|
<revremark>Released with Yocto Project 1.0.1 on 23 May 2011.</revremark>
|
||||||
|
</revision>
|
||||||
|
<revision>
|
||||||
|
<revnumber>1.0.2</revnumber>
|
||||||
|
<date>20 December 2011</date>
|
||||||
|
<revremark>Released with Yocto Project 1.0.2 on 20 December 2011.</revremark>
|
||||||
|
</revision>
|
||||||
</revhistory>
|
</revhistory>
|
||||||
|
|
||||||
<copyright>
|
<copyright>
|
||||||
|
|||||||
@@ -1,61 +0,0 @@
|
|||||||
# You must call this Makefile using the following form:
|
|
||||||
#
|
|
||||||
# make
|
|
||||||
# make html
|
|
||||||
# make pdf
|
|
||||||
# make tarball
|
|
||||||
# make clean
|
|
||||||
# make publish
|
|
||||||
#
|
|
||||||
# "make" creates the HTML, PDF, and tarballs.
|
|
||||||
# "make html" creates just the HTML
|
|
||||||
# "make pdf" creates just the PDF
|
|
||||||
# "make tarball" creates the tarball
|
|
||||||
# "make clean" removes the HTML and PDF files
|
|
||||||
# "make publish" pushes the HTML, PDF, figures, and stylesheet to the web server
|
|
||||||
#
|
|
||||||
|
|
||||||
XSLTOPTS = --stringparam html.stylesheet style.css \
|
|
||||||
--stringparam chapter.autolabel 1 \
|
|
||||||
--stringparam appendix.autolabel A \
|
|
||||||
--stringparam section.autolabel 1 \
|
|
||||||
--stringparam section.label.includes.component.label 1 \
|
|
||||||
--xinclude
|
|
||||||
|
|
||||||
VER = 1.0
|
|
||||||
DOC = poky-ref-manual
|
|
||||||
ALLPREQ = html pdf tarball
|
|
||||||
TARFILES = poky-ref-manual.html poky-ref-manual.pdf style.css figures/yocto-project-transp.png figures/poky-ref-manual.png screenshots/ss-sato.png
|
|
||||||
MANUALS = $(DOC).html $(DOC).pdf
|
|
||||||
FIGURES = figures
|
|
||||||
SCREENSHOTS = screenshots
|
|
||||||
STYLESHEET = *.css
|
|
||||||
|
|
||||||
##
|
|
||||||
# These URI should be rewritten by your distribution's xml catalog to
|
|
||||||
# match your localy installed XSL stylesheets.
|
|
||||||
XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
|
|
||||||
XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
|
|
||||||
|
|
||||||
all: html pdf tarball
|
|
||||||
|
|
||||||
pdf:
|
|
||||||
../tools/poky-docbook-to-pdf poky-ref-manual.xml ../template
|
|
||||||
|
|
||||||
html:
|
|
||||||
# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
|
|
||||||
xsltproc $(XSLTOPTS) -o poky-ref-manual.html poky-ref-manual-customization.xsl poky-ref-manual.xml
|
|
||||||
|
|
||||||
tarball: html
|
|
||||||
cd $(DOC); tar -cvzf $(DOC).tgz $(TARFILES); cd ..
|
|
||||||
|
|
||||||
validate:
|
|
||||||
xmllint --postvalid --xinclude --noout poky-ref-manual.xml
|
|
||||||
|
|
||||||
publish:
|
|
||||||
scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)
|
|
||||||
scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)/figures
|
|
||||||
scp -r $(SCREENSHOTS) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)/screenshots
|
|
||||||
|
|
||||||
clean:
|
|
||||||
rm -f $(MANUALS)
|
|
||||||
@@ -87,7 +87,7 @@ do_install() {
|
|||||||
The result of the build is automatically packaged.
|
The result of the build is automatically packaged.
|
||||||
And, if the application uses NLS for localization, packages with local information are
|
And, if the application uses NLS for localization, packages with local information are
|
||||||
generated (one package per language).
|
generated (one package per language).
|
||||||
Following is one example: (<filename>hello_2.2.bb</filename>)
|
Following is one example: (<filename>hello_2.3.bb</filename>)
|
||||||
</para>
|
</para>
|
||||||
<programlisting>
|
<programlisting>
|
||||||
DESCRIPTION = "GNU Helloworld application"
|
DESCRIPTION = "GNU Helloworld application"
|
||||||
@@ -349,9 +349,9 @@ RRECOMMENDS_task-custom-tools = "\
|
|||||||
</section>
|
</section>
|
||||||
|
|
||||||
<section id='usingpoky-extend-customimage-imagefeatures'>
|
<section id='usingpoky-extend-customimage-imagefeatures'>
|
||||||
<title>Customizing Images Using Custom IMAGE_FEATURES</title>
|
<title>Customizing Images Using Custom IMAGE_FEATURES and EXTRA_IMAGE_FEATURES</title>
|
||||||
<para>
|
<para>
|
||||||
Ultimately users might want to add extra image "features" as used by Poky with the
|
Ultimately users might want to add extra image "features" to the set used by Poky with the
|
||||||
<glossterm><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></glossterm>
|
<glossterm><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></glossterm>
|
||||||
variable.
|
variable.
|
||||||
To create these features, the best reference is
|
To create these features, the best reference is
|
||||||
@@ -363,6 +363,9 @@ RRECOMMENDS_task-custom-tools = "\
|
|||||||
</glossterm> variable is generated automatically.
|
</glossterm> variable is generated automatically.
|
||||||
Users can add extra features by extending the class or creating a custom class for use
|
Users can add extra features by extending the class or creating a custom class for use
|
||||||
with specialized image <filename>.bb</filename> files.
|
with specialized image <filename>.bb</filename> files.
|
||||||
|
You can also add more features by configuring the
|
||||||
|
<glossterm><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></glossterm>
|
||||||
|
variable in the <filename>local.conf</filename> file.
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
Poky ships with two SSH servers you can use in your images: Dropbear and OpenSSH.
|
Poky ships with two SSH servers you can use in your images: Dropbear and OpenSSH.
|
||||||
@@ -754,7 +757,7 @@ BBFILE_PRIORITY_emenlow = "6"
|
|||||||
Experience shows that buildbot is a good fit for this role.
|
Experience shows that buildbot is a good fit for this role.
|
||||||
What works well is to configure buildbot to make two types of builds:
|
What works well is to configure buildbot to make two types of builds:
|
||||||
incremental and full (from scratch).
|
incremental and full (from scratch).
|
||||||
See <ulink url='http://autobuilder.pokylinux.org:8010'>poky autobuilder</ulink>
|
See <ulink url='http://autobuilder.yoctoproject.org:8010'>poky autobuilder</ulink>
|
||||||
for an example implementation that uses buildbot.
|
for an example implementation that uses buildbot.
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
|
|||||||
@@ -413,6 +413,57 @@
|
|||||||
</answer>
|
</answer>
|
||||||
</qandaentry>
|
</qandaentry>
|
||||||
|
|
||||||
|
<qandaentry>
|
||||||
|
<question>
|
||||||
|
<para>
|
||||||
|
Why don't you support directories with spaces in the pathnames?
|
||||||
|
</para>
|
||||||
|
</question>
|
||||||
|
<answer>
|
||||||
|
<para>
|
||||||
|
We have tried to do this before but too many of the tools we depend on such as autoconf
|
||||||
|
break when they find spaces in pathnames.
|
||||||
|
Until that situation changes we will not support spaces in pathnames.
|
||||||
|
</para>
|
||||||
|
</answer>
|
||||||
|
</qandaentry>
|
||||||
|
|
||||||
|
<qandaentry>
|
||||||
|
<question>
|
||||||
|
<para>
|
||||||
|
How do I use an external toolchain?
|
||||||
|
</para>
|
||||||
|
</question>
|
||||||
|
<answer>
|
||||||
|
<para>
|
||||||
|
The toolchain configuration is very flexible and customizable.
|
||||||
|
It is primarily controlled with the TCMODE variable.
|
||||||
|
This variable controls which file to include
|
||||||
|
(<filename>conf/distro/include/tcmode-*.inc</filename>).
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
The default value of TCMODE is "default".
|
||||||
|
However, other patterns are accepted.
|
||||||
|
In particular, "external-*" refers to external toolchains of which there are some basic examples
|
||||||
|
included with the core.
|
||||||
|
A user can use their own custom toolchain definition in their own layer
|
||||||
|
(or <filename>local.conf</filename> directory) at the location
|
||||||
|
<filename>conf/distro/include/tcmode-*.inc</filename>.
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
In addition to the toolchain configuration, you also need a corresponding toolchain recipe file.
|
||||||
|
This recipe file needs to package up any pre-built objects in the toolchain such as
|
||||||
|
<filename>libgcc</filename>, <filename>libstdcc++</filename>,
|
||||||
|
any locales and <filename>libc</filename>.
|
||||||
|
An example is the <filename>external-csl-toolchain_2008q3-72.bb</filename>, which reuses the core
|
||||||
|
<filename>libc</filename> packaging class to do most of the work.
|
||||||
|
</para>
|
||||||
|
</answer>
|
||||||
|
</qandaentry>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<qandaentry>
|
<qandaentry>
|
||||||
<question>
|
<question>
|
||||||
<para>
|
<para>
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 5.3 KiB |
|
Before Width: | Height: | Size: 17 KiB |
BIN
documentation/poky-ref-manual/figures/poky-title.png
Normal file
|
After Width: | Height: | Size: 9.5 KiB |
|
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 38 KiB |
|
Before Width: | Height: | Size: 8.4 KiB |
@@ -59,7 +59,7 @@
|
|||||||
<screenshot>
|
<screenshot>
|
||||||
<mediaobject>
|
<mediaobject>
|
||||||
<imageobject>
|
<imageobject>
|
||||||
<imagedata fileref="screenshots/ss-sato.png" format="PNG" align='center' scalefit='1' width="100%" contentdepth="100%"/>
|
<imagedata fileref="figures/ss-sato.png" format="PNG" align='center' scalefit='1' width="100%" contentdepth="100%"/>
|
||||||
</imageobject>
|
</imageobject>
|
||||||
<caption>
|
<caption>
|
||||||
<para>The Sato Desktop - A screenshot from a machine running a Poky built image</para>
|
<para>The Sato Desktop - A screenshot from a machine running a Poky built image</para>
|
||||||
|
|||||||
@@ -9,14 +9,14 @@
|
|||||||
|
|
||||||
<mediaobject>
|
<mediaobject>
|
||||||
<imageobject>
|
<imageobject>
|
||||||
<imagedata fileref='figures/poky-ref-manual.png'
|
<imagedata fileref='figures/poky-title.png'
|
||||||
format='SVG'
|
format='SVG'
|
||||||
align='center' scalefit='1' width='100%'/>
|
align='left' scalefit='1' width='100%'/>
|
||||||
</imageobject>
|
</imageobject>
|
||||||
</mediaobject>
|
</mediaobject>
|
||||||
|
|
||||||
<title>Poky Reference Manual</title>
|
<title></title>
|
||||||
<subtitle>A Guide and Reference to Poky</subtitle>
|
|
||||||
<authorgroup>
|
<authorgroup>
|
||||||
<author>
|
<author>
|
||||||
<firstname>Richard</firstname> <surname>Purdie</surname>
|
<firstname>Richard</firstname> <surname>Purdie</surname>
|
||||||
@@ -52,6 +52,16 @@
|
|||||||
<date>6 April 2011</date>
|
<date>6 April 2011</date>
|
||||||
<revremark>Released with Yocto Project 1.0 (Bernard 5.0).</revremark>
|
<revremark>Released with Yocto Project 1.0 (Bernard 5.0).</revremark>
|
||||||
</revision>
|
</revision>
|
||||||
|
<revision>
|
||||||
|
<revnumber>1.0.1</revnumber>
|
||||||
|
<date>23 May 2011</date>
|
||||||
|
<revremark>Released with Yocto Project 1.0.1 on 23 May 2011.</revremark>
|
||||||
|
</revision>
|
||||||
|
<revision>
|
||||||
|
<revnumber>1.0.2</revnumber>
|
||||||
|
<date>20 December 2011</date>
|
||||||
|
<revremark>Released with Yocto Project 1.0.2 on 20 December 2011.</revremark>
|
||||||
|
</revision>
|
||||||
</revhistory>
|
</revhistory>
|
||||||
|
|
||||||
<copyright>
|
<copyright>
|
||||||
|
|||||||
@@ -211,12 +211,14 @@
|
|||||||
<title>Reference: Images</title>
|
<title>Reference: Images</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The contents of images generated by Poky can be controlled by the <glossterm
|
The contents of images generated by Poky can be controlled by the
|
||||||
linkend='var-IMAGE_FEATURES'><link
|
<glossterm linkend='var-IMAGE_FEATURES'><link linkend='var-IMAGE_FEATURES'>
|
||||||
linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></glossterm>
|
IMAGE_FEATURES</link></glossterm> variable and the in local.conf and the
|
||||||
variable in local.conf. Through this you can add several different
|
<glossterm linkend='var-EXTRA_IMAGE_FEATURES'><link linkend='var-EXTRA_IMAGE_FEATURES'>
|
||||||
predefined packages such as development utilities or packages with debug
|
EXTRA_IMAGE_FEATURES</link></glossterm> that you typically configure in your image recipes.
|
||||||
information needed to investigate application problems or profile applications.
|
Through these varibales you can add several different
|
||||||
|
predefined packages such as development utilities or packages with debug
|
||||||
|
information needed to investigate application problems or profile applications.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
|
|||||||
@@ -20,7 +20,7 @@
|
|||||||
you must make the following changes in the <filename>local.conf</filename> file
|
you must make the following changes in the <filename>local.conf</filename> file
|
||||||
before using the BitBake command to build the minimal or base image:
|
before using the BitBake command to build the minimal or base image:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
1. Comment out the IMAGE_EXTRA_FEATURES line
|
1. Comment out the EXTRA_IMAGE_FEATURES line
|
||||||
2. Set INCOMPATIBLE_LICENSE = "GPLv3"
|
2. Set INCOMPATIBLE_LICENSE = "GPLv3"
|
||||||
</literallayout>
|
</literallayout>
|
||||||
</note>
|
</note>
|
||||||
|
|||||||
@@ -314,7 +314,7 @@
|
|||||||
|
|
||||||
<para>
|
<para>
|
||||||
This directory receives any <filename>.rpm</filename> packages produced by Poky.
|
This directory receives any <filename>.rpm</filename> packages produced by Poky.
|
||||||
The packages re sorted into feeds for different architecture types.
|
The packages are sorted into feeds for different architecture types.
|
||||||
</para>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
|||||||
@@ -87,9 +87,22 @@
|
|||||||
|
|
||||||
<glossentry id='var-BBFILE_PRIORITY'><glossterm>BBFILE_PRIORITY</glossterm>
|
<glossentry id='var-BBFILE_PRIORITY'><glossterm>BBFILE_PRIORITY</glossterm>
|
||||||
<glossdef>
|
<glossdef>
|
||||||
<para>Assigns different priorities to recipe files in different layers.
|
<para>Assigns different priorities to recipe files in different layers.</para>
|
||||||
This variable is useful in situations where the same package might appear in multiple layers.
|
<para>This variable is useful in situations where the same package appears in
|
||||||
It allows you to choose what takes precedence.</para>
|
more than one layer.
|
||||||
|
Setting BBFILE_PRIORITY allows you to prioritize a
|
||||||
|
layer against other layers that contain the same package - effectively
|
||||||
|
letting you control the precedence for the multiple layers.
|
||||||
|
The precedence established through this variable stands regardless of a
|
||||||
|
layer's package version (PV variable).
|
||||||
|
For example, a layer that has a package with a higher PV value but for
|
||||||
|
which the BBFILE_PRIORITY is set to have a lower precedence still has a
|
||||||
|
lower precedence.</para>
|
||||||
|
<para>A larger value for the BBFILE_PRIORITY variable results in a higher
|
||||||
|
precedence.
|
||||||
|
For example, the value 6 has a higher precedence than the
|
||||||
|
value 5.
|
||||||
|
By default, the BBFILE_PRIORITY variable is set to the value 5.</para>
|
||||||
</glossdef>
|
</glossdef>
|
||||||
</glossentry>
|
</glossentry>
|
||||||
|
|
||||||
@@ -284,6 +297,49 @@
|
|||||||
</glossdef>
|
</glossdef>
|
||||||
</glossentry>
|
</glossentry>
|
||||||
|
|
||||||
|
<glossentry id='var-EXTRA_IMAGE_FEATURES'><glossterm>EXTRA_IMAGE_FEATURES</glossterm>
|
||||||
|
<glossdef>
|
||||||
|
<para>Allows extra packages to be added to the generated images.
|
||||||
|
You set this variable in the <filename>local.conf</filename>
|
||||||
|
configuration file.
|
||||||
|
Note that some image features are also added using the
|
||||||
|
<link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link>
|
||||||
|
variable generally configured in image recipes.
|
||||||
|
You can use the EXTRA_IMAGE_FEATURES variable to add more features
|
||||||
|
in addition to those.
|
||||||
|
Here are some exmaples of features you can add:</para>
|
||||||
|
<literallayout class='monospaced'>
|
||||||
|
"dbg-pkgs" - Adds -dbg packages for all installed packages
|
||||||
|
including symbol information for debugging and
|
||||||
|
profiling.
|
||||||
|
|
||||||
|
"dev-pkgs" - Adds -dev packages for all installed packages.
|
||||||
|
This is useful if you want to develop against
|
||||||
|
the libraries in the image.
|
||||||
|
|
||||||
|
"tools-sdk" - Adds development tools such as gcc, make,
|
||||||
|
pkgconfig and so forth.
|
||||||
|
|
||||||
|
"tools-debug" - Adds debugging tools such as gdb and
|
||||||
|
strace.
|
||||||
|
|
||||||
|
"tools-profile" - Adds profiling tools such as oprofile,
|
||||||
|
exmap, lttng and valgrind (x86 only).
|
||||||
|
|
||||||
|
"tools-testapps" - Adds useful testing tools such as ts_print,
|
||||||
|
aplay, arecord and so forth.
|
||||||
|
|
||||||
|
"debug-tweaks" - Makes an image suitable for development.
|
||||||
|
For example, ssh root access has a blank
|
||||||
|
password. There are other application
|
||||||
|
targets too, see meta/classes/poky-image.bbclass
|
||||||
|
and meta/packages/tasks/task-poky.bb
|
||||||
|
for more details.
|
||||||
|
</literallayout>
|
||||||
|
|
||||||
|
</glossdef>
|
||||||
|
</glossentry>
|
||||||
|
|
||||||
<glossentry id='var-EXTRA_OECMAKE'><glossterm>EXTRA_OECMAKE</glossterm>
|
<glossentry id='var-EXTRA_OECMAKE'><glossterm>EXTRA_OECMAKE</glossterm>
|
||||||
<glossdef>
|
<glossdef>
|
||||||
<para>Additional cmake options</para>
|
<para>Additional cmake options</para>
|
||||||
@@ -343,7 +399,11 @@
|
|||||||
<glossentry id='var-IMAGE_FEATURES'><glossterm>IMAGE_FEATURES</glossterm>
|
<glossentry id='var-IMAGE_FEATURES'><glossterm>IMAGE_FEATURES</glossterm>
|
||||||
<glossdef>
|
<glossdef>
|
||||||
<para><link linkend="ref-features-image">List of
|
<para><link linkend="ref-features-image">List of
|
||||||
features</link> present in resulting images</para>
|
features</link> present in resulting images.
|
||||||
|
Typically you configure this variable in image recipes.
|
||||||
|
Note that you can add extra features to the image by using the
|
||||||
|
<link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link>
|
||||||
|
variable.</para>
|
||||||
</glossdef>
|
</glossdef>
|
||||||
</glossentry>
|
</glossentry>
|
||||||
|
|
||||||
|
|||||||
@@ -97,7 +97,7 @@
|
|||||||
<para><glossterm linkend='var-BBFILES'><link linkend='var-BBFILES'>BBFILES</link></glossterm></para>
|
<para><glossterm linkend='var-BBFILES'><link linkend='var-BBFILES'>BBFILES</link></glossterm></para>
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para><glossterm linkend='var-IMAGE_FEATURES'><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></glossterm></para>
|
<para><glossterm linkend='var-EXTRA_IMAGE_FEATURES'><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></glossterm></para>
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para><glossterm linkend='var-PACKAGE_CLASSES'><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></glossterm></para>
|
<para><glossterm linkend='var-PACKAGE_CLASSES'><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></glossterm></para>
|
||||||
|
|||||||
@@ -74,10 +74,11 @@
|
|||||||
<ulink url='http://yoctoproject.org'>The Yocto Project website</ulink> - The home site
|
<ulink url='http://yoctoproject.org'>The Yocto Project website</ulink> - The home site
|
||||||
for Yocto Project.
|
for Yocto Project.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<!-- <listitem><para>
|
||||||
<ulink url='http://pokylinux.org'>The Poky website</ulink> - The home site
|
<ulink url='http://pokylinux.org'>The Poky website</ulink> - The home site
|
||||||
for Poky Linux.
|
for Poky Linux.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
|
-->
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
<ulink url='http://www.openedhand.com/'>OpenedHand</ulink> - The
|
<ulink url='http://www.openedhand.com/'>OpenedHand</ulink> - The
|
||||||
original company behind Poky.
|
original company behind Poky.
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 94 KiB |
|
Before Width: | Height: | Size: 75 KiB |
|
Before Width: | Height: | Size: 50 KiB |
@@ -122,13 +122,13 @@ h6 {
|
|||||||
background-color: transparent;
|
background-color: transparent;
|
||||||
background-repeat: no-repeat;
|
background-repeat: no-repeat;
|
||||||
padding-top: 256px;
|
padding-top: 256px;
|
||||||
background-image: url("figures/poky-ref-manual.png");
|
background-image: url("figures/poky-title.png");
|
||||||
background-position: left top;
|
background-position: left top;
|
||||||
margin-top: -256px;
|
margin-top: -256px;
|
||||||
padding-right: 50px;
|
padding-right: 50px;
|
||||||
margin-left: 50px;
|
margin-left: 0px;
|
||||||
text-align: right;
|
text-align: right;
|
||||||
width: 600px;
|
width: 740px;
|
||||||
}
|
}
|
||||||
|
|
||||||
h3.author {
|
h3.author {
|
||||||
@@ -771,12 +771,22 @@ h6,
|
|||||||
h7{
|
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.preface .titlepage .title,
|
||||||
div.colophon .title,
|
div.colophon .title,
|
||||||
div.chapter .titlepage .title {
|
div.chapter .titlepage .title,
|
||||||
background-image: url("images/title-bg.png");
|
div.article .titlepage .title
|
||||||
background-position: bottom;
|
{
|
||||||
background-repeat: repeat-x;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
div.section div.section .titlepage .title,
|
div.section div.section .titlepage .title,
|
||||||
@@ -787,7 +797,7 @@ div.sect2 .titlepage .title {
|
|||||||
|
|
||||||
h1.title {
|
h1.title {
|
||||||
background-color: transparent;
|
background-color: transparent;
|
||||||
background-image: url("poky-ref-manual.png");
|
background-image: url("figures/poky-title.png");
|
||||||
background-repeat: no-repeat;
|
background-repeat: no-repeat;
|
||||||
height: 256px;
|
height: 256px;
|
||||||
text-indent: -9000px;
|
text-indent: -9000px;
|
||||||
|
|||||||
@@ -73,6 +73,14 @@
|
|||||||
So for example, before building <filename>matchbox-desktop</filename> BitBake
|
So for example, before building <filename>matchbox-desktop</filename> BitBake
|
||||||
would build a cross compiler and glibc if they had not already been built.
|
would build a cross compiler and glibc if they had not already been built.
|
||||||
</para>
|
</para>
|
||||||
|
<para>
|
||||||
|
A useful BitBake option to consider is the <filename>-k</filename> or
|
||||||
|
<filename>‐‐continue</filename> option.
|
||||||
|
This option instructs BitBake to try and continue processing the job as much
|
||||||
|
as possible even after encountering an error. When an error occurs the target that
|
||||||
|
failed and those that depend on it cannot be remade. However, when you use this
|
||||||
|
option other dependencies can still be processed.
|
||||||
|
</para>
|
||||||
|
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
|||||||
@@ -1,53 +0,0 @@
|
|||||||
# You must call this Makefile using the following form:
|
|
||||||
#
|
|
||||||
# make
|
|
||||||
# make html
|
|
||||||
# make tarball
|
|
||||||
# make clean
|
|
||||||
# make publish
|
|
||||||
#
|
|
||||||
# "make" creates the HTML and tarball.
|
|
||||||
# "make html" creates just the HTML
|
|
||||||
# "make tarball" creates the tarball
|
|
||||||
# "make clean" removes the HTML file
|
|
||||||
# "make publish" pushes the HTML, figures, and stylesheet to the web server
|
|
||||||
#
|
|
||||||
|
|
||||||
XSLTOPTS = --stringparam html.stylesheet style.css \
|
|
||||||
--xinclude
|
|
||||||
|
|
||||||
VER = 1.0
|
|
||||||
DOC = yocto-quick-start
|
|
||||||
ALLPREQ = html pdf tarball
|
|
||||||
TARFILES = 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
|
|
||||||
MANUALS = yocto-project-qs.html
|
|
||||||
FIGURES = figures
|
|
||||||
STYLESHEET = *.css
|
|
||||||
|
|
||||||
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
|
|
||||||
cd $(DOC); tar -cvzf yocto-project-qs.tgz $(TARFILES); cd ..
|
|
||||||
|
|
||||||
validate:
|
|
||||||
xmllint --postvalid --xinclude --noout yocto-project-qs.xml
|
|
||||||
|
|
||||||
publish:
|
|
||||||
scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)
|
|
||||||
scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)/figures
|
|
||||||
|
|
||||||
clean:
|
|
||||||
rm -f $(MANUALS)
|
|
||||||
|
Before Width: | Height: | Size: 5.3 KiB |
|
Before Width: | Height: | Size: 18 KiB |
BIN
documentation/yocto-project-qs/figures/yocto-environment.png
Executable file → Normal file
|
Before Width: | Height: | Size: 62 KiB After Width: | Height: | Size: 71 KiB |
@@ -47,7 +47,7 @@
|
|||||||
The Yocto Project through the Poky build tool provides an open source development
|
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
|
environment targeting the ARM, MIPS, PowerPC and x86 architectures for a variety of
|
||||||
platforms including x86-64 and emulated ones.
|
platforms including x86-64 and emulated ones.
|
||||||
You can use components from the the Yocto Project to design, develop, build, debug, simulate,
|
You can use components from the Yocto Project to design, develop, build, debug, simulate,
|
||||||
and test the complete software stack using Linux, the X Window System, GNOME Mobile-based
|
and test the complete software stack using Linux, the X Window System, GNOME Mobile-based
|
||||||
application frameworks, and Qt frameworks.
|
application frameworks, and Qt frameworks.
|
||||||
</para>
|
</para>
|
||||||
@@ -188,10 +188,15 @@
|
|||||||
<title>Yocto Project Release</title>
|
<title>Yocto Project Release</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The latest release images for the Yocto Project are kept at
|
You can download the latest release images for the Yocto Project on the
|
||||||
<ulink url="http://yoctoproject.org/downloads/yocto-1.0/"></ulink>.
|
<ulink url="http://yoctoproject.org/download">Yocto Project Download page</ulink>.
|
||||||
Nightly and developmental builds are also maintained. However, for this
|
Just go to the page and click the "Yocto Downloads" link found in the "Download"
|
||||||
document a released version of Yocto Project is used.
|
navigation pane to the right to view all available Yocto Project releases.
|
||||||
|
Then, click the "Yocto Release" link for the release you want from the list to
|
||||||
|
begin the download.
|
||||||
|
Nightly and developmental builds are also maintained at
|
||||||
|
<ulink url="http://autobuilder.yoctoproject.org/nightly/"></ulink>.
|
||||||
|
However, for this document a released version of Yocto Project is used.
|
||||||
</para>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
</section>
|
</section>
|
||||||
@@ -253,9 +258,9 @@
|
|||||||
|
|
||||||
<para>
|
<para>
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
$ wget http://www.yoctoproject.org/downloads/poky/poky-bernard-5.0.tar.bz2
|
$ wget http://www.yoctoproject.org/downloads/poky/poky-bernard-5.0.2.tar.bz2
|
||||||
$ tar xjf poky-bernard-5.0.tar.bz2
|
$ tar xjf poky-bernard-5.0.2.tar.bz2
|
||||||
$ source poky-bernard-5.0/poky-init-build-env poky-5.0-build
|
$ source poky-bernard-5.0.2/poky-init-build-env poky-5.0.2-build
|
||||||
</literallayout>
|
</literallayout>
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
@@ -273,8 +278,8 @@
|
|||||||
<listitem><para>The first two commands extract the Yocto Project files from the
|
<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>
|
release tarball and place them into a subdirectory of your current directory.</para></listitem>
|
||||||
<listitem><para>The <command>source</command> command creates the
|
<listitem><para>The <command>source</command> command creates the
|
||||||
<filename>poky-5.0-build</filename> directory and executes the <command>cd</command>
|
<filename>poky-5.0.2-build</filename> directory and executes the <command>cd</command>
|
||||||
command to make <filename>poky-5.0-build</filename> the working directory.
|
command to make <filename>poky-5.0.2-build</filename> the working directory.
|
||||||
The resulting build directory contains all the files created during the build.
|
The resulting build directory contains all the files created during the build.
|
||||||
By default the target architecture is qemux86.
|
By default the target architecture is qemux86.
|
||||||
To change this default, edit the value of the MACHINE variable in the
|
To change this default, edit the value of the MACHINE variable in the
|
||||||
@@ -290,8 +295,12 @@
|
|||||||
<para>
|
<para>
|
||||||
Continue with the following command to build an OS image for the target, which is
|
Continue with the following command to build an OS image for the target, which is
|
||||||
<filename>poky-image-sato</filename> in this example.
|
<filename>poky-image-sato</filename> in this example.
|
||||||
|
For information on the <filename>‐k</filename> option use the
|
||||||
|
<filename>bitbake ‐‐help</filename> command or see
|
||||||
|
<ulink url='http://www.yoctoproject.org/docs/poky-ref-manual/poky-ref-manual.html#usingpoky-components-bitbake'>
|
||||||
|
BitBake</ulink> section in the Poky Reference Manual.
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
$ bitbake poky-image-sato
|
$ bitbake -k poky-image-sato
|
||||||
</literallayout>
|
</literallayout>
|
||||||
<note><para>
|
<note><para>
|
||||||
BitBake requires Python 2.6. For more information on this requirement,
|
BitBake requires Python 2.6. For more information on this requirement,
|
||||||
|
|||||||