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>
Providers of libgbm (including mesa) have move to the "virtual/libgbm"
name to provide this functionality. Update the documentation to prevent
confusion.
(From yocto-docs rev: afc290e85bc801549000a6f6d770e2975a313779)
Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add a basic variable definition and a small section to the development
tasks manual for using PACKAGE_ADD_METADATA to add custom metadata to
packages.
(From yocto-docs rev: c5e4d575a771ddd1c970389ce3ace6d6abe68769)
Signed-off-by: Michael Ho <Michael.Ho@bmw.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This outdated section contradicts the real behavior expressed in the next
paragraph
(From yocto-docs rev: 77e8a9e03b3bb6e6b6b2adf7796740fb362f189b)
Signed-off-by: Maxime Roussin-Bélanger <maxime.roussinbelanger@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update the npm:// URL and the generated npm recipe, and remove
references to NPM_SHRINKWRAP, NPM_LOCKDOWN and lockdown functionality in
general.
(From yocto-docs rev: bc09233543abbf28adfcc1e214f85ef4c7c56639)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
For stylistic reasons, clarify the use of both IMAGE_FEATURES versus
EXTRA_IMAGE_FEATURES when configuring a read-only rootfs.
(From yocto-docs rev: 4111e4e70a87400671455ddd873d802d40d6b587)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The apmd recipe is no longer appropriate to demonstrate the use of
SRC_URI checksum names as it has only a single SRC_URI URL, so pick a
more illuminating recipe.
(From yocto-docs rev: 7f391a0656442e7ee2f3dd48b848befb7f461aec)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Section 3.3.5, "Fetching Code", uses the cdrtools recipe as an example
for showing the use of PV, but that's a bad example since the current
cdrtools recipe file contains:
SRC_URI = " \
${SOURCEFORGE_MIRROR}/project/cdrtools/cdrtools-${REALPV}.tar.bz2 \
...
PV = "3.01a31+really3.01"
REALPV = "3.01"
which is not exactly the point the dev manual is trying to make, so
replace with simpler strace recipe.
(From yocto-docs rev: d865b0288a4162a8d4df9a2abde43875e3dc2ced)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Bump tar, Python versions and add new gcc requirement.
Update reference from 'required-git-tar-and-python-versions'
to 'required-git-tar-python-and-gcc-versions'
(From yocto-docs rev: 18b11662c7c9ab7828d2709eed4090116a751e14)
Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
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>
Migration to YP 2.5 contains incorrect description of routine for
delaying to first boot.
(From yocto-docs rev: 08f71ec137822c0c19b56956d7045dfb73a544d7)
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>
Make it clear to the reader that they can use the much shorter form of
${PN} for the base packagegroup name, rather than typing it out in
full.
(From yocto-docs rev: 19915978c30bbf37b65d9887c78a23394779f079)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add explanation of missing checks performed by yocto-check-layer, and
fix one typo.
(From yocto-docs rev: 231bb92fa4a9c044894f845b8d6d0b9498abfc49)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Given that the section in question is describing how to configure
dependencies based on the machine type, it seems inappropriate to use
an example that depends on the choice of C library, so grab a snippet
from linux-yocto.inc to really drive the point home.
(From yocto-docs rev: 66bfec015f61a690f96cf8e28b80869c77327e6d)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The link used in the documentation points to a file
that no longer exists on the crops repository.
Use the poky-container repo instead since it is more
accurate and updated
(From yocto-docs rev: 5d16ccecf0b198af0f78a4cce28532ab9dca739f)
Signed-off-by: Alejandro Hernandez Samaniego <alejandro@enedino.org>
Signed-off-by: Alejandro Hernandez Samaniego <alhe@linux.microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As the OEQA code revamp and code changes in testimage.bbclass,
testexport.bbclass, runtime/context.py and oeqa/runexported.py,
"QemuTarget" was obsolete and replaced by "qemu".
Replacing the refer of "QemuTarget" with "qemu".
(From yocto-docs rev: f89d18adb62bc864e7890a613ff860bd3e4279ed)
Signed-off-by: Yeoh Ee Peng <ee.peng.yeoh@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As the OEQA code revamp and code changes in testimage.bbclass,
testexport.bbclass, runtime/context.py and oeqa/runexported.py,
"SimpleRemoteTarget" was obsolete and replaced by "simpleremote".
Replacing the refer of "SimpleRemoteTarget" by "simpleremote".
(From yocto-docs rev: 41823811229754805c682ecec6903399bfe606fe)
Signed-off-by: Yeoh Ee Peng <ee.peng.yeoh@intel.com>
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>
Fixes [YOCTO #12760]
Updated the cmake.bbclass description to tell what directory
to insall custom CMake toolchain files into. Also, updated
the two areas in the "Writing a New Recipe" section that
mention CMake. Placed a couple notes there concerning the
same directory stuff.
(From yocto-docs rev: a65cd2c4c062d4ae388191b9d6708b4fadffaa3f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Alejandro Enedino Hernandez Samaniego <aehs29@gmail.com>
commited a change to these manuals (see
9e79e96cad66316c1b4ee608723edfa763f0f9ef) and did not
use YP documentation standards for the content. I cleaned
up the text and tabbing.
(From yocto-docs rev: 9c95799322e1830a5faae0980384ab10b6504007)
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>
The syntax to use multiconfig builds changed from multiconfig:foo:target
to mc:foo:target.
Clarify that BBMULTICONFIG defines additional configurations along with
the one coming from local.conf.
Fix these changes on both the dev manual and the reference manual.
(From yocto-docs rev: 9e79e96cad66316c1b4ee608723edfa763f0f9ef)
Signed-off-by: Alejandro Enedino Hernandez Samaniego <aehs29@gmail.com>
Signed-off-by: Ross Burton <ross.burton@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section needed the wording updated.
(From yocto-docs rev: dd9e09273e9e5d5b6b43bf508f50d4d57e0dc569)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the "Enabling GObject Introspection Support" section, a link
existed to the "Known Issues" section further down in the
chapter. The target of the link was missing and appeared as the
placeholder "xxx". I put in the proper link.
(From yocto-docs rev: 8d0d1b2104f08e888075bc0ae0bed4f0ec2f4ea6)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed in "Selecting an Initialization Manager" section.
Extraneous word needed removed.
(From yocto-docs rev: ab97d36299a7a648bc3f3325175d8ab633ad2d1a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added the "Creating node package manager (NPM) packages
section link to the list. Also, made some edits to make
the capitalization consistent in the list items.
(From yocto-docs rev: d3e345cd3f44e9588c5fe8f0560e1859df0ff496)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10098]
This is a new section in the development tasks manual that describes
how to create Node Package Manager (NPM) packages. I put the
section in the "Working with Packages" section.
(From yocto-docs rev: d7acd9f27418d414854d25bb27842407edfe7dda)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section "Upgrading Recipes" covers several ways of
upgrading a recipe. I added some stuff in the introductory
area that mentions the fact a user might want to check
the upgrade status of a recipe first.
(From yocto-docs rev: bd2fd8d0a91b64455c282ebf4974e40874274f46)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Ousted these since it was noted in the migration section that
the class had been removed. Modified all references to the
removed class as needed.
(From yocto-docs rev: 7000acc76da6b7ee850b799347ab9083663c7e6a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10098]
Inside the "Fetching Code" section we mention fetchers but have
no links for more information to the "Fetchers" section in the
BibBake User Manual. I have added a link.
(From yocto-docs rev: 5224bb7b7a3c0f081b066a45865fd326aa068fc9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The YP manual set was using the plugin term inconsistently.
It was appearing as "plugin" as well as "plug-in". The
plugins in the project are all named without a hyphen.
The term itself is either/or according to Google. I have
changed all references to plugin so that they do not use
a hyphen.
(From yocto-docs rev: 715bb58e2347c5e37a49da7d9e3e230503672337)
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>
I put a new introductory paragraph in the "Viewing Variables"
section that alludes to why you might want to see variables.
Also, I linked to the section "Modifying Variable Values" in
the BB manual.
(From yocto-docs rev: 6e18524ba62d2ff1231184467b0dd24dab33cfe6)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
