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>
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>
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: ca6334c1653d5e2abfe77865391509a8cd516d88)
Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
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>
Added the "yocto-2.6.2" tag to the example output since that
will be part of the overal list when 2.7 releases.
(From yocto-docs rev: 4863284811ad459cb0193528d5686a1ec008bb3e)
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>
Changes to the lists resulted in the testing and graphics &
Eclipse Plug-in lists going away. Also, I added several packages
based on some testing requirements to the "Essentials" list.
(From yocto-docs rev: cbc9a595bef3dd80f5eef1376e466627248f9fda)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Turns out I had some hard-coded stuff in these examples.
Furthermore, I did not have good enough detail in the
brief-yoctoprojectqs manual. I added more detail on how to get
that sato example going.
(From yocto-docs rev: 3dd6217be5e6f73ba3927431105096aec1445e10)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Windows Subsystem for Linux (WSL) is not compatible with the
Yocto Project. Added information in the beginning to note this
fact to the user.
(From yocto-docs rev: d8fcc0e3dc609086ca82a3419a337350f4e5c529)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The title needs to use the terminology "Build Host" to be consistent
with the manual set. I updated the title and the many links into that
section.
(From yocto-docs rev: 930030433e58e6180ee4f95e559d079c3899defc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed to "Locating Yocto Project Source Files". I am moving the
sections on cloning repositories out from under this section.
(From yocto-docs rev: 3889aadab9b603097b6cc5b7afb9d0066021106c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The term "OpenEmbedded build system" was being introduced with just a
link. Apparently, that is not enough for marketing. I added a
clause with some more information about it.
(From yocto-docs rev: e7a3a581d44e21976c3f6fe19330e19af1ae0773)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Softened the opening paragraph so it was not introducing any special
terms right off the bat. Renamed the section on the hardware layer
to configuring the build for specific hardware. Put in a link to
"build host" and used that term throughout.
(From yocto-docs rev: a324cb2f9c499dc8d68d1d87265930c308cbebb7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a section on adding a machine layer. Used Altera as an
example. Also, added a section on creating a general layer.
(From yocto-docs rev: fc36f006bd483a5c26d2b79a18431d16ec27dc00)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
this file was accidentally dropped during all the manual
reording operations. I have restored it.
(From yocto-docs rev: 5c1244f18ede1af0a540687cfb5d9071fbb3c1c0)
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>
Found a link to a deprecated "overview" manual. Replaced it with
the proper ENTITY to the getting-started manual.
Removed the ENTITY to the old "overview" manual.
(From yocto-docs rev: 891e4902052743833c422e6a557c93de42ed892d)
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>
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 QS (yocto-project-qs) has been retired for the YP
sumo (2.5) release. The manual has been replaced with the
brief, two-page quick build document (brief-yoctoprojectqs).
I needed to create a new title figure for the manual to include
as part of the mega-manual (bypqs-title.png). The figure was
added to the figures folder of both the bried-yoctoprojectqs
and mega-manual book folders. I also removed the old
ypqs-title.png file that was used for the original QS.
Updated the stylesheet doc for the brief build to include a
style using the new title .PNG file.
Updated the mega-manual.xml file to include the brief doc and
exclude the original QS.
(From yocto-docs rev: aadec4a70fa89e4dcd233c337d8971c8353ee26d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the title to "Yocto Project Quick Build" from "My First
Yocto Project Build", which sound a bit too much like "My first
little Pony."
(From yocto-docs rev: c797590d3cd341a9c492c7af49a927e1d241184e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The tip box shows how to ure the mirrors for the most recent
release and the most recent release minus one. I set these
up to use variables rather than hardcoded releases.
(From yocto-docs rev: ad47deb8ac1fc074ed3fdf3627609ac3ab38e92b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided a bullet item to the Getting Started manual in the
"Where to Go Next" section.
(From yocto-docs rev: ce4edc521d19b3c8025e950061cc962ca88fa29e)
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 document is not a manual. We are not going to list it as
a full-blown manual. It does not need the "Manual Notes" part
in the title page.
(From yocto-docs rev: 23267dea9a90dda33d646fcfc3e8b7a1c919adea)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This is for the brief-yoctoprojectqs article.
(From yocto-docs rev: 7237c9a36e855eee9056650455a4b6f3d2412961)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I have created an brief article in the form of current YP docs
that is a pared down version of the Quick Start (pre 2.5 release).
The article fills a gap for a short (2-page), process-oriented
article that steps the user through an initial build using YP.
I had to make changes to the Makefile to support building the new
article.
(From yocto-docs rev: 47aace60cea4a892ae1efabb050b240c6abdaec9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
