Since 2.5 (sumo), RDEPENDS_kernel-base has been replaced by
RDEPENDS_${KERNEL_PACKAGE_NAME}-base, so let's use this one instead.
(From yocto-docs rev: 0639160185969a6761e9911a166b897a015f4d59)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Patches provided in SRC_URI are only applied if their extension is .diff or
.patch. The examples do not use those extensions and would probably result
in user confusion as to why the patches aren't being applied to the
sources.
Let's fix this by giving them a .patch file extension.
(From yocto-docs rev: 0858e86ed8e3e3005207980041fe4f2117750663)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
When the license identifier tags were added, an incorrect string was used
and the Share-Alike clause was lost. Fix this to match the license
description in the files and add back the lost piece (its clear from
the history it should be there)
(From yocto-docs rev: 8d30c3d792755a7bfdb74b331dad98f51d3516af)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The Yocto Project documentation was migrated to Sphinx. Let's remove
the deprecated DocBook files.
(From yocto-docs rev: 28fb0e63b2fbfd6426b00498bf2682bb53fdd862)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Whenever a TOC follows a title/heading, a blank line is missing. So
let's add it explicitely.
(From yocto-docs rev: 600b6fe7837dd817d32350e1a45431bdcfe8ebbd)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The boilerplate looks better after the ToC, still not quite
right but the boilerplate can be improved from here.
(From yocto-docs rev: 5e81b9c90f6f45acf26ba146e280bc2659ac14e5)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The revision history tables look better in their own section,
move them.
(From yocto-docs rev: 27bf0f69b6dc04cea97a023ef52bec2b213d074f)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Use intersphinx extension to replace links to the Bitbake manual with
proper cross references.
(From yocto-docs rev: 458a6e540a2286ac838812d802306806f77b885c)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
When an hyperlink should be display in the output, there is no need to
any specific syntax or marker, the parser finds links and mail
addresses in ordinary text. Somehow the conversion from pandoc
generated wrong output in the form: ` <link>`__. This patch is
generated using the following Python regexp:
line = re.sub("` <(https?://.*)>`__",
"\\1",
line)
(From yocto-docs rev: a35d735a74425dff34c63c086947624467658c40)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In DocBook, variables are used to create custom links (note that it is
not consistent everywhere, since some web addresses are still
hardcoded), such as YOCTO_HOME_URL, YOCTO_GIT_URL, YOCTO_WIKI_URL,
YOCTO_BUGS_URL and YOCTO_DL_URL..
In Sphinx they are replaced with extlinks.
(From yocto-docs rev: d25f3095a9d29a3355581d0743f27b2a423ad580)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some links were not found by the regexp, especially because of they
are spanning across multiple lines. This patch is a manual fixup for
these patterns.
(From yocto-docs rev: 7a5cf8b372903d959d4a1f0882e6198f31f3cba5)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some term links have custom 'text', and require manual update, since
they were not caught by the generic Python regexp.
(From yocto-docs rev: 519355ba9daf7630e8d477b2f6f511be51fd8b2e)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Many of the internal links were not converted probably from DocBook
using pandoc. After looking at the various patterns, the follow series
of 'naive' Python regexp were used to perform some additional
automatic conversion.
Also, since we rely on built-in glossary, all links to terms need to
use the sphinx :term: syntax.
This commit is generated using the following Python series of regexp:
line = re.sub("`+(\w+)`* <(\&YOCTO_DOCS_REF_URL;)?#var-\\1>`__",
":term:`\\1`",
line)
line = re.sub("`+do_([a-z_]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-tasks-\\1>`__",
":ref:`ref-tasks-\\1`",
line)
line = re.sub("`+([a-z_\-\*\.]+).bbclass`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__",
":ref:`\\1.bbclass <ref-classes-\\1>`",
line)
line = re.sub("`+([a-z_\-\*\.]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__",
":ref:`\\1 <ref-classes-\\1>`",
line)
line = re.sub("`Source Directory <(\&YOCTO_DOCS_REF_URL;)?#source-directory>`__",
":term:`Source Directory`",
line)
line = re.sub("`Build Directory <(\&YOCTO_DOCS_REF_URL;)?#build-directory>`__",
":term:`Build Directory`",
line)
line = re.sub("`Metadata <(\&YOCTO_DOCS_REF_URL;)?#metadata>`__",
":term:`Metadata`",
line)
line = re.sub("`BitBake <(\&YOCTO_DOCS_REF_URL;)?#bitbake-term>`__",
":term:`BitBake`",
line)
line = re.sub("`Images <(\&YOCTO_DOCS_REF_URL;)?#ref-images>`__",
":ref:`ref-manual/ref-images:Images`",
line)
line = re.sub("`Classes <(\&YOCTO_DOCS_REF_URL;)?#ref-classes>`__",
":ref:`ref-manual/ref-classes:Classes`",
line)
line = re.sub("`workspace <(\&YOCTO_DOCS_REF_URL;)?#devtool-the-workspace-layer-structure>`__",
":ref:`devtool-the-workspace-layer-structure`",
line)
line = re.sub("`Open-?Embedded b?B?uild s?S?ystem <(\&YOCTO_DOCS_REF_URL;)?#build-system-term>`__",
":term:`OpenEmbedded Build System`",
line)
line = re.sub("`(OpenEmbedded-Core )?(\(?OE-Core\)? )?<(\&YOCTO_DOCS_REF_URL;)?#oe-core>`__",
":term:`OpenEmbedded-Core (OE-Core)`",
line)
It won't catch multiline strings, but it catches a very large number
of occurences!
(From yocto-docs rev: 3f537d17de5b1fb76ba3bee196481984a4826378)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
SPDX headers have been added to each file, and match the headers used
in the DocBook files.
(From yocto-docs rev: 79dbb0007ae24da4a3689a23e921f2a2638757f7)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is autogenerated pandoc to generate an inital set
of reST files based on DocBook XML files.
A .rst file is generated for each .xml files in all manuals with this
command:
cd <manual>
for i in *.xml; do \
pandoc -f docbook -t rst --shift-heading-level-by=-1 \
$i -o $(basename $i .xml).rst \
done
The conversion was done with: pandoc 2.9.2.1-91 (Arch Linux).
Also created an initial top level index file for each document, and
added all 'books' to the top leve index.rst file.
The YP manuals layout is organized as:
Book
Chapter
Section
Section
Section
Sphinx uses section headers to create the document structure.
ReStructuredText defines sections headers like that:
To break longer text up into sections, you use section headers. These
are a single line of text (one or more words) with adornment: an
underline alone, or an underline and an overline together, in dashes
"-----", equals "======", tildes "~~~~~~" or any of the
non-alphanumeric characters = - ` : ' " ~ ^ _ * + # < > that you feel
comfortable with. An underline-only adornment is distinct from an
overline-and-underline adornment using the same character. The
underline/overline must be at least as long as the title text. Be
consistent, since all sections marked with the same adornment style
are deemed to be at the same level:
Let's define the following convention when converting from Docbook:
Book => overline === (Title)
Chapter => overline *** (1.)
Section => ==== (1.1)
Section => ---- (1.1.1)
Section => ~~~~ (1.1.1.1)
Section => ^^^^ (1.1.1.1.1)
During the conversion with pandoc, we used --shift-heading-level=-1 to
convert most of DocBook headings automatically. However with this
setting, the Chapter header was removed, so I added it back
manually. Without this setting all headings were off by one, which was
more difficult to manually fix.
At least with this change, we now have the same TOC with Sphinx and
DocBook.
(From yocto-docs rev: 3c73d64a476d4423ee4c6808c685fa94d88d7df8)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update the author indo and use variables for author and email to make it
easier to change in future.
(From yocto-docs rev: 4fdf2a060705fa00b11b5a9d270f4ffa506c9927)
Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
KBUILD_DEFCONFIG is meant to refer to an *in-tree* defconfig file, not
an external one.
(From yocto-docs rev: 34202eee3fc2bb4e0b92374822bff87fd3af1ebc)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Given the defined DocBook entity:
<!ENTITY YOCTO_DOCS_URL "&YOCTO_HOME_URL;/docs">
replace numerous instances of the more verbose
"&YOCTO_HOME_URL;/documentation", which is a redirect, anyway.
rday
(From yocto-docs rev: 53fa17321624028b12d880bc4236fbef46675eb4)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update the "Manual Notes" section of numerous YP manuals with a
reference to the recently-introduced YP documentation mailing list.
(From yocto-docs rev: a10fe36c864b8f1a71c6a8eb7e1f6a4eef2f5171)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
meta-yocto commit 69ddecdb1516 [local.conf.sample: change default
MACHINE to qemux86-64] switched the default MACHINE from 'qemux86' to
'qemux86-64' but some documents which either explicitly mentioned the
default, or where this was implicit didn't receive an equivalent
update.
Where it made sense we continue this change in default to the docs. In
other places, such as the kernel-dev manual, we note the new default
and instruct the user how to switch back to 'qemux86'. Eventually we
should probably update the kernel-dev manual to use the default, but
for now the intention was to limit the impact of these changes.
Note that ext3 has also been replaced with ext4 for image generation,
so while we are modifying runqemu lines to qemux86-64 we also make the
change to reference ext4 such that the runqemu commands will function
properly.
(From yocto-docs rev: 8c1d8ab1170f47a2c2692beb903ab0b7c6835b7b)
Signed-off-by: Mark Asselstine <mark.asselstine@windriver.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scrubbed so subsequent releases are relevant to the
initial release only.
(From yocto-docs rev: 7bb2c4f851aa968eb05b11c5471b81962f268eba)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Updates to poky.ent
* Updates to mega-manual.sed
* Updates to all <manual>.xml files for date
(From yocto-docs rev: 5f752ef0193cb60cd5d46a63e99ffcd02107e0c2)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I was using "2.8" throughout the manual set instead
of "3.0". Updated all aspects to "3.0".
(From yocto-docs rev: db19937e98c59d4d2a9ce89877be3c8e0b05991a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
poky.ent - variables all set up for 2.8
mega-manual.sed - "2.7" replaced with "2.8"
<folder>.xml - manual revision history tables updated.
(From yocto-docs rev: 6092a9282cbd397a2f64ca74361f862ea76b0e28)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The help files for YP manuals used in the Eclipse application
are no longer supported. I removed the individual
*-customization.xsl files for the individual YP manuals.
(From yocto-docs rev: 8c19244298b2c95ac92a398a5b6d3aca788f075e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
unify the spacing for questions in various places
e.g. before the [Y/n] there should be a space, and before
"?" there should be none. Unify the questions where the
system expect an answer from the end user
(From yocto-docs rev: 0643b2e22273a798b96f126931885efd733e5f89)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #13146]
I added some information to the "Using menuconfig" section to
indicate two host packages that must be installed in order for
menuconfig to run.
(From yocto-docs rev: 4f5b12ebe8f8c0ab23001b8fc770295dc585429c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated poky.ent to have variables for 2.7.
Updated mega-manual.sed file to use "2.7" string.
Updated all <manual>.xml Manual History Tables to use "TBD"
(From yocto-docs rev: d6f8bbd6e107913265ea1ac95ab8817e199ff60b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
It was over simplistic.
(From yocto-docs rev: 1c17e3ef607d18c89c3e20d2d44eb5120779cd2c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This fix involved a few other manuals.
(From yocto-docs rev: d2659951a458a8db773e8c1b2b86a7b109d667fa)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The "Setting Up the Development Host to Use the Yocto Project" title
changed to "Preparing the Build Host". Fixed links in a lot of
other manual.
(From yocto-docs rev: 00e487e01a0e2a16f5b8d786b3124cbe5115b38b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Now that 2.5 has released, I replaced the ENTITY variable used for
the moving month and year with the actual release month and year
(i.e. May 2018).
(From yocto-docs rev: 2d6e8ddce4fce0c405d2aea69cea2a5b262410f7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The areas were found scrubbing the mega-manual. These were minor
fixes.
(From yocto-docs rev: aaa460be3f4a446c091d66a17ca6c010f335ccc4)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
1. Fixed the name of the "do_compile" task so that it was not
referenced as "do_compile()".
2. Fixed a link to the Source Repositories so that the link
used the ENTITY for the YP Git area and not a full-blown
hard-coded path.
(From yocto-docs rev: 4b8d0e61f3f3017954d36ed196a08fb0a04909dc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The "end" part of "linkend" was missing.
(From yocto-docs rev: 9411033faa6f71a52080c2f35a2af2f725399c7b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I was using the ENTITY with "cgit/cgi"/ appended to the end.
The appended part is not necessary. Removed it.
(From yocto-docs rev: 64593694d62c99cbe2897804c04fea24110ee861)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This involved changing the root manual folder from
"getting-started" to "overview-manual".
Also, every link using the ENTITY "YOCTO_DOCS_GS_URL" was
changed to "YOCTO_DOCS_OM_URL". Most manuals had several
occurrences of these links.
The makefile needed updating to process the new manual
and not process the old "getting-started" manual.
(From yocto-docs rev: 1abf64e56e9096258038ae37b787a81bf786bb3b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Throughout the documentation, the manual "Getting Started With
Yocto Project" was used. The manual now is called "Yocto Project
Overview and Concepts Manual".
(From yocto-docs rev: f47d10029487420cbeb292f680084b63be0ec7e9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed all the references to the top-level of the old
concepts-manual. These references are references that do not
have a "#" target. They just reference the manual in general.
(From yocto-docs rev: 5b33f3c119807532aa6feb2d010c9c9f780a26d8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was inconsistent use when referencing the getting-started
manual. The manual's name does not include the word
"Manual". So, I cleaned this up across the manual set and
also in the mega-manual.sed file, which was incorrectly
processing the links to that manual that do not target a
specific section.
(From yocto-docs rev: 0f5321416f7ec50cb6c96cccb7c87ef191a25367)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The original Yocto Project Quick Start is being retired for the
YP 2.5 release (sumo). I have purged all the various references
from the YP manual set and replaced them with references to the
appropriate doc. The references were mainly into the YP
dev-manual for setting up the host or for building an image.
There were a few references into the new "Yocto Project Quick
Build" document for overviewing manual-type references.
(From yocto-docs rev: 11c0ab693962f16f87f1e21f33dd5c6ca6a6f895)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I did some re-wording to account for when the user does a web
search for a manual and the search returns an ancient version
of the manual. Many times the user is oblivious of this fact
and is trying to use a version of the docs that don't come close
to matching the version of the YP.
(From yocto-docs rev: 1cbe06cefda2b35584a8365564e01888d229d0b3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This string is now being presented as "bsp_root_name" in the YP
manual set. A BSP name is essentially "meta-bsp_root_name".
It was being presented in the manual set as "meta-bsp_name",
which is not technically correct.
(From yocto-docs rev: 9ad25836b2b3ca79aa3430be014871f50205cf9e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Split this section into two sections: one for creating the layer
using bitbake-layers create-layer and one for adding the layer
to bblayers.conf using bitbake-layers add-layer.
Needed to update some references in the yocto-project-qs and
kernel-dev manuals.
(From yocto-docs rev: 741a29b0cbeaaeaa0ac9155036ace2623938aee3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I took out the sections at the end of the manual that talked
about the yocto-kernel tool. This tool is no longer maintained
and there is no equivalent tool. I also fixed the yocto-bsp
tool to be the bitbake-layers tool. This involved some
consolidation of sections.
I fixed some links in the kernel-dev and toaster-manual.
(From yocto-docs rev: 20cda99b301b6327d816c4a4cfb3511ad25c987c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
When I converted the Yocto Project Overview Manual to the Getting
Started With Yocto Project Manual, I updated the strings for
references from "&YOCTO_DOCS_OVERVIEW_URL" TO
"&YOCTO_DOCS_GS_URL". Unfortunately, I did it with a global command
that did not take into account the text the might follow the link
by saying "see such-and-such section in the Yocto Project Overview
Manual." So, I had to hand fix these.
Additionally, since I have moved a deeper concepts chapter that
was in the getting-started manual to a new Yocto Project Concepts
chapter, many of those links changed had to really go to the new
manual instead. Those were fixed.
(From yocto-docs rev: fca1c56b0764802fb6a687ea81ab0fb95186cf0a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Creation involved removing the overview-manual and replacing it
with the getting-started manual. All links to the string
"&YOCTO_DOCS_OVERVIEW_URL" had to be replaced with
"&YOCTO_DOCS_GS_URL" across the entire YP manual set. I renamed
files used to create the manual with prefixes suited for the
new manual name, which is "Getting Started With Yocto Project".
The style sheet for the new manual needed updating to display the
new .PNG image for the title page. The mega-manual file had to
be updated to include the files. The mega-manual.sed file had
to be updated to include the new manual and not use the overview
manual.
(From yocto-docs rev: 6c7abf9192390121000f577d6c98f259d290d15d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
Added a new chapter to the newly created Yocto Project Overview
Manual. This chapter originated from the YP Reference Manual and
was the old chapter 3, which talked a lot about various concepts.
This information is better suited for the new overview manual.
The change involved moving the entire chapter and renaming it.
This move of the content affected many, many external references
and links into the old area. Consequently, I had to recast all
these links from the different manual.
Changes also included fixing the mega-manual.xml file so that it
would include the new overview manual as part of it.
Many figures had to be relocated as part of the move as well. This
meant deleting them from the ref-manual/figures folder and putting
them into the overview-manual/figures folder.
(From yocto-docs rev: 87b81358f2bbd02b4a0d966d86c4d7b006d4d78f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The yocto-layers script is being deprecated in the 2.4 YP release
and the preferred script is now bitbake-layers. In particular, the
section that talks about creating a general layer was using
yocto-layers create. I have replaced it with bitbake-layers
create-layer command.
The bsp-guide and kernel-dev manual had links that used (in the
case of kernel-dev) and referenced yocto-layers. I had to change
these to reflect using bitbake-layers create-layers.
(From yocto-docs rev: 73ec4d0c8c2c093b7c9df86038d132f0da975273)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made the title page notes consistent across the manual set.
Made the author group information consistent as well. It is better
that authorship is seen as a third party and not tied to Intel
Corporation.
(From yocto-docs rev: 32cec087e384e1d92e3e84bbae5c6560a0af3136)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The name of the SDK manual changed and there was one link to the
manual that needed fixed.
(From yocto-docs rev: 800d5106a25ce4e87b0468ec3ab03dd8a49f3082)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The name of the dev-manual has changed to be the
"Yocto Project Development Tasks Manual". I have updated all the
areas in the kernel-dev manual that reference sections into the
dev-manual.
(From yocto-docs rev: f0309ab658a259637ba7f9301031887114ade988)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
With the redoing of the YP website, it was decided that the manuals
could only reference into the top-level and the top-level/documentation
URLs of the website. I removed all references to areas such as
projects (e.g. Toaster, VM, etc.) and any other URL that was not
the top-level landing page or the documentation page.
(From yocto-docs rev: 2bd838f1a9fb2698bab098b13b76c8852853e0e7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Various edits for review feedback on the manual in general.
(From yocto-docs rev: 218061535b5bed326331d00eee6f514c81299238)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The string in the manual revision table needed updated across the
set except for the kernel-dev manual.
(From yocto-docs rev: e087a707e02ff913baba2ac8bc6594206f53f70c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Using Scotty's Documentation Services, INC. and Scott Rifenbark
as the author. Added a note in the note box to send an email to
the yocto@yoctoproject.org discussion group or log into the freenode
(From yocto-docs rev: 657ef0a09a72c023dd2ab523ff3c7ad1e7a2efea)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Needed to remove an old example that was showing how two BSPs could
share the same KMACHINE value. I replaced it with corei7-based
machines. Also noted that KMACHINE is for kernel mapping only
whereas MACHINE is for the layer's BSP machine type.
(From yocto-docs rev: c1dad2815b6fd1ed78e0dce0fecb422f342eaf14)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Formatting changes for the list.
(From yocto-docs rev: df1201085408eec45d8fbf649e80437299daa0e8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section was written before the yocto-kernel-cache strategy
existed and was thus incorrect. I updated it with how I understand
things to work.
(From yocto-docs rev: 629f24c9312a168ddcd28b0d9dde92ff06068483)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section was using the "meta-*" stuff, which is not how it
is done any longer.
(From yocto-docs rev: c9d95e85a832a38c3fd099a728693af3fa708d50)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Introduced the "yocto-kernel-cache" term into the title.
(From yocto-docs rev: ca74c49e2809851bb22bbe0d68830127d7bba4e9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Went from 4.4 kernel to 4.12.
(From yocto-docs rev: 4cf2710a381925b8bf13536c1f8da3d12938fffe)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section had some old emenlo examples and was a little
confusing. I removed the old examples and inserted some new
wordings to help smooth it out.
(From yocto-docs rev: 365129e0cd37772f404d96a51eb498210e4f1ee9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I provided some background on two repositories: yocto-kernel-cache
and yocto-kernel-tools.
(From yocto-docs rev: 1741d6efd4ff8364a55d546897cab5e7cdee6da5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scrubbed this section to bring it up to speed with more modern
BSP examples and better explanation of the types of Metadata
used.
(From yocto-docs rev: ba009de68a3786f83d9c3c9debffa8b811479786)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
"cfg" and "features" used to reside in the linux-yocto-x.x repo
under meta. They are now in a separate repo named
yocto-kernel-cache. I rewrote a couple spots that incorrectly
referenced the old location.
(From yocto-docs rev: e643fc3df46658b8bcf9cdc12a78b527988b63a6)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section has merged into a single topic now. It still needs
work but it is gathered under one heading for now.
(From yocto-docs rev: 660ed8b64dedbab5400c84ec3759cea77c899c40)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section was largely redundant now. The small things that did
add value I placed in other areas of the chapter 2. One was a new
section on expanding variables using bitbake -e. Another was a bit
about the defconfig file. And a small procedure on how to create
config fragments using the "diffconfig" command was retained.
Links from the dev-manual and the ref-manual were adjusted as well.
(From yocto-docs rev: 7059d3eac1fec20089cabf197503f1bec747686d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided a new section on how to validate the configuration of the
kernel.
(From yocto-docs rev: 25f43d1baeff7d571fc60c7edca957d4ce6d6357)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section needed some formatting to conform to the list structure
used throughout the manual.
(From yocto-docs rev: b6e6b66014963c1628c50e09787fdd46a45867b1)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This procedure needed to be pulled out of the section that was/is
called "Using an Iterative Development Process". The section on
how to deal with "dirty" kernel version strings is a procedure
in its own right. It is now up a level.
(From yocto-docs rev: cd8834fa8d77ac750b06c3367aee577c80dcc64e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
File not used.
(From yocto-docs rev: 208bc193b02f4644e12c7d143d20ddafc5169907)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This chapter is not used and was commented out. I deleted the
comment block.
(From yocto-docs rev: c805d1034b9f9bed5990cd2bcb3a9088e3d0d542)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A lot of rewriting here in this section to get it up to speed.
Also, moved that final section on determining hardware and
non-hardware features into an appendix where it belonged.
(From yocto-docs rev: 752e80d6ae8f81a0de7743b11b010d0ef36b314b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Section "Using an 'In-Tree' defconfig File" updated to use a
more syntactically correct KBUILD_DEFCONFIG_KMACHINE example.
(From yocto-docs rev: 64e6b16703fa3ce9ac8db25de8089d32ac7aeafc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Should have been two commits but I forgot to do them separately.
1. I updated the YP Compatible Program section.
2. I moved the "Configuring the Kernel" section from the dev-manual
to the kernel-dev manual.
(From yocto-docs rev: cdb5bbc917db55a2ca987ce9b9ed371f9fca6524)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changes based on a run through of the procedure.
(From yocto-docs rev: 0a526bb15f597843d1e5da1eeca0a952c6c5016f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
