Removed "The" from all the titles of the books. This makes it easier
to reference to them and easier for the automated processing of the
mega-manual.
(From yocto-docs rev: af566d6d007cff642648698ea487a6eeaa8cc930)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I fixed a reference to a manual that should have had "Guide" and
not "Manual"
(From yocto-docs rev: a51de96fe0cd78cb379e6758d7e357c91daa2791)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I fixed several occurences of cross-references to whole manuals where
the formatting was split in the <ulink> statement. The <ulink> tag
and the manual title must be on one DocBook line in order for the
sed scripts to correctly process the links when the mega-manual is
created.
(From yocto-docs rev: 0dee12d518c892f59c0446e1c7b5d0f71b6ee22b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed several references to books. There should be no books referenced
using "The" at the beginning of the manual title. These need to be
"the" in order for correct mega-manual link processing with the
sed script.
(From yocto-docs rev: 76753216c7138d55f7b6f9167d678245ab3134e7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
the notes that say "Due to production processes..." at the start of
each manual contain links to manuals. the links needed to be formatted
such that the entire <ulink> code and manual name appeared on the same
line so that the sed script can effectively remove the link in the
resulting mega-manual.
(From yocto-docs rev: 0a41971c331ad1961e6ee1e067b59c36c9f048f6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I moved "the" outside of the generated HTML link so that the sed
script will process this part of the manual correctly for the
HTML mega-manual.
(From yocto-docs rev: 3bdf7c7dc4478f2a435cbc84a8a815daf7130660)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The references to the YP Development Manual were inconsistant.
These references were fixed.
(From yocto-docs rev: f4ded0b965fcbce7b500ca21886ee9b755c38383)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The way I refered to the YP Quick Start was inconsistant.
I have made edits to remove these.
(From yocto-docs rev: d9487c60db23861e8a9dd2c81ac46d4960abd462)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I had to rename individual style.css sheets to have book-specific
names. So style.css for the ADT manual becomes adt-style.css and
so forth. Turns out, this isn't really necessary for the solution
to create the mega-manual but I am leaving the changes as a
separate commit because it makes sense. It causes no disruption
to making the six YP manuals.
(From yocto-docs rev: 8cbdae1fe86988243f91dfd611c14f8a37007886)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the first sentence of the description of how to use QEMU images
with NFS server. This is feedback from Scott Garman's review.
(From yocto-docs rev: 6a33b1b58bd72756baf57228b7348ff662248012)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2929]
Provided an updated section on how to install and configure the
Eclipse IDE so that it supports both Juno 4.2 and Indigo 3.7.2.
The fix included creating a new poky.ent variable that is
Juno-specific.
(From yocto-docs rev: 6b0b046322420f56feb644eb6de8341dfac59df2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated an old comment in the layers.conf file example to say we
have recipes-* directories instead of the old packages directory.
(From yocto-docs rev: c39394e848d6039e6728b7e53de86958f951e258)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Two areas of the manual updated to reflect the fact that not all
QEMU images have an SSH server in them.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: a173d8cb05ee695b02188a037ee047db016c6a67)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The detailed chapter that describes how to install and configure
the Eclipse Yocto Plug-in has been moved to become a subsection of
the "Workflow" chapter in the YP Development Manual. This commit
accomplished the bulk move, edits to integrate the information,
and fixes to all cross-references. Moving the chapter creates a
sectioning issue in the YP Development manual that results in
subsections that are six levels deep. Not ideal. Will look at
fixing these with a subsequent commit.
(From yocto-docs rev: e6abff8f578f2cf6997895260f607395281ae8e8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The name of the ADT manual has changed to the "Yocto Project
Application Developer's Guide." This change had some ripple effect
regarding cross-references into the manual. These are now fixed.
(From yocto-docs rev: 7ba25c470b03a85098388e6cca7c78a6ebb245d8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In preparation for taking the Eclipse installation and configuration steps,
I have made an edit pass through the section "Workflow Using the
ADT and Eclipse". Minor edits performed to integrate the new
information.
(From yocto-docs rev: 7b4e0ae371b23f329451ac768b7d9eab5931df2d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
With the creation of a new KMACHINE glossary item, there were two
areas in the YP doc set that reference the variable. I added
cross-reference tags. Also noted that some other references
were missing to the variable COMPATIBLE_MACHINE.
(From yocto-docs rev: f740b62be175a50f17ce8a244258dcf391fcf672)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I have updated both the section for configuration fragments found
in the BSP and dev manuals.
Reported-by: James Abernathy <jabernathy@gmail.com>
(From yocto-docs rev: 62f4df751c80e7b749356bb80ade3a7847411f7c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Caught and fixed a stray reference to "appendix" that should be
"chapter."
(From yocto-docs rev: 97d26495dd9b561bb5724a86e9cd777eeef9f71a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As part of moving the reference manual to a real reference manual I
am removing the "appendix" classification and having everthing be
a chapter. I changed the "ref-varibales-gloss" appendix to a chapter and
made sure any references in the doc set use the proper term now
(chapter).
(From yocto-docs rev: 3f541c20c7aff1012eb4c06cb856bf9795124822)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As part of moving the reference manual to a real reference manual I
am removing the "appendix" classification and having everthing be
a chapter. I changed the "ref-imagese" and "ref-features" appendices
to chapters and made any references in the doc set use the proper
term now (chapter).
(From yocto-docs rev: 08117634034a5cd5567c971957583d986c9ee9a4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: ddee80872afc567b9381387980f257b337f29ea1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added the section "Using an External SCM" to the "Common Tasks"
chapter. This information was formerly in the YP Reference Manual
in the old development chapter.
(From yocto-docs rev: d34cd9e86cb7a6b27cf6a5b4daf58c445dd86331)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I inserted the section "Using a Development Shell" into the "Common
Development Models" chapter. This information was formerly in the
YP Reference Manual and is being moved out to help the ref manual
become a truer reference manual.
(From yocto-docs rev: f4ca1c567afcebbae119f21c147e3c38c7ffd54e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO_#2671]
Added a bit more in here about considering requesting rights to have
a contrib area to YP and OE if user is a regular and significant
contributor.
(From yocto-docs rev: b54bba33b2706bed593a9ee66d5c72f820c37d32)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section that describes how to send a patch upstream via email
did not have a good connection to the various mailing lists. I
added some references to this section and also mentioned using
the scripts if the user has many changes to commit.
(From yocto-docs rev: ad75ae45420c43bda974d22b02094237b5c7cc50)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Bug 2256 is now fixed in master and the fix will be in the next release,
so update the documentation accordingly.
(From yocto-docs rev: 877a7ecfd1623417d0793a5dd16b66c35b6fdbae)
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
"shared state cache" is the generally accepted term for this.
(From yocto-docs rev: a15f629afe46e7217182a1ac077ab59641be9a8c)
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
It's CONFIG_SMP here, and since the title of the section already
mentions it, just change the sentence to be more generic.
(From yocto-docs rev: 32e6145b5f41d4eb293f8267ef01d02217143152)
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Change some of the language and patch submission directions to
correctly represent how we work together with OpenEmbedded (this
changed with the introduction of OE-Core a few releases ago).
* Correct --help option to -h for pull request scripts
* Clarify commit message guidelines
* Touch up a few other bits and pieces
Fixes [YOCTO #2671].
(From yocto-docs rev: 3170ce5e0757951afee13207c117316e33449b39)
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Throughout the manual, the kernels that are built and available through
the Yocto Project were being referenced as a "Linux Yocto kernel."
This reference is poor. First, it placed Linux and Yocto very close
together and could upset the Linux folks. Second, a better way would
have been to say "Yocto Linux kernel." I have fixed by referring to
kernels that are available through the Yocto Project as
"Yocto Project kernels."
(From yocto-docs rev: 9b8319328cd4ab4ce3363001c9feeec585d9cab9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I have replaced the term "Yocto Project" with more appropriate terms
where possible.
(From yocto-docs rev: 622ef9a2b4897ecd151b641b43d7706ab673c989)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scrubbed the manual for the term "Yocto Project", which has been
over-used. I updated occurrances to better represent actual bits
rather than generically referring to everything as Yocto Project.
(From yocto-docs rev: f70cffeffa0d8863a88783607621bf6f7125d02d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The example did not specify to switch to the "denzil" branch after
establishing the local repo of poky-extras. The example will not
work without this step.
(From yocto-docs rev: 90071570bca2edfceb4adb91bdd9093c095c8825)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Previous renditions of the term "Build Appliance" referred to the
VMware system. However, it was determined that the term
"Build Appliance" should really refer to the actual image that
can be booted and run on the VMware applications. I have updated
the areas affected by this change. The change assumes the name of
the built or downloaded file you boot will be named
"build-appliance-image."
Fixes [YOCTO_#2656]
(From yocto-docs rev: 6b27b7d92b9722351eb43a7c2a341ce3af056dba)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some minor typoes in first couple chapters
(From yocto-docs rev: 36618cc6a261a994b00c5c524c76cbf3952a2eae)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Moved the sections on remote debugging and using the profile out of
the YP Reference Manual and into the YP Development Manual. These are
now two sections in the "Common Tasks" chapter.
(From yocto-docs rev: 42640bf69aa05c56eb112c10b6d7b96069173785)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section "Modifying Temporary Source Code" that was in the chapter
for "Common Tasks" was moved to the "Common Development Models" chapter.
After discussion with Darren Hart, modifying temporary source code
is a valid develop model. So, rather than isolate it in the common
tasks chapter it has been placed in the development model chapter,
which now has four types of development.
Changes were made to update the introductory text of all the concerned
areas of the manual.
(From yocto-docs rev: 8b07ee3bcda9c13e576b54b0079b0656cd8fcc32)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The "Using Pre-Built Binaries and QUME" section needed to incorporate
some information from the YP Reference Manual. I have merged those
changes in and did some re-writing to blend it well.
(From yocto-docs rev: 5c20f00f9ec75c19fd0106c9f241751381ba7e3c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I removed two larges sections of old comments.
(From yocto-docs rev: df1b08b621f2b449c7575b86ec90c40f1606c43d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated a note to include information about what happens if you do a
kernel build and have your machine compatible with every possible
kernel. This extra information is useful for rational.
Reported-by: Bruce Ashfield <bruce.ashfield@windriver.com>
(From yocto-docs rev: e631ec44be49d456add6a53ff3db89016d187370)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The linux-yocto_3.2.bbappend example was out of date. There is no
longer a kernel features statement in the last part of the section.
Only COMPATIBLE_MACHINE, KMACHINE, and KBRANCH remain. I removed
the fourth one from the text description and the example code.
(From yocto-docs rev: 1a6d3cad48f1b52e5b029434ce655940c6024694)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a note telling the user that the commit ID strings in the
example might not match the actual commit ID strings found in
the .bbappend file.
(From yocto-docs rev: 5cb845361c8ce8b60dcafc28d1bc01d54badd67a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Due to a bug (2256) the example that changes the kernel configuration
through menuconfig did not work. I have re-written the section
to now start with the default behavior of CONFIG_SMP=y and then
have the user change the configuration to where it is not set.
The changes include the reversing of the flow and the work-around
needed due to bug 2256.
(From yocto-docs rev: 6fa9eee12ed83f81470beb9792fb4fc1c5104f69)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added entries for the Manual History table for upcoming 1.3 docs.
(From yocto-docs rev: 430b384035593cd05c4f286e20c01f0fe72da8ec)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scott Rifenbark
Ross Burton
Paul Eggleton
Robert P. J. Day