Commit Graph

30 Commits

Author SHA1 Message Date
Scott Rifenbark d5848aa719 documentation: cross-manual links hard-coded for 1.1.1 release.
All the links to any YP manual for the 1.1.1 release now use
"http://www.yoctoproject.org/docs/1.1.1/....".

(From yocto-docs rev: 178d16e8693550341a4d307e36af934ce0bfe4c3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-30 16:05:50 +00:00
Scott Rifenbark caab52f6cc documentation/poky-ref-manual/usingpoky.xml: updated intro paragraph
Beefed up the introductory paragraph a bit.

(From yocto-docs rev: 99e0b95d4827dcc309ab0f212801fc86758a297d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-30 16:05:48 +00:00
Scott Rifenbark 5dd34a717e documentation/poky-ref-manual: New chapter introduced
Long-term strategy for the YP Reference Manual is that it contains
reference material and not "how-to-information".  A step in this
direction is to isolate any discussions on components and other
areas of YP that need talked about.  So to start with, I have created
a new chapter for now named "Technical Details" that so far has
a discussion of some components and shared state.  This is a
step in the direction of making this manual a reference manual and
not a "how to" manual.

Changes included removing redundant material from the 'usingpoky.xml'
chapter and also adding the new chapter 'technical-details' into the
'poky-ref-manual.xml' file used for the make.

(From yocto-docs rev: a01477f787768230bc25da2d094326922be23dd4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-30 16:05:48 +00:00
Scott Rifenbark e7cfb3b469 documentation/poky-ref-manual/usingpoky.xml: Removed comments
Removed some comments that were buried in the file that were
notes for working on the sstate section.

(From yocto-docs rev: bd03315031bbb1b682dcd2253f85fc184822a28e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-30 16:05:47 +00:00
Scott Rifenbark c2494d3014 documentation/poky-ref-manual/usingpoky.xml: partial for YOCTO #1500
First draft of a re-write to the "Running a Build" section to try
and satisfy YOCTO #1500.  I segmented the section into three areas
rather than a single area.  This allowed me to create a sub-section
for the sstate stuff where it could be addressed on its own.  I sent
the draft out to Richard and Mark H. and got feedback from RP that
is going to cause further changes.  Thus, I am committing this partial
change.

(From yocto-docs rev: f040ed6979e988968863016103aa3ad4e7365159)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-30 16:05:47 +00:00
Scott Rifenbark eae4945a9d documentation: Cleaned out bad links and replaced with good
The re-structuring of the web server that holds the documents created
some bad links.  I thought I had gotten them all but apparently not.
this is a drawback of not being able to test things until after stuff
is done.  In any case, I grepped through everything and this takes
care of it.

(From yocto-docs rev: cdbc3b3b7f6d6ff01024b977f966459cf414ad5c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-14 00:33:56 +01:00
Scott Rifenbark 4025831e90 documentation: scrubbed out 'glibc' and replaced with 'eglibc'
Several manuals and areas were still referring to 'glibc' as the
GNU version of the Unix statndrd C library.  We do not support this
any longer and now use 'eglibc' to build with.  Notable changes were
in the required packages area of the QS manual.  I also added a
bit in the reference guide saying how this release does not use
'glibc' to build with but rather 'eglibc'.

(From yocto-docs rev: c2c58914996d747c510706d78ecfd8f41c5e694d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 14:01:38 +01:00
Scott Rifenbark 31acde62ad documentation/poky-ref-manual/usingpoky.xml: Edits per Darren Hart
Darren provided me with some feedback on the logging mechanism
section for both Python and Bash.

(From yocto-docs rev: 7dddadf8caba01d3ef1046be52a1435eeaed60a3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-02 23:38:50 +01: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 d67201e600 documentation/poky-ref-manual/usingpoky.xml: Updated logging mechanism
Per Darren's feedback on this new section I updated changes based
on his comments.

(From yocto-docs rev: a5bbba42ec0da5b2f83f7a64ac8eef466e9c89b3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-30 17:27:37 +01:00
Paul Eggleton 88dfc936dc documentation: clarify specifying a specific package with -e
The -b option is not required to show the environment used to build a
specific package; usually the best practice is to specify the package
name alone.

(From yocto-docs rev: d59772fd7edd76dbc8018479c072badb591601c3)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:37 -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
Scott Rifenbark 90d5834ad2 documentation/poky-ref-manual/usingpoky.xml: small edits to list and title
I added emphasis to a bulleted list and I also updated a section title
to reflect Yocto Project instead of Poky.

(From yocto-docs rev: f967aff5c0a0047ef44145c6a95da84e57c255b1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:02 -07:00
Scott Rifenbark 8aa163ba69 documentation/poky-ref-manual: Changed top-level titles
Each of these chapters needed the title changes to reflect Yocto
Project and not Poky.

(From yocto-docs rev: a6d8d01b20af334ca9950c4287d61a728532f652)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:02 -07:00
Scott Rifenbark 295b855fc9 documentation/poky-ref-manual/usingpoky.xml: re-write for Yocto
General re-write to make the chapter Yocto Project friendly.
Weeded out the references to "Poky."

(From yocto-docs rev: ac4fc6082f458e5ee60962693ee332bbf1e3c1a9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:01 -07:00
Scott Rifenbark 00d483d65a documentation/poky-ref-manual/usingpoky.xml: YOCTO #1001 - new section added
YOCTO #1001 - created a new section to address this issue.  This is the
first draft.  Darren to provide review comments.

(From yocto-docs rev: fc2aee572cc3e620684533a12a2d8436dc0abe32)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:01 -07:00
Scott Rifenbark 0a2e82c007 documentation/poky-ref-manual/usingpoky.xml: Fixed double dash display.
In the PDF version of the manual the "&dash;&dash;" docbook statement
does not display correctly.  I changed this to "--".

(From yocto-docs rev: b0596e0ce370d6c6e1680e89d9c5a5b9da26dd93)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:46:36 -07:00
Scott Rifenbark 0eb49324c8 BUGID#_1083 - documentation/poky-ref-manual/usingpoky.xml: -k option added
In the section 2.1.1 BitBake I added a paragraph at the end of the discussion
about BitBake explaining the benefits of the '-k' and '--continue' options.

(From yocto-docs rev: 409e01cedbe8d93c29856fa2a49d5f9db91f5201)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-23 15:53:29 +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 cb13b57b1c documentation/poky-ref-manual/usingpoky.xml: [BUGID# 929] - Note added warning about switching up GPL versions
In chapter 2 where we talk about building images I added a new
note indicating that the user should not switch around using different
GPL versions when trying to rebuild an image as it can cause dependency
failures.

(From OE-Core rev: f84441dbcc8254062d55d2452d3d6f4bc6f907fe)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-31 22:02:54 +01:00
Scott Rifenbark 6243230675 - documentation/poky-ref-manual: Notes added for non-GPLv3 builds
[BUGID# 873] - Added a note in the Images Appendix indicating that
building an image without GPLv3 components is only supported for
base and minimal images.  Also put the two changes you have to do
to the local.conf file for the build.

Added a note in the second chapter in the section on building images.
The note indicates the same as in the appendix but does not go into the
local.conf file detail.

(From OE-Core rev: c7960a2e820d7ddb8649ab0b27b3f04843f7af0d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-18 23:33:08 +00:00
Scott Rifenbark 8e05ccaa0b documentation/poky-ref-manual/usingpoky.xml: Small edits
I made some minor edits.

(From OE-Core rev: bb6fbb484ec912aabca77fd4d124c97fc7f956e1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-18 17:22:24 +00:00
Scott Rifenbark 2a144f85a9 documentation/poky-ref-manual/usingpoky.xml: More BitBake changes
Forgot to search for "Bitbake" occurances.  These are now changed
to "BitBake."

(From OE-Core rev: 982826b61bf68244fad46ef52b5a203e648e330b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-18 17:22:23 +00:00
Scott Rifenbark fa272d09b7 documentation/poky-ref-manual/usingpoky.xml: grammar fix and BitBake fix
Fixed a grammar problem and then did a search and replace for
"bitbake" to replace with "BitBake".

(From OE-Core rev: a25074cf7f3383ea3963c4dabb9507af34f2e3df)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-18 17:22:23 +00:00
Scott Rifenbark 444597f44e Poky Reference Manual: Task wording made consistent
I am using "xxxxxx" task as the way to call out a specific task in the
text.  Previously a mix of <function>xxxxxx</function> and the "xxxxxx"
methods were being used.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:26 +00:00
Scott Rifenbark 00b5b4dff7 Poky Reference Manual: XML tag clean up and command example text indentation.
Removed a couple of redundant </ulink> tags.
Also indented the literallayout text by five spaces for formatting.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:24 +00:00
Scott Rifenbark 4b7f1eee28 General edits to the using poky and Extending Poky chapters.
I completed general edits to the second chapter of the poky reference
manual.  These edits went from section 2.4.5 through the end of the
chapter.  They consist of text rewrites for more active voice and follow
general technical writing principles.

I completed the same types of edits in the third chapter of the manual
from the beginning through section 3.3.2.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-04 20:20:06 +00:00
Scott Rifenbark 30e92723e1 General text edits through section 2.4.4 "General Bitbak Problems"
Extensive language and consistency edits being applied to the manual.
During the 0.9 push I did not have time to make a pass through the
document.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-04 20:20:06 +00: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