Commit Graph

35 Commits

Author SHA1 Message Date
Scott Rifenbark c2f14db4e0 documentation: several manuals - Notes and links for filename space issue
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>
2012-12-03 13:52:55 +00:00
Scott Rifenbark a73fde8caf documentation: poky-ref-manual - Final changes before the 1.3 lockdown.
various changes as required.

(From yocto-docs rev: 7f166508337c9d4aadad23997470a8871c5e42a4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-23 00:03:14 +01:00
Scott Rifenbark fe5636108f documentation: poky-ref-manual - Updated build/conf/local.conf
I added the BB_NUMBER_THREAD and PARALLEL_MAKE variables into
the description for suggested variables to set if you edit
local.conf.

(From yocto-docs rev: 7345bbf6c10b823e6364e85a4e75a7ec60a29aef)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-18 12:15:03 +01:00
Paul Eggleton 3ec994ee3e documentation: poky-ref-manual - Updates to the poky structure
* Add meta-yocto, meta-yocto-bsp and meta-hob
* Remove meta-rt - this was merged into OE-Core (meta)
* Remove meta-demoapps - this was dropped

(From yocto-docs rev: c90a8f85f4462caa49c7da2e7ec4541534bee57a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-15 14:45:13 +01:00
Scott Rifenbark 64b9137b43 documentation: Fixed links to BitBake User Manual
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>
2012-09-14 09:50:45 +01:00
Scott Rifenbark efcb0a81d8 documentation/poky-ref-manual/ref-structure.xml: deleting images
Added clarification on how a user can hand-delete images from
the build/tmp/deply/images directory.

(From yocto-docs rev: 4655085d43b36b024a2e01cfcc7455e18d891ab8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-14 09:34:58 +01:00
Scott Rifenbark 709bc59582 documentation/poky-ref-manual/ref-structure.xml: wording change to chapter.
(From yocto-docs rev: abd9bed2df669462913d70b15c2033d05cc216e6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17 10:54:11 +01:00
Scott Rifenbark 3eae2a05fc documentation/poky-ref-manual: Re-cast structure appendix as chapter
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-structure" appendix to a chapter and
made sure the two references in the doc set use the proper term now
(chapter).

(From yocto-docs rev: 840a3e4dab355e53fdb400674bd6765957b24066)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17 10:54:10 +01:00
Scott Rifenbark 402383637b documentation/poky-ref-manual: Fixed various references to YP
I did a scrub for "Yocto Project" and found some that could be
changed.

(From yocto-docs rev: 985062b6a9320e8a3ca3d3dafb6516db4fbc5bd5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17 10:54:09 +01:00
Scott Rifenbark 229f7c57ee documentation/poky-ref-manual/ref-structure.xml: log directory and typo
Updated the build/tmp/log directory description to mention that running
a build does not necessarily mean a log directory is created.  Also,
ran a spell check and found a typo.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: c602919a1f188a4dff23f965bcc52b635f9a92ae)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-06 09:39:24 +01:00
Scott Rifenbark 4239ff0532 documentation/poky-ref-manual/ref-structure.xml: removed "/" from recipes.txt
the section describing meta/recipes.txt had the "/" character at the
end of the filename, which is incorrect.  I removed this.

Reported-by: Paul Eggleton <paul.eggleton@linux.intel.com>
(From yocto-docs rev: 28295d8c46d3a2cc6b53f0a7ccea35f1db77d1df)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-06 09:39:24 +01:00
Scott Rifenbark cb2e0ee066 documentation/poky-ref-manual/ref-structure.xml: Edits to BitBake directory
Made a few edits to better describe how the scripts and bin/bitbake
directories are placed into the PATH variable.

Reported-by: Paul Eggleton <paul.eggleton@linux.intel.com>
(From yocto-docs rev: 1e45731898935d40db6e6705f60bdea9633255ab)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-06 09:39:24 +01:00
Scott Rifenbark ef098d575e documentation/poky-ref-manual/ref-structure.xml: Updated BitBake
The description of how BitBake is run and where its executable and
wrapper script reside has been updated to be more accurate.

Reported-by: Robert J. P. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 885b4c42a3ec3d228f1f5659a887627f4fe2d939)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-06 09:39:24 +01:00
Scott Rifenbark 1e6343d3d0 documentation/poky-ref-manual/ref-structure.xml: Added meta/recipes-rt.
this information was missing in the appendix.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 64ea0871e0a6cef45259502ff26e1c5b5a66cac1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-05 14:21:57 +01:00
Scott Rifenbark e0dc993af6 documentation/poky-ref-manual/ref-structure.xml: Added tmp/deploy/licenses
Information about this directory was absent in the manual.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 64e5f5a403e4c8494885c7da504194d1baecb0ed)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-05 14:21:57 +01:00
Scott Rifenbark 5966b44893 documentation/poky-ref-manual: Yocto Project scrub
I have changed as many "Yocto Project" terms as possible so that
better reflect reality.

(From yocto-docs rev: 5f729e53b0cb653c97621e4e6598d9295d60ada5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-03 14:55:03 +01:00
Scott Rifenbark 264e5978e4 documentation/poky-ref-manual/ref-structure.xml: Clearer reference to variable
Another instance of possible confusion between a shell
environment variable and a BitBake environment variable.
I cleared this one up.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: e02596d940434806820f071218d2eb89c872cf3c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-26 12:13:49 +01:00
Scott Rifenbark ceaf19ff67 documentation/poky-ref-manual/ref-structure.xml: Clearer variable ref
There is confusion in the manual regarding shell environment
variables and BitBake environment variables.  I fixed this
instance to specify shell environment variable.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: f6cd520323e12124217975cff09d03a6f5e03936)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-26 12:13:49 +01:00
Scott Rifenbark 9bdc18a820 documentation/poky-ref-manual: Converted to use poky.ent variables.
Fixed all the hard links to use appropriate variables from the
file poky.ent.

(From yocto-docs rev: 9a6267d0d843dc47c1171eba6200387901b77df4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-23 14:24:44 +00:00
Scott Rifenbark 9dc84b77ec documentation: Cross-referencing section fixed for consistency.
(From yocto-docs rev: 8e861c6fc07aefa81ff65e3542de855116e14969)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:52 -08:00
Scott Rifenbark 797758c0d4 documentation/poky-ref-manual: Link updates
Pulling the "Common Tasks" chapter fromt YP Reference Manual
broke many links.  Each of these links had to be repaired so that
the link is to the YP Develepment Manual now, where the chapter
was moved to.

(From yocto-docs rev: 08176135b8ac856b8cf7872300ce41ada87fa486)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:50 -08:00
Scott Rifenbark 684c35b7aa documentation: Changed all manual links to point to "latest"
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>
2011-11-25 15:24:17 +00:00
Scott Rifenbark fdbc652b08 documentation/poky-ref-manual: Removed "spitz" machine example.
This machine is out of date.  I replaced both occurences with
"qemux86", which is more relevant to YP.

(From yocto-docs rev: 8fe6feccc25f594a444b5177d1192899b3cbdd9c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-30 17:27:39 +01:00
Scott Rifenbark 9ca6806de9 docuementation/poky-ref-manual/ref-structure.xml: Changed SRCDATE reference
I was incorrectly referring to SRCDATE variables in a context that should
have been SRCDATE destinations.

(From yocto-docs rev: eb255d9369b5bb3905a586433d472fd100c737dc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:59:55 -07:00
Scott Rifenbark d02e56fd14 documentation: Changes to Paul Eggleton's edits for various manuals.
Paul sent me a bunch of minor edits and technical corrections
for the ADT, BSP, Development, and YP reference manual.
Most changes were taken as he submitted them.  However, some
formatting conventions were not followed in the commits he made
to yocto-docs/paule/docs2.  After merging them to my yocto-docs/master
branch I fixed some issues.

(From yocto-docs rev: 93f4ea2dee976448f623953e801a80d59736450a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:38 -07:00
Paul Eggleton e4e0d026c1 documentation: typo, spelling & minor grammar fixes
(From yocto-docs rev: a5b069b04979a566b08415cf27af2ad6abf90f2f)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:35 -07:00
Paul Eggleton 6ca8903629 documentation: correct QT to Qt
(From yocto-docs rev: 37ac4cbd61bc8c891aa6dc05baf632a0a4bfd906)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:35 -07:00
Scott Rifenbark 39de08c105 documentation/poky-ref-manual/ref-structure.xml: Scrubbed for Poky and edits
I converted "Poky" to "the Yocto Project."  I also updated several examples.
In particular the build/tmp/work example.

(From yocto-docs rev: eb82bc36904f502fb4f314ff05eb86cff27ce0b6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:05 -07:00
Scott Rifenbark 64bac7f446 documentation/poky-ref-manual/ref-structure.xml: Fixed a type (From yocto-docs rev: b2f45f73832a2289158bfb89313957a48dded1cd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-24 11:14:00 +01:00
Richard Purdie 6d49cb5332 Rename poky-init-build-env to oe-init-build-env
(From yocto-docs rev: 15bedcbd988300c2fdf880c5f15def50310049e2)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-04-21 13:08:42 +01:00
Scott Rifenbark cb2a3e32d7 documentation/poky-ref-manual/ref-structure.xml: Edits for Rel 1.0
These edits reflect changes in the directory structure from the 0.9
version of the software to the 1.0 version.  This set of changes still
is missing a few items.  Changes were based on Saul Wold's input.

(From OE-Core rev: 6288e2af1b05d849e53b90071c66bc893ba015b6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-04-06 08:01:21 -07:00
Scott Rifenbark 2981801fc9 documentation/poky-ref-manual/ref-structure.xml: bitbake section updated
Section A.1.1 (bitbake/) contained two URLs.  One supposedly went to
a BitBake site and the other to the BitBake online manual.  In reality,
they both went to the online manual.  I removed the one referencing
the site.

(From OE-Core rev: 02c360c3e57409a3982db73ed2b998a7c58610a6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-04-06 08:01:17 -07:00
Scott Rifenbark 252cecf379 documentation/poky-ref-manual: English scrub performed for consistency.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:25 -08:00
Richard Purdie 80eba26fb1 documentation/poky-ref-manual: Various tweaks to the text
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-15 15:07:06 +01:00
Richard Purdie 2208328791 handbook: Move into documentation directory
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-15 11:55:59 +01:00