Robert P. J. Day pointed out a link in the development manual that
was for the BitBake User Manual. The link resolved to an old,
non-maintained version of BitBake documentation. According to
Richard Purdie, the BitBake docs referenced should be the ones
that ship in the bitbake/doc/manual directory of poky. The
YP docs had been using a variable named BITBAKE_DOCS_URL that
also resolved to the antiquated user manual site. Consequently,
there were many links that needed fixed across both the YP
Development Manual and the YP Reference Manual. Each of these
references now points in general to the bitbake/doc/manual
directory in poky for more information.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 12f77236b602e9ec43e845c8cec060ad342af19c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the section that describes how to submit a patch through
email while not using the scripts that send patches and request
pulls.
(From yocto-docs rev: 9167b89289134d8d16610cc527d0d71713c0641b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the title and a single reference from the Kernel manual
to a title more representative of how these patches are sent -
not using scripts.
(From yocto-docs rev: ff908c34fae88eab9724891a008142a834f34081)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added text to indicate that using the two scripts for generating
patches and requesting pulls is the preferred method to send
a patch.
(From yocto-docs rev: d6f036a91074dd00c51fe0f937224182fc801b3b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the section heading for the part describing how to
push changes upstream via the poky scripts. Also had to
change one cross-reference to the section in the kernel
manual.
(From yocto-docs rev: be7712aba044238e8781cdf869c5d14e77eb09a2)
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>
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>
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>
* 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>
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>
The example that creates a local branch based on a release tag
in the "Repositories, Tags, and Branches" section was not optimal.
Darren Hart informed me that naming a local branch the same name
as a tag confuses Git. Plus, the "-b" option was mis-placed.
Renamed the local branch to have "my-" in front of it and moved
the "-b" option earlier in the command.
(From yocto-docs rev: 29f4ea267ef687431e09eca4634fcb6cc48a6f81)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The example in the "Repositories, Tags, and Branches" section that
creates a local branch that tracks the upstream branch is incorrect.
The syntax should be "git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME;
Fixed it.
(From yocto-docs rev: ec80d43ad97370771c9cd7f7e6a4637db5f80e9b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I did a quick and dirty scrub over the manuals for the strings
"1.1" and "edison". I found some instances that were not properly
variablized. Also, discovered some references to the
linux-yocto-3.0-1.1.x. All but one instance of this needed changed
to linux-yocto-3.2.
(From yocto-docs rev: 620fb4b7626defcefc8a039de09ae4599ee7f454)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added more information to the YP Term "Append Files."
(From yocto-docs rev: e1a7e9b0a790d394e237a0972140107d11178408)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I converted the hard links to use the variables as established
in the file poky.ent.
Also, Cleaned up some bad text in the term "Yocto Project Files."
Looks like a cut-and-paste problem.
(From yocto-docs rev: e2e20bf4895d80dae73595e93132f37fb31121d1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Several topics in the "Common Tasks" chapter really fit better in
the "Newbie" chapter. I moved these sections out. I also combined
information from the section on submitting changes from the
"Common Tasks" and the "Newbie" chapter to live in the "Newbie"
chapter only.
(From yocto-docs rev: 90fa8c125e545c57a5a994dd59715b73c5c4882f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed redundant link to manual.
(From yocto-docs rev: 7e7bc327237cae2be3c67e5b711548a16c4d8648)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The change to the dev-manual-newbie.xml file was minor. I added
a link anchor for the term "metadata."
The change to the dev-manual-common-tasks.xml was extensive. I have
added an entirely new section on layers called "Understanding and
Using Layers." The new material has several sub-sections.
Information was based on emails from Paul Eggleton.
(From yocto-docs rev: 4fb34abd60180fc2482ddb9f62e476763cee7679)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a reference anchor to the spot in the dev-manual for the
"Yocto Project Source Repositories".
Other changes were to the bsp guide and were general edits to the
"Linux Kernel Configuration" section.
(From yocto-docs rev: def35923199d48c879ff06a68f81b5cd28d55185)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Throughout the manual there is a specific term to refer to the
YP build directory: "Yocto Project Build Directory." This term
was being loosely referred to and was not consisten in linking to
the actual term definition in the Terms chapter. All this is
fixed.
(From yocto-docs rev: 9229a512a62780a0e52089cc865d0903cbe7c92e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Put in the real link to the YP Source repositories instead of a
click "here" thing. Put in a reference to the BSP Layer section
from the term layer. Fixed a grammar type.
(From yocto-docs rev: 6b3b63480f948dad2c5101deedb8deafad291728)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I beefed up the definition for the term "Yocto Project Build
Directory." I included the TOPDIR role and also expanded the
discussion on how it is created and the control the user has
over it.
(From yocto-docs rev: d00f30708ccd5fb9e1fc3c8e5240e0ab7a892fe0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Last edits to the "Git" section and the bulleted item that defines
the term "Yocto Project Files." These edits were from a review of
Joshua Lock.
Reported-by: Joshua Lock <joshua.lock@intel.com>
(From yocto-docs rev: 57cbb06aac566e02bb2e2a1ad05c3ff6dbb0359c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I made another pass through the document and cleaned up some
mistakes and also removed redundant links to manuals where I had
already provided a link to the specific section.
(From yocto-docs rev: 5da8ffe100127f5fe4bfd2b478f177d6bef3a968)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I split the Git section into a couple sub-sections. One talks
about concepts and the other is the section on simple commands.
Hopefully the concepts section now addresses the confusion
people are having over branches, tags, etc.
Also changed the definition of the term "Yocto Project Files"
based on some input by Joshua Lock.
(From yocto-docs rev: d76a9942dd12e6bd3ccba5331039477b26c02379)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These edits help explain the differences between local YP files
created through a tarball extraction vs cloning a Git repository.
(From yocto-docs rev: ed368800c3e9ece71d27d6d690f0ddc264a4c2da)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Had to update the figure again and I updated the surrounding
text.
(From yocto-docs rev: ed0aea8ad3670aace1eb51ca7a72e75a4c129fba)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Found another broken link to the Git documentation. They must have changed
this stuff up. So I set the link to point to the appropriate area in
the Git Community Book. Talks about distributed workflows.
(From yocto-docs rev: f81d6bbff20629b2b3af73ef53f471090b9d828b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
there was a link to some Git documentation referencing workflows that
apparently had gone stale. I replaced the reference with a link to
the Git Community Book.
(From yocto-docs rev: 7a2cbe4c45eb9bb53d5ddbc014bd6005c2844d56)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the Bug Tracking section to include rudimentary use of
Bugzilla for entering a new bug.
Fixes [YOCTO #237]
(From yocto-docs rev: 8f2702444812c9dc25195340acebbaae15cd59d7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Tom Zanussi provided a review up through part of the "model"
chapter. I have implemented his comments mosty verbatim.
Reported-by: Tom Zanussi
(From yocto-docs rev: 693d4fadd4b34ffef9953fb1850d381ff7c028a3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There are many references to YP documentation throughout the
YP manual set. They used to have hard-coded links to the
current release (e.g. yoctoproject.org/docs/1.1 for Edison).
This created a situation where if you went to a document on
the website and clicked on a external reference to another
manual, you would redirect to the current manual on the website.
Really, you would want to go to the latest manual, which is
one that is under development. Changing the links to
"yoctoproject.org/docs/latest" makes the tip of master, which
is used for devloping the next release, always have references
to the manuals being developed and not back to the stable
released set of manuals.
This "latest" and "current" scheme for the links is not perfect.
What has to happen when the latest set of the manuals freezes
and becomes the next stable release, all the links in the docs
will need to be changed from "latest" in the URL to the new
release number. So for example, all the "latest" occurences
would need to be changed to "1.2". Then for the next cycle
as development begins again, the links need to be infused with
"latest" again.
(From yocto-docs rev: a234aef34303b07671da956de0e94b352797143e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Robert suggested some minor wording changes that are good.
(From yocto-docs rev: 50822bc3722e2f3b0a73ed837842ddc5c7595c7b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Robert ear-marked some links to point to downloads.yoctoproject.org.
He also made several wording changes that resulted in better language
and in a couple of cases fixed incorrect subject/verb usage.
(From yocto-docs rev: 9106619c4264c2669be041c1e6d6124e022ab2d1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The restructuring of the web site where we store manuals broke some
links that were cut-and-pasted in from older work. These slipped by
me so not changing them would direct the user to a 1.0 version of
the externally referenced manual rather than the 1.1 version.
I also got rid of a visible "WRITER'S NOTE" in the document that
was left behind.
(From yocto-docs rev: 1508826312a2fe35e5d693821a4c7737baafcb2e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
After greping through the documentation directory, I addressed
all the <ulink> statements that used to have yocto-1.0 in the URL.
They are now yocto-1.1.
(From yocto-docs rev: 97d160263c5905fdeaf4ec285bc5359918790581)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added the directory where the list of know licenses are in the YP
files structure (meta/files/common-licenses).
(From yocto-docs rev: 6a8db1a5ac653dbc8730e61293221c0b0890888d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a note indicating where you can find the maintainer for yocto
code. Suggestion by Robert Berger.
(From yocto-docs rev: 8e55cc4c460582964b0267b4f43c14e7100f17fe)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I provided a link to the OpenEmbedded wiki page created by Mark Hatle
that provides good guidelines on how to create well-formed commit
messages.
(From yocto-docs rev: ea7b0100a7b45c369cb67daa0705dcc5acef40c8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
General pass-through for consistency in referencing sections.
Also, added Darren Hart's review comments for the "Submitting a
Change" section. I added more about the mailing lists and how to
submit a proper commit message.
(From yocto-docs rev: d9c8f5db8c862b1be724915cc43da6d12b88b97d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I moved the terms "Yocto Project Files" and "Yocto Project Build
Tree" into this development manual. They were previous defined
in the ADT manual. It makes more sense to have them where with other
terms.
(From yocto-docs rev: 2133110fd280db8cfbe998e6b46cdee0b260e777)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section on submitting a change was very sparse and incomplete.
I have significantly upgraded this section to provide more details.
(From yocto-docs rev: af43bb1e4902c45afb5ac4b0f099877acd7a81a2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I made several edits here. There is some mystery as to which changes
are actually part of this commit. I did a 'git diff' and am only seeing
one small change. If I later find they are not there I will delete the
file and replace with a back up I saved prior to submitting this commit.
(From yocto-docs rev: 62c63b3a812eaf92ca2bffa5714a6d327ac32d64)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added some clarification on the ability for testing. The wording as
it was implied that the YP provided a complete testing framework,
which is not true.
(From yocto-docs rev: e40b39179c69b69f012f231009131b1efa7e732b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section on how to contribute changes to the YP resides in this
development guide. I took additional information from the YP reference
manual and merged it into the section here.
(From yocto-docs rev: 945dd29417cf51044332114e499b08fe24ef3077)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a reference to the Image appendix for the description of
images. Also, added a new term "meta-toolchain."
(From yocto-docs rev: a9c1110ec7499afa669416c00bc81573fcbf920d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made several editing corrections for various terms and phrasings based on
Scott Garman's review.
(From yocto-docs rev: a21ba80151ce82683d45cd67ddb0728d779b007a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I placed an anchor point in the Index of Downloads bulleted item for
reference from other documents.
(From yocto-docs rev: 7d4f96d20667fbf5f52e25840b39f1994b1c4cd3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the introduction paragraph to cast the chapter more for YP than
just generic newbie information. Also, added three screenshots for
the source areas at Dave Stewart's suggestion.
(From yocto-docs rev: 26d3c58ff6295515c593c8b0b12dc3d6952b752a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
General edits to the workflow section. Also created a link to
to Bugzilla in the next section.
(From yocto-docs rev: 2e70b19d24bb4649fb525232fca9ab2e01c5ec61)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
created a new section on YP terms that might be useful to the new user.
(From yocto-docs rev: ab81b6468c39b5c015c7c0654ddf8c4cfd8bd245)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I re-wrote the source repositories section a bit to better reflect the
overall picture of how the user finds and decides on source for YP.
Also added some punctuation to the licensing section.
(From yocto-docs rev: 12ec18e58eb4e4dc395c2161908a60d395684ab3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This content is the first cut for the chapter. The original was a copy
of some adt-manual chapter.
(From yocto-docs rev: 4a563c3ed1e82837410ed114a07e39a0ccaad6f7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scott Rifenbark
Paul Eggleton
Robert P. J. Day