Commit Graph

49 Commits

Author SHA1 Message Date
Scott Rifenbark 9137117b3f documentation: kernel-manual - minor edits before lockdown
Fixed a few references and links.  Also standardized on the
capitalization for the term "Source Directory" where it
refers to the YP poky structure on the development machine.

(From yocto-docs rev: 1a20418d8791d754ad66c5a059e65bd68a4c6b32)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-23 00:03:13 +01:00
Scott Rifenbark 20a2dda2c2 documentation: bsp-guide, dev-manual, kernel-manual - Removed links
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>
2012-10-04 14:08:20 +01:00
Scott Rifenbark d192e6f2ad documentation: Section change for using email to submit patch
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>
2012-09-04 12:55:00 +01:00
Scott Rifenbark 6b357655fe documentation: Section Heading change for pushing commits
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>
2012-09-04 12:55:00 +01:00
Scott Rifenbark b84383a7e1 documentation: Fixed references to the YP Dev Manual
The references to the YP Development Manual were inconsistant.
These references were fixed.

(From yocto-docs rev: f4ded0b965fcbce7b500ca21886ee9b755c38383)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:54:56 +01:00
Scott Rifenbark 5c44309cfe documentation/kernel-manual: Fixed minor problems
I did a read-through of the manual and spotted several nits that
I fixed.  All these are minor fixes.

(From yocto-docs rev: 0c8f9c660ecea0b36e2b6af0315d3d239f70a688)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:54:55 +01:00
Scott Rifenbark e70dc3ab99 documentation/kernel-manual: Scrubbed the Yocto Project term
Changed all occurrences of "Yocto Project" to terms better suited
to reality.

(From yocto-docs rev: fdd7b8c2bcbaf566cad336c67c582c2a24aa9dc1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-03 14:55:02 +01:00
Scott Rifenbark c29a721a68 documentation/kernel-manual/kernel-how-to.xml: Updates to showing changes
I updated the "Show a Particular Feature or Branch Change" section so
that it reads better.  I also included some real examples.

(From yocto-docs rev: 42aa13c7fbf45abf869b056deec063be6682c70b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-15 17:18:25 +01:00
Scott Rifenbark de4cdfd6bc documentation/kernel-manual/kernel-how-to.xml: Updated to kernel 3.4
According to Bruce Ashfield, we will be using linux-yocto-3.4.  So
I changed the linux-yocto-3.0 strings to linux-yocto-3.4.

(From yocto-docs rev: 23df0251b04ed7c31ad2297a4a7870861554beef)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-05-31 21:16:55 +01:00
Scott Rifenbark d048a99e24 documentation/kernel-manual: Converted to use variables from poky.ent.
Also removed a broken link.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-23 14:24:43 +00:00
Scott Rifenbark b94e91043d documentation/kernel-manual/kernel-how-to.xml: edits to tree construction
I made some clarifying edits to the section that describes how
the YP team constructs the kernel repositories (the tree).  There
were some things that just weren't clear.

(From yocto-docs rev: 127f0c8c89ec9b926a4ff348acc39a73f41e6fe7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:45 -08:00
Scott Rifenbark 8cebd209b5 documentation/kernel-manual/kernel-how-to.xml: links to manuals removed
Several redundant links existed to manuals that are not required to
be linked.  The actual link takes the reader to the section being
referenced.  Then, after the link, the manual is referenced.  Previously,
the manual was also linked.  We don't need these links to the manuals.

(From yocto-docs rev: 579f4efd765dc20b38e1b022ae4b7a98a8fa53cd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:44 -08:00
Scott Rifenbark 40f44ec529 documentation/kernel-manual/kernel-how-to.xml: general edits
Some general edits up to section 3.4.

(From yocto-docs rev: 5bcd22b6372017c4f78b18035193879890ed8244)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-06 12:13:12 +00: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 e0172675a0 documentation/kernel-manual/kernel-how-to.xml: Updated build strategy
This section used the term "tree construction" somewhat out of context.
The section really focuses on what the build process and the user does
prior to compilation.  I changed wording to indicate the tree is
validated to be sure that the SRC_URI point to the right stuff and
that the BSP build branch exists.

(From yocto-docs rev: e6332d5045b21354b53bbbe1203f9d52d4d97964)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:46:43 +01:00
Scott Rifenbark 11815ab092 documentation/kernel-manual: Added some references to other areas of YP docs.
(From yocto-docs rev: 20754cb376e65b7262b754afad839e0c2b82d7f7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:46:41 +01:00
Scott Rifenbark d546b8f793 documentation/kernel-manual: Scrub for 1.1
I went through and made sure examples are relevant, wording is correct,
large blocks of unused text was removed, and some references included
to other YP documents.

(From yocto-docs rev: 2231082530dd9cecc234f5f024c4e246afb2968d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:46:41 +01:00
Scott Rifenbark 7d465d6040 documentation/kernel-manual/kernel-how-to.xml: command indentation fixed.
(From yocto-docs rev: d3116dbda4af7f469e10449ed27b2885474317b5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:46:34 -07:00
Scott Rifenbark 51b3a231b0 documentation/kernel-manual/kernel-how-to.xml: Tree Construction section further explained
Added text to help put tree construction into context with the developer.
The section felt as if the developer needed to be taking action on the steps
when in reality the steps are describing a lot of "behind-the-scenes" stuff
that happens when the YP tree is constructed.

(From yocto-docs rev: 1aafca94f3f3d5e07a0b2244ff5dbfe4a2c1ba8f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:21 +01:00
Scott Rifenbark 0a7b3f8fdd documentation/kernel-manual/kernel-how-to.xml: Defined audience for chapter
Added a sentence clarifying the intended audience of this chapter.  It is
specifically for developers that want to modify the YP kernel and contribute
changes upstream to YP.

(From yocto-docs rev: 1012dcb8312cb83fe64397742142071f20ae4e24)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:20 +01:00
Scott Rifenbark dc96712c53 documentation/kernel-manual/kernel-how-to.xml: Updated the create BSP section
This section has been re-written to just include high-level overview of the
steps.  The detailed example that used to be the section is not needed as
there is adequate documentation of this process in the Yocto Project
Development Manual and on the wiki courtesy of Tom Zanussi.

(From yocto-docs rev: 7355734a5ed965401027ba23bfb15fd926a171f7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:20 +01:00
Scott Rifenbark 72054b8f83 documentation/kernel-manual/kernel-how-to.xml: Added 'git' for a push example.
I forgot the 'git' part of the 'git push' command for the fix requested by
Robert P. J. Day.

(From yocto-docs rev: 458e18bd9d33c12ff3367cae8a4cc0c6c640b932)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:20 +01:00
Scott Rifenbark 00d2062bd5 documentation/kernel-manual/kernel-how-to.xml: Command line example fixes
Changes requested by Robert P. J. Day at rpjday@crashcourse.ca to add
a missing system prompt character and fix an overly long git push example.

(From yocto-docs rev: 71ac0b23682c6a405ae454cab02120993d2f370e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:20 +01:00
Scott Rifenbark 74c120f273 documentation/kernel-manual/kernel-how-to.xml: changed git to Git as needed (From yocto-docs rev: 65a839ea3d8decd1dd3e95bfeeeb3f95cfa77ef4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:20 +01:00
Scott Rifenbark 7c12513fec documentation/adt-manual/kernel-how-to.xml: Changed Bitbake to BitBake (From yocto-docs rev: c3b3d7f7b16bc222d599bdfb5e99c86694a1c865)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:19 +01:00
Scott Rifenbark fb71e5092a documentation/kernel-manual/kernel-how-to.xml: Partial - more general edits (From yocto-docs rev: 60d084a5b17bf78fafd8a4d13b9055093fca708a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:19 +01:00
Scott Rifenbark 3120247447 documentation/kernel-manual/kernel-how-to.xml: partial - more edits to BSP procedure (From yocto-docs rev: 694b00c080633be874f2842badedf1e453038f88)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:19 +01:00
Scott Rifenbark fe438753ba documentation/kernel-manual/kernel-how-to.xml: Partial - Re-write of BSP creation
This is a partial edit of re-writing the BSP creation section so that
it is clearer for the naive user.  It is not quite done yet.

(From yocto-docs rev: 7a552e72a1d2d1b6ffa93f4fe3074f318ff35715)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:19 +01:00
Scott Rifenbark 1316648ae6 documentation/kernel-manual/kernel-how-to.xml: Edits to "Build Strategy" (From yocto-docs rev: f98e4804da9477e260e24df1586b624e386a2dba)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:19 +01:00
Scott Rifenbark f79f929bf3 documentation/kernel-manual/kernel-how-to.xml: Edits to "Tree Construction" (From yocto-docs rev: 601e0fd1bb00c433716170a124b3ca32ca2cdcad)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:19 +01:00
Richard Purdie e9b17e3fa7 Rename poky-image-* -> core-image-* and task-poky-* -> task-core-*
(From yocto-docs rev: 0feb6b8f9621087ba5fd77d3c8f3e23132c97187)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-04-21 13:08:45 +01:00
Scott Rifenbark f86b7c52f1 documentation/kernel-manual/kernel-how-to.xml: replaced 'pokylinux' with 'yoctoproject'
(From OE-Core rev: 39f8b1b13072598729a189fb58c14622d300db69)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-04-18 05:51:23 +01:00
Scott Rifenbark aa51d032b1 documentation/kernel-manual/kernel-how-to.xml: Spell checked
Performed a spell check and found a couple items.

(From OE-Core rev: 45039d008519c13f97d9b195bba4505b3865b5ea)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-18 16:48:01 +00:00
Tom Zanussi 4f5b57c67e documentation: Kernel Manual fixes
Upgraded to reflect 1.0 usage rather than 0.90 usage, and some other
clarifications and minor changes.

[RP - added tweaks suggested by Darren Hart]
(From OE-Core rev: c6f06f478ac229c4619f815b8b313711d47b1551)

Signed-off-by: Tom Zanussi <tom.zanussi@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-14 21:08:38 +00:00
Scott Rifenbark 9f0f7c4390 documentation/kernel-manual/kernel-how-to.xml: Changes to section 3.4.4 and new 3.4.5
I made some updates to the 3.4.4 section according to Bruce Ashfield's
feedback.  I also added a new section 3.4.5 (Creating a BSP Based on an
Existing Similar BSP Without a Local Kernel Repository).

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-18 20:51:30 -08:00
Scott Rifenbark 07c159fd22 documentation/kernel-manual/kernel-how-to.xml: fix to step 3 and 4 of section 3.4.4
Added text after the sample bbappend file stating that the user needs
to update the KSRC assignment statement and also remove its comment.
Also they have to remove the comment from the SRC_URI line.

Changed the bitbake command in step 4 to use the linux-yocto-stable
file rather than the linux-yocto file.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-18 20:51:30 -08:00
Scott Rifenbark 6500cef062 documentation/kernel-manual/kernel-how-to.xml: Fix to step 3 of section 3.4.4
Changed 'linux-yocto_git.bbappend' to 'linux-yocto-stable_git.bbappend'
in step 3 just before the code example.  This makes the code consistent
with the rest of the example supporting the 2.6.34 kernel.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-18 20:51:30 -08:00
Scott Rifenbark 7c06c4f545 documentation/kernel-manual/kernel-how-to.xml: Fix to step 1 of section 3.4.4
Step one states that the linux-yocto_git.bbappend file is left.  This
file is associated with distro 2.6.37 kernel and the rest of the
example is associated with the 2.6.34 kernel.  So, I changed the
step to indicate that the directory is left with a linux-yocto-stable_git.bbappend
file.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-18 20:51:30 -08:00
Scott Rifenbark 647aaad6fb documentation/kernel-manual/kernel-how-to.xml: More changes to the creating BSP section.
These changes implemented Bruce Ashfield's next round of changes to the
section 4.3.3 example.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-14 17:07:36 -06:00
Scott Rifenbark 05ac368888 documentation/kernel-manual/kernel-how-to.xml: Fixed type
In section 4.3.3 step 2 there was a directory 'build/donf/bblayers.conf'.
I fixed the typo to 'build/conf/bblayers.conf'.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-14 17:07:35 -06:00
Scott Rifenbark 09e2aac993 documentation/kernel-manual/kernel-how-to.xml: - Condense and merge example changed.
The example used to show how to condense and merge two BSPs into a second
SCM used a non-existant machine (cav_ebt5800-standard).  I replaced this
machine with 'common_pc_64-standard, which is a real machine.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-14 17:07:35 -06:00
Scott Rifenbark 2a8c4a32be documentation/kernel-manual/kernel-how-to.xml: [BUGID# 597] Reversing common-pc-standard
[BUGID# 597] - After talking with Bruce Ashfield the kernel documentation
needs to support the 2.6.34 disribution.  So, the 'common-pc-standard'
strings need to be changed back to 'common_pc-standard'.  This fix restores
them.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-14 17:07:35 -06:00
Scott Rifenbark 721a9340d6 documentation/kernel-manual/kernel-how-to.xml: [BUGID# 597] Fixed common_pc
[BUGID# 597] - Changed the string "common_pc" to "common-pc".

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-14 17:07:35 -06:00
Scott Rifenbark ef8e0d6f38 documentation/kernel-manual/kernel-how-to.xml: added newline character
There was a git checkout and git push command that did not have a newline
character between the two line in a literallayout block.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-14 13:43:55 -08:00
Scott Rifenbark 22cd27dac4 documentation/kernel-manual/kernel-how-to.xml: fixed typo bug 588
removed the ";" character that was part of the git log --pretty=oneline
command example.  This fixes bug [BUGID# 588].

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-14 13:43:54 -08:00
Scott Rifenbark 579b5c2947 documentation/kernel-manual: Added Bruce Ashfields review comments.
Comments covered some minor points.  We did remove the "Creating
a Transition Kernel Layer" section however.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:27 -08:00
Scott Rifenbark ddbd172dd8 documentation/kernel-manual/kernel-how-to.xml: Completed scrub to the text.
This version represents the completed first draft with all of Bruce Ashfield's comments applied and a good scrubbing of the text.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:20 -08:00
Scott Rifenbark 5bda926c80 documentation/kernel-manual/kerenel-how-to.xml: Edits to clean up text.
Re-writing up to the "Export for External (Upstream) Submission" section.
I am cleaning up the English and style.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:19 -08:00
Scott Rifenbark 2a993a0dac documentation/kernel-manual: Added these files so the book could have chapters.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:17 -08:00