Commit Graph

29 Commits

Author SHA1 Message Date
Scott Rifenbark abb6287a4f ref-manual: Changed depends.dot filename to pn-depends.dot.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: ecc38e4c71fe21223ed5ddfdabc7f6a7c41ec5a3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:54:06 +00:00
Scott Rifenbark 65b7f134fb ref-manual: Added the pn-buildlist file to list of files
In the "Dependency Graphs" section, the pn-buildlist file was
not mentioned as a file generated by the
'bitbake -g <target>' command.  I added this in and provided a
bit of re-writing.

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

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:54:05 +00:00
Scott Rifenbark 33e7953a58 ref-manual: Cleaned up some instances of the term "working directory"
This term should always reference a users current working directory
and not be confused with the OpenEmbedded build system's "work
directory (WORKDIR).  I found several instances where the term
"working directory" was not used correctly and fixed them.

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

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:54:05 +00:00
Scott Rifenbark 9addcf5ccb documentation: Scrubbed use of directory names
There was inconsistent use of the way directory names were
handled throughout the YP documentation.  I have scrubbed the
set and replaced many instances such as the following:

meta/<something> replaces /meta/<something>
poky replaces ~/poky (except in some very specific examples)

I basically got rid of leading slash characters.

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

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:53 +00:00
Scott Rifenbark bf77e55a5e ref-manual: Updates to "Variables" and "Building with No Dependencies"
There was some confusion over some things in these two sections.
I re-wrote them with the help of Paul Eggleton to be clear on
them.

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

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:51 +00:00
Robert P. J. Day b107150ed8 ref-manual: Pedonic tweaks to ref manual usingpoky.xml
Patch from Robert P. J. Day.  Good catches for some minor
wordings and such.

(From yocto-docs rev: bb5befebdfc642958ec3544cba752aab0d933936)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:50 +00:00
Scott Rifenbark 5dfb1de6ff ref-manual: Updated files in the image part of build history
Fixes [YOCTO #5303]

Added a bullet item to the files listed as part of images
in the buildhistory figure.

(From yocto-docs rev: 5c4c581cde509b880b0d36dad399df0cb510b2d2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-10-08 16:30:15 +01:00
Scott Rifenbark a266619317 documentation: Added the memory-resident BitBake feature
The main changes are captured in a new section devoted to the
oe-init-build-env-memres script within the ref-structure.xml
file and in the variables.xml file in a BBSERVER variable entry
in the glossary.

All other changes were necessary to integrate the new functionality
into areas where running the setup script are discussed.  Before
this feature, there was a single setup script (oe-init-build-env).
Consequently, wordings and such were designed exclusively for this
single method.  With the introduction of a second possible method
to initialize the build environment, tweaks to many sections were
needed.  Beside the wording tweaks, appropriate cross-referencing
was also needed.

All these changes cover the integration of the new feature.

Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: c55c9a53c9b4cd1e06e6e81e32d56f9bbf5fe98c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-12 16:50:10 +01:00
Scott Rifenbark aeead1fe2d dev-manual, ref-manual, poky.ent: Fixed broken Release Note scheme
The URL naming convention for the YP Release Notes has changed.
It now takes the following form:

  http://www.yoctoproject.org/download/yoctoproject-15-poky-1000

The above is an example for YP Release 1.5 and poky release 10.0.0.

I have set up three new variables in the poky.ent file to somewhat
automate the links in the docs to point to the location of a given
set of release notes:

 1. DISTRO_COMPRESSED - set to the DISTRO string with no period
    (e.g 15 for 1.5).

 2. POKYVERSION_COMPRESSED - set to the poky version with no
    periods (e.g. 1000 for 10.0.0).

 3. YOCTO_RELEASE_NOTES - set to the full-blown release note
    URL.

I made two changes to existing links for the Release Notes.  One
was in the dev-manual and one was in the ref-manual.

(From yocto-docs rev: e6088927980a1de8022b22f7f38b3046fea20235)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-31 08:19:21 +01:00
Scott Rifenbark 514176c231 dev-manual, ref-manual: Minor edits suggested by Bill Traynor
Applied some re-wordings as suggested by Bill Traynor.

Reported-by: William M.A. Traynor <wmat@alphatroop.com>
(From yocto-docs rev: 2510d9795720afc0309a10b18605e5af4a83769b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22 17:23:38 +01:00
Scott Rifenbark 2b83480cb1 ref-manual: Minor edits to patch 3 of 5 for build history.
(From yocto-docs rev: 76badd435b858fd37181baabefb39bfa656baf1c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-10 16:20:53 +01:00
Paul Eggleton 14f33c1ca7 ref-manual: Applied Paul Eggleton's Build History Patch 3 of 5.
Add a paragraph to the top of the section on buildhistory mentioning the
metadata-revs file and the top-level directories.

(From yocto-docs rev: ae7c7c64dd31f5b5c57eac9c772972523f49c05a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-10 16:20:53 +01:00
Scott Rifenbark e822444f5c ref-manual: Edits applied to buildhistory patch 2 of 5.
Did some rewriting to conform to the manual's style and
formatting.

(From yocto-docs rev: 6a961978b207d8992ade86f82838914b858accdb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-10 16:20:53 +01:00
Paul Eggleton ea8e60842d ref-manual: Applied Paul Eggleton's buildhistory patch 2 of 5.
Additional information added to the end of the
"Build History Package Information" section."

Buildhistory now collects information on SRCREV values for recipes
fetched from a version control system e.g. Git; additionally a
buildhistory-collect-srcrevs tool is provided to gather this and
convert it to a format suitable for inclusion in global configuration.
Add information on these new features to the appropriate section.

(From yocto-docs rev: 8c38bcbe8e737d7dfb41a763c87a3a6269e6f980)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-10 16:20:53 +01:00
Scott Rifenbark 67f4fd4ffa ref-manual: Edits to buildhistory patch 1 of 5.
I did a bit of cleanup on the text from Paul's patch number 1.
Just some active voice stuff mainly.

(From yocto-docs rev: f08fa3da997e53c587e3f17ef908e41594654db3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-10 16:20:53 +01:00
Paul Eggleton 58122bf063 ref-manual: buildhistory patch 1 of 5 applied.
New section titled "Build History SDK Information" added.

(From yocto-docs rev: aaa9ee5690a68f72b21ca3ab731942d80acac2f3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-10 16:20:53 +01:00
Scott Rifenbark 0f0fe73a72 ref-manual: Fixed typo.
(From yocto-docs rev: ba5854e0d46f33ec13d6c17c121285e5e719d19a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:51 +01:00
Scott Rifenbark c869fe541c ref-manual: Minor edits to "Enabling and Disabling Build History"
(From yocto-docs rev: 2d23ad6f5f9047d37496f686dd1f9d8265ee7d55)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:51 +01:00
Scott Rifenbark 32d403e643 ref-manual: Edits to "Other Tips" section.
(From yocto-docs rev: 46147dadd1627ba24c2cca27a47872b7390c354f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:51 +01:00
Scott Rifenbark 187ed1edf7 ref-manual: Punctuation fix in "Logging With Bash" section.
(From yocto-docs rev: 7b13b4b664802b31233ac3638913091d3a7af45c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:50 +01:00
Scott Rifenbark b359ed8fc5 ref-manual: Minor fixes in "Logging With Python" section.
(From yocto-docs rev: 6dac8debd55756b907112f8470e5ea9adececeed)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:50 +01:00
Scott Rifenbark 0c0870cb70 ref-manual: rewrite of the "Variables" section.
this was really old text and had not been touched since the
original poky handbook days.  It was terrible.

(From yocto-docs rev: 4f3efdbf2920f7d3f2d0d0526d08340c6204856a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:50 +01:00
Scott Rifenbark d9bfe5cd18 ref-manual: Typo fixed.
(From yocto-docs rev: bcf125eb34bfafcf828cdcb44f9bdaa9a21e7007)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:50 +01:00
Scott Rifenbark 4db0c3277b ref-manual: Small updates to the "Running Specific Tasks" section.
(From yocto-docs rev: e5be2cd9d949fdb5dab1e6965c5970b5a62359fc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:50 +01:00
Scott Rifenbark 8db644a6d4 ref-manual: Edits to the "Debugging Build Failures" section.
Added a couple cross-references for some general debugging
information within the manual set.

(From yocto-docs rev: d102e90fc9b24aa703eeb4488561058c258600d6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:50 +01:00
Scott Rifenbark ae100bf286 ref-manual: Removed "/" as part of a sentence.
(From yocto-docs rev: e578cf8ec7bbd571b6ba5842fe1a24c219916181)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:50 +01:00
Scott Rifenbark 942f915b28 ref-manual: Various edits to the "Build Overview" section.
(From yocto-docs rev: ad017a31cc79b97baaa562d05aa0dab3bf45bd35)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:50 +01:00
Scott Rifenbark 717c56caff ref-manual: Created "Development Host System Issues" section
Fixes YOCTO #2790

Created a new section in the "Debugging Build Failures"
section to deal with host issues that cause a build to
fail.

(From yocto-docs rev: 9efc00146764086646b0c558d12168ab9813d683)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:25:44 +00:00
Scott Rifenbark ed0a240e16 documentation: Rename of poky-ref-manual folder to ref-manual.
Changing the folder that holds the YP Reference Manual to be
"ref-manual".  This will help with confustion over the manual's
intended purpose.

(From yocto-docs rev: 1106442964b5080cb0b6b3bd3af32e9407c0f7c1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-07 14:43:25 +00:00