Fixes [YOCTO_#3396]
Spaces in file and directory names is an issue for the build
system and throws an error when sourcing the environment
setup script. I added key notes in several areas of the doc
set. I also added some cross-references to the oe-init-build-env
section in some other areas where running the script is discussed.
(From yocto-docs rev: 1d102e91ba77391096749bd7df6c05b2b695b33f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made minor changes as needed due to some new sections, links,
and capitalization standards.
(From yocto-docs rev: bc966e5a78dadd14ecf1896a36e40a9b256bae77)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removing the Appendix A (BSP) example had some rippling affects
throughout the doc set. There were several links into the appendix.
All these links had to either be modified (if possible) or simply
removed since the appendix will be removed.
(From yocto-docs rev: fff35abd87e945de1806eef63a56a956d104bf92)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Explain that we test with a set of reference hardware rather than only
supporting hardware that we have (avoiding any implication that the
build system can't support other devices). These are in the
faq entry in the poky-ref-manual for the question of how we can
claim Poky / OpenEmbedded-Core is stable.
* Adjust the language so that it is OE-Core friendly, with a link to
the Development Manual for the definition of OE-Core.
(From yocto-docs rev: 5ff1604dd383b26e918c319fcbe46dd1589cebc5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The description for where the "scripts" directory lives was not
conforming to our terminology.
(From yocto-docs rev: 925167c446b86ca09d387d01568db64113412311)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
For obvious reasons I changed this one :)
(From yocto-docs rev: 5f3203292f46bea799321e4520668252a46fb599)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I improved the wording such that it is not tied to a
x.x type release. It is more generic here and will survive
better under future releases.
(From yocto-docs rev: 2bd644db7fef71cd2f07f6d3dcbd2ba60b83df08)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
For 1.3 there is not longer a toolchain tarball. Instead, there
is a wrapper script that lets you install the tarball. This
fundamental usage model change caused several ripples throughout
the documentation set. I have changed wordings and examples
to reflect the new paradigm.
(From yocto-docs rev: afb2069daa91e04c0f78ba425a6b184cb820d888)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
Scott Rifenbark
Paul Eggleton
Robert P. J. Day