Commit Graph

4581 Commits

Author SHA1 Message Date
Scott Rifenbark
bc6a19d6a7 overview-manual: Added new "overview" manual to YP doc set
Fixes [YOCTO #12370]

I added all the mechanics for this new "Yocto Project Overview Manual".
For now, the manual builds and publishes into the 2.5 area.  I used
"overview-manual" for the folder name.  Makefile properly builds the
new manual.  The mega-manual.sed file processes links for the new manual.
The mega-manual.xml file includes the new manual.  The poky.ent file
includes a new ENTITY link for the overview manual.  All pieces are in
place.

With this commit, just an overview chapter exists.  The remaining content
needs to be developed.

(From yocto-docs rev: 632ebd4a91920585e736527e070ca8363a00f41b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Scott Rifenbark
9f478d1358 dev-manual, ref-manual: Moved source file sections
The sections in the introductory chapter of the ref-manual are better
served as part of the dev-manual.  These sections are about accessing
YP source files using various methods (i.e. source repositories,
index of releases, and nightly builds).  I have integrated that
information into the dev-manual where the information was also being
treated.

(From yocto-docs rev: d3a97b1f9367d5bb5370974c8c5c0404df86724a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Kristi Rifenbark
8240adb06b ref-manual: Applied review edits to openSUSE Packages
Fixes [YOCTO #11911]

(From yocto-docs rev: 1f154a1496a9ae3f28453242131d55aa8d267650)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-22 22:23:06 +00:00
Kristi Rifenbark
c1e0242aaa ref-manual: Added BBFILES_DYNAMIC variable to glossary
FIXED [YOCTO #12089]

(From yocto-docs rev: 0906e9080e1c150feab60bb9d095688d274a061e)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-22 22:23:06 +00:00
Kristi Rifenbark
52586b4102 ref-manual: Added Note to CentOS For Wicked
FIXED [YOCTO #11911]

(From yocto-docs rev: 99eee11057fa53e819824fccd7993bbb7464e493)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-22 22:23:06 +00:00
Scott Rifenbark
8ee50cf71d dev-manual: Updated "Using RPM" section
Fixes [YOCTO #12419]

Updated the example to use http://my.server as the base.

(From yocto-docs rev: c61769ce2cd7fafbd5f1b349ecf9ac75dbae1a6f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-22 22:23:06 +00:00
Scott Rifenbark
bac81646a9 dev-manual, yocto-project-qs: Fixed some broken links
Links to the section in the BSP manual for how to create a new
BSP layer using 'bitbake-layers' were needing fixed.

(From yocto-docs rev: 150612925421b09e84f85514e65e58d179e5be46)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09 14:29:08 +00:00
Kristi Rifenbark
b2aeaa88d5 bsp-guide: Cleaned up Saul's notes
This section needs input from engineering.
It is incomplete, but as best as it can be for now.

(From yocto-docs rev: 1212f1eeebd23cb11c63889f3ee602e761450967)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09 14:29:08 +00:00
Kristi Rifenbark
d07585addc bsp-guide: Added writernotes style
(From yocto-docs rev: 25afb2b10fb278b6ae8519c703a7e56f87096668)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09 14:29:08 +00:00
Kristi Rifenbark
4a71d17172 bsp-guide: WIP Removing yocto-bsp
(From yocto-docs rev: 056cc0c1dab79df6911552a690ca6b4dc302cc8b)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09 14:29:08 +00:00
Scott Rifenbark
3716b1f51e yocto-project-qs, mega-manual: Overhaul of the QS
Changed the way the YP QS looks.  The QS now has numbered sections
rather than just formatted section heads.  This allows the reader
to better track the hierarchy of the sections.  This feature has
been asked for before and I decided it was time to implement it.
One thing though, is I am not generating a full TOC at the head
of the book as is done in the other YP manuals.

Decided to add a manual title .PNG file.  This required a new figure
file (ypqs-title.png) that needed to reside in the figures folder of
both the yocto-project-qs and mega-manual.  Updates were required in
the Makefile to include the figure.  Updates required in the
YP QS style sheet to display the figure.  Basically, there were all
kinds of changes to get this title to show up properly in both the
YP QS and in the Mega Manual.

Turned the structure of the YP QS into a book now rather than an
article.  This required creating a "qs.xml" file that has the actual
content.

(From yocto-docs rev: ef05f5c7ba2a61ebc4c58873cbbc32d35652659d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09 14:29:08 +00:00
Scott Rifenbark
c619d588b5 makefile: Removed "yocto-environment.png" from tar list of mega-manual
File is not used.

(From yocto-docs rev: 83eb6d4decfe698a5f4be9c3c9792ef60e404323)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09 14:29:08 +00:00
Scott Rifenbark
495fb9287c ref-manual: Fixed redundant link for "build system"
(From yocto-docs rev: 08f9683f53f78cdd13ca760392effb01fc755d57)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09 14:29:08 +00:00
Scott Rifenbark
f325d43348 ref-manual: Added new terms to Yocto Project Terms section.
Added "BSP", "Reference Kit", and "Build System"

(From yocto-docs rev: f2783d8150ea39e5e116aeebc5305e2c64c3b806)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09 14:29:07 +00:00
Kristi Rifenbark
a52dc0a11e ref-manual: Added the GCCPIE Variable to Glossary
(From yocto-docs rev: b30f3d3bd6f6d333b00fc9c3797126a898fb0685)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09 14:29:07 +00:00
Kristi Rifenbark
5d9d10704f ref-manual: Added kernel-devicetree to the Classes section
(From yocto-docs rev: 1ea1f0dc6451030738c506c4d6228b31f67f3f36)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09 14:29:07 +00:00
Kristi Rifenbark
3f0cd2a1d7 ref-manual: Added the BB_SERVER_TIMEOUT variable to glossary
(From yocto-docs rev: 6e765f4017ae300f83839201b123afa2a3662d70)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09 14:29:07 +00:00
Scott Rifenbark
4db3915372 dev-manual: Updated bitbake-layers overview section.
The section was missing three of the summaries for the command when
you used --help to find out about it.  I added these in to the section.

(From yocto-docs rev: ac9c58322b7f8533335a9d4379aa031bb1de7be6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-11-12 06:51:20 +00:00
Scott Rifenbark
1b55ec668e dev-manual: Removed note about yocto-layer being deprecated.
Deprecation of yocto-layer occurred in 2.4.  For 2.5, we do not
need to mention this fact in the note.

(From yocto-docs rev: 619b74422baf3b531e2fc3db50a95019178a1c09)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-11-12 06:51:20 +00:00
Scott Rifenbark
2d363c1955 ref-manual: Updated supported distro list
Removed Fedora 24.

(From yocto-docs rev: 4383c2ac9f1f9ca925518874dc40b8394a2865a4)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-11-12 06:51:20 +00:00
Scott Rifenbark
24503ed3f5 documentation: Set up for "sumo" (YP 2.5) Release.
poky.ent - updated variables
<manual>.xml - updated manual revision tables
mega-manual.sed - replaced "2.4" with "2.5" for links.

(From yocto-docs rev: 15d1f805ad11fba145155dcec17b7ec8a21ad487)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-11-12 06:51:20 +00:00
Kristi Rifenbark
69a6e223f9 ref-manual: 2.4 Migration Revisions
(From yocto-docs rev: 0802de0ca64b7d3581fb2e3ff26d2f72802ade61)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-11-12 06:51:19 +00:00
Kristi Rifenbark
b034103ce6 ref-manual: 2.4 Migration Revisions
(From yocto-docs rev: 1778a743ba3a8b82e96d1e9948e86048d77a8e77)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-11-12 06:51:19 +00:00
Scott Rifenbark
514a808f21 ref-manual: Updates to "Image Generation" section.
Fixed wording on how the OpenEmbedded build system dynamically
generates do_image_* tasks as needed during image generation.

(From yocto-docs rev: 9df98d77a446cd5d27c4e87418117a904b1f4231)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:08 +00:00
Scott Rifenbark
f29cdba71a dev-manual, kernel-dev: Replaced yocto-layers with bitbake-layers command
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>
2017-10-30 15:55:08 +00:00
Kristi Rifenbark
4cbdb705de ref-manual: First draft of the 2.4 Migration section
(From yocto-docs rev: e0302faa6e7c4ef17c57489e6e6f11b73d8e9b94)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:08 +00:00
Scott Rifenbark
8f03c32040 documentation: Updated title page notes and author group
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>
2017-10-30 15:55:08 +00:00
Scott Rifenbark
3eda52629e ref-manual, mega-manual: Updated Index of Releases figure
(From yocto-docs rev: a7238f165cd6cde6c33d9981577039f8511f5fe3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:08 +00:00
Scott Rifenbark
05967e8e3c ref-manual, mega-manual: Updated example source repo figure
(From yocto-docs rev: 60167c15c08ddaa211c4a1151e6b1a0b00763cc0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:08 +00:00
Scott Rifenbark
e08129f909 ref-manual: Updated "Build Image" section for do_image<type>[depends]
Added information about how the build system dynamically creates
do_image_* tasks (e.g. do_image_ext4[depends]) when creating the
image.  This is functionality that replaced IMAGE_DEPENDS_type.

(From yocto-docs rev: c977df506585aad1ade99c390bacc04b54eb0e48)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:08 +00:00
Scott Rifenbark
dd797966f2 sdk-manual: Updated title page note for manual information.
(From yocto-docs rev: 7f54c31b91c7ec719f507a1b67a99c1b329619f7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:08 +00:00
Scott Rifenbark
33cd663650 sdk-manual: Minor wording update in title page note.
(From yocto-docs rev: fdfa837b5d453d2721e92b01dda25e3b0a517913)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:08 +00:00
Scott Rifenbark
708455cdee ref-manual: Updated links to the sdk-manual
The title of the sdk-manual changed.  Many links were updated to
render to the correct book title.

(From yocto-docs rev: 821e29c6c031ae2516fb0e79d0ec3936a5bd624c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:08 +00:00
Scott Rifenbark
5cf97b8922 yocto-project-qs: Updated references to the sdk-manual
The name of the sdk-manual changed and I had to update some external
links and references into the manual.

(From yocto-docs rev: fba92910fd91d1ca49bc6915820effb189f1852e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:08 +00:00
Scott Rifenbark
e018769524 kernel-dev: Updated links to the SDK manual.
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>
2017-10-30 15:55:08 +00:00
Scott Rifenbark
c1689e1aba sdk-manual: Changed name of the manual.
Change the name of the manual to "Yocto Project Application
Development and the Extensible Software Development Kit (eSDK)".
The "sdk-title.png" file was updated and all title information
was updated.

(From yocto-docs rev: 502a49a9e4f5e80efe16507391bc9d9618efefbd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
9737e192f5 dev-manual: Updated links to SDK manual.
SDK manual title changes so the links into that manual needed updating.

(From yocto-docs rev: e59d1cb22d46b00e9413deb5c7a70a14be880dc1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
34befd259d sdk-manual: Split the Eclipse section into a separate chapter
This also affected a link in the dev-manual and some setup stuff
in the mega-manual and sdk-manual.xml file due to a new chapter
being introduced.

This section on the Eclipse stuff is big enough to warrant its
own chapter.  I decided to pull it into a separate chapter of its
own.

(From yocto-docs rev: a4b2b605902f09bb200facfabb0a7c355fbf4c87)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
3c3dddf3e0 ref-manual: Added links for do_image and do_image_complete tasks
In the "Image Generation" section, I was referencing these tasks
and did not have any cross-link to the actual tasks.  I added them.

(From yocto-docs rev: da480933c59ddc3fe9fe4a881d4d0e21038a999b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
149abc5c7f ref-manual: Replaced "vmdk" with "wic.vmdk"
(From yocto-docs rev: c5c77c91269c16dc72cd7b63ce1e7fde1cf1d492)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
458d0e720e dev-manual: Updated run QEMU basic syntax step
In Step 4 of the "Running QEMU" section, the file suffix
"*.vmdk" is mentioned.  "vmdk" has essentially become "wic.vmdk"
now.  I updated the example.

(From yocto-docs rev: 5e17ccabfe8eb9d3b4316ceb41df17eddc7b0065)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
caf6f814ad ref-manual: Updated EFI_PROVIDER variable description
The "vmdk" image has essentially changed to "wic.vmdk".  I updated
the description by replacing "vmdk" with "wic.vmdk".

(From yocto-docs rev: 24d0d9509361afe0d61449c7dd056f73318fc01a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
7fe44a4570 ref-manual: Cleaned up multiple notes for the IMAGE_FSTYPES variable
Combined two note boxes into a single note box with bulleted list.

(From yocto-docs rev: 5684b6cf373ddc5b18e9e4ae4ae12cede30b8235)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
81fbf759a4 ref-manual: Clarified build history as creating a single commit per build.
(From yocto-docs rev: eb5edb5833ece9342cfeb645fbff1154bb2113c7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
5ba6253ad2 dev-manual: Changed location of maintainers.inc file to meta/conf
(From yocto-docs rev: 0991f94a32c067375b6d58eb058f3bb3393f8a21)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
a39d8d9988 dev-manual: Removed a couple instances of "meta-yocto"
(From yocto-docs rev: 7c23ff287cd5b2e550ab53514a6cc574b276d939)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
d076206674 ref-manual: Removed "unsafe-references-in-scripts" test from insane class
This test was removed.

(From yocto-docs rev: 9defac2c0e0d808bc677bd6d115a72e4db6a554c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
546355dbfe mega-manual: Added new dev-manual title .PNG file to Figures folder.
(From yocto-docs rev: 995e19d0c8aca03ca026409b2db5bccaa4b6552f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
6f90474894 mega-manual: Updated author line.
(From yocto-docs rev: 26ad4f587ed848749baa3f8d25bf19319e6c8e9f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
6dbbad69e5 mega-manual.sed: Changed title of dev-manual.
(From yocto-docs rev: 2c317dc5a55b9bafac2d15d048485e1dbce82fdd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00