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>
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>
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>
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>
The dev-manual title changed to the Yocto Project Development Tasks
Manual. I fixed a link to this title. Also, fixed several external
links that were going to the dev-manual and should have been going to
the ref-manual.
(From yocto-docs rev: 69c0832ea9378d097e85e23e45cec750b8c42042)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Two links that should have been to different places were overlooked.
I fixed these.
(From yocto-docs rev: a1681d065812546a573ed778141289a6b476cecd)
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>
Fixes [YOCTO #11968]
Purged all occurrences of the "oe-init-build-env-memres" script
from the YP documentation set. Occurrences in a lot of places.
The BBSERVER variable was also impacted and had to have the
definition updated.
(From yocto-docs rev: 274b05108d1bc53df20c11ab2efa15363bce23da)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed [YOCTO #11970]
Updated the field description for "Specify Sysroot Location" to
note that the user can have this either downloaded or built and
the ramifications of using a downloaded root filesystem.
Updated the "Deploying and Debugging the Application" steps for
both supported Eclipse versions to tell the user what to do if
a browse operation fails or times out.
(From yocto-docs rev: 623000af186cb5632af551f95384d4c96d4d6c54)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Moved the "Patching the Kernel" section, which was in the
dev-manual to the kernel-dev manual. During the move,
renamed the section to "Using devtool to Patch the Kernel".
This move bothered a lot of links so I had to fix them in
various manuals.
(From yocto-docs rev: a000be1eddf33e4d7de8f350e076d48e27ca4b98)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The steps needed updated to reflect the introduction of CROPS
as a way to prepare a build host.
(From yocto-docs rev: 8f52372afad4c32d0b895a88c2298625e7f53da3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section needed to be a step-by-step procedure.
(From yocto-docs rev: de4868c97c1199b39b3c3e68b4ff159f6546cd9e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section "Locating Pre-Built SDK Installers" was turned into
a procedure. I also added some information on the actual names
of the *.sh files.
(From yocto-docs rev: 548886d5a392164783596c0c04779aaffd6ac930)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The section on the devtool workflow in the dev-manual was 99%
identical to what was in the sdk-manual. I have moved the
workflow procedure from the old "Model" chapter of the dev-manual
to be merged with what was in the sdk-manual. In truth, the
only things added were a note about devtool not being exclusive
to SDK development.
The result of moving (deleting) this section was that the "model"
chapter of the dev-manual went away. The devtool stuff, Quilt,
devshell, and python shell are all out now and there is no
chapter left. So, mega-manual had to be adjusted to not pull that
chapter in when building the dev-manual. I had to delete three
figures that were used in the flow. The figures were already
replicated in the sdk-manual. The figures were deleted from the
figures folder of both the dev-manual and the mega-manual.
I had to make sure all references to the old devtool stuf in the
YP doc set were adjusted.
(From yocto-docs rev: 5dbd643d31ab502df53a22229e457a03da7772b7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The "Git" section in the dev-manual is really about concepts.
There are a couple of examples that might or not might be
allowed to ultimately stay. I have moved the section to the
ref-manual. If those examples get replicated in the new
dev-manual, I will update the "Git" section further. For now,
however, these remain in this moved section.
(From yocto-docs rev: 2e4b87fdab29c13ce0d2314e50c93e37404b6f7e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
For development purposes, static libraries need to be
present only in the SDK. We do not need those static
libraries in the image for most scenarios. So, replace
IMAGE_INSTALL with TOOLCHAIN_TARGET_TASK in the documentation.
I updated the note to reflect this.
Suggested-by: Maxin B. John <maxin.john@intel.com>
(From yocto-docs rev: c05458c6614c38961d23db8f894d542bf93dbf09)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Moving the "Yocto Project Terms" section from the dev-manual
to the ref-manual broke the links to the "Metadata" term.
I fixed these.
(From yocto-docs rev: 190da4b4d44952d141db26ca72b5bc1a52d77023)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Moving the "Yocto Project Terms" section from the dev-manual to the
ref-manual broke links for the "cross-development-toolchain" term.
I have fixed these.
(From yocto-docs rev: f2d2b5936bd339d691ab859cbe3df86e3da58f0c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Moving the "Yocto Project Terms" section from the dev-manual to the
ref-manual broke several links to the id "build-directory". I fixed
these to reference into the ref-manual now.
(From yocto-docs rev: debe2ae8ce203ebe0f1cee0de54124c15df8bb7e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The YP doc set was using a link to an out-dated video that
showed how to configure and run Eclipse. The video was very
old and Jessica suggested just removing it. So, I replaced
all occurrences of the link to the up-to-date appendix in the
SDK manual that provides information on the latest supported
version of the Eclipse IDE.
(From yocto-docs rev: b4af1a79078352df5558e20c0b9cfa97fa141abc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated poky.ent to use 2.4 variables and numbering
Updated mega-manual.sed to use "2.4" string for links
Updated all manual revision tables to use "2.4" and
"Usually October, 2017" string.
(From yocto-docs rev: 17ec7da6ab3fd450c2010812f7ad689288b12dcc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
poky.ent - changed the "tbd" and "TBD" strings to "pyro" and
"Pyro", respectively.
Manual Head Files - Updated the manual history table with the
May release month.
(From yocto-docs rev: 076226d2986d0cf69685121e4342f50c1603fc7b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10076]
The note on the title page for each manual was brief regarding
where to find the latest version of the manual. I updated the
note to have more detailed information on finding current,
alternate, and latest versions of the manual based on YP
releases.
(From yocto-docs rev: 0ec81465296a7a78309d3039af4d00caa52d2285)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10714]
Apparently there is some issues with GTK3 libraries for the Mars
Eclipse version. The note provides a workaround that requires
editing the eclipse.ini file.
(From yocto-docs rev: f940d5d3f7bf446af8f3c7cec5958c8395425a69)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #8584]
Made some edits to tighten this down and make it more efficient.
(From yocto-docs rev: d5a37b77fa5c8df766248849601ca229502bb4ab)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changes to the following:
* All manual revision tables to indicate a 2.3 release proposed
for April of 2017.
* Updated the poky.ent file so that all variables needed reflect
2.3 values.
* Updated the mega-manual.sed file so that processing of links in
the mega-manual work for a 2.3 release.
(From yocto-docs rev: 926e282c17b67c79b94a0b62a0b18bfbe0b26c40)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #8584]
This fix essentially had to document how to add the API
documentation to the standard SDK. The fix required adding a
new appendix to the SDK manual on how to customize that
standard SDK. I could not put just one topic in a new appendix
so I also added a sub-section on how to add indidual packages
to the standard SDK.
Other changes here were the introduction of a new file for the new
appendix, updated the mega-manual.xml file so that it would include
the new chapter when the MM was built. Finally, I added some
cross-referencing to the new appendix from the TOOLCHAIN_HOST_TASK
and TOOLCHAIN_TARGET_TASK variables. And a cross reference from the
distro features section on the api-documentation bullet.
(From yocto-docs rev: 1fb4321ae42253d1fc9602496b5e9e8b495197dd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #8584]
Updated the "Distro Features" section to include the
"api-documentation" feature.
(From yocto-docs rev: 5b4e8fc58b84aea9a940f67f8d7585912fadc676)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added string "October 2016" as the release date.
(From yocto-docs rev: db40986677746afbbb138d9cbe3885111550b7c5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10267]
Changed the example to use a single long line.
(From yocto-docs rev: c80d8bb8773b7bbe9c85c48880f42ffb273729b7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I applied several nits across the manuals based on reviewer
comments. All these corrections relate to the task of shuffling
topics around that have to do with the extensible SDK and the
devtool.
(From yocto-docs rev: 9f8079adc7fa2897fd885aff8e64f9721212e9c7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Removed the note box formatting for the cross-reference
from the sdk-manual and dev-manual sections that
talk about devtool. The reference is now non-note
form and goes to the ref-manual devtool quick ref.
* Added devtool upgrade as a third item in the list that
introduces methods to use devtool.
* Fixed the working on the devtool finish step 5 for both
the dev-manual and sdk-manual.
* Renamed the new chapter that describes different projects
you can use devtool on. The focus is on using the SDK
toolchain directly.
* Scrubbed the entire sdk-manual for the term "toolchain
installer" and replaced with "SDK installer".
(From yocto-docs rev: 6d4daef49cc6d54a700a8c3965c9e8814f75d20a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I extracted the sections on Makefile, Autotools, and Eclipse into
their own new chapter. Seemed to make sense as they are projet
types for both standard and extensible SDK types. Also, swapped
the order of appearance from standard first to extensible first.
This swapping caused a bit of rewriting.
(From yocto-docs rev: 138a4d5576123da800a8fd8d99462a138ceeb743)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Did the following:
* Added the devtool upgrade flow to the SDK manual.
* Removed the devtool Quick Reference from the dev-manual and
added it as a new chapter to the ref-manual.
* Made sure all the links and cross-references work now with the
moved material.
* Updated the Make file so that the manual set builds correctly
regarding the new chapter in the ref-manual.
* Created cross-referencing notes in both the sdk-manual and the
dev-manual to the newly located devtool Quick Reference chapter.
(From yocto-docs rev: fda0bf68b3654b1b96407d552c5254657465b5fc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I needed a new figure and a new section.
(From yocto-docs rev: d413ca7b9b946450af7c2c15ab0e68e9181517e9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These notes can't be in the final version of the manual.
Now is the time to get them out.
(From yocto-docs rev: 600b4f2c7360b30d12fdc7ed0f5ba41bc09fc778)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10032]
The fix to remove the BitBake Commander from the tools to install
when dealing with the Eclipse Yocto Plug-in has happened.
Consequently, I removed the developer notes in the manual stating
that the Commander was still showing up there. The manual set
is now clean of this stuff.
(From yocto-docs rev: fbe169b086faac571de8a2ebd9d32682162cfd31)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10267]
The example works better using OECORE_TARGET_SYSROOT for the
aclocal line. I changed it to that.
(From yocto-docs rev: 362b786e7bf2083c5809e961f61c0ad81b778d71)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
