Commit Graph

43 Commits

Author SHA1 Message Date
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 da83cea7e4 documentation/kernel-manual/Makefile: Updated Makefile so PDF is in tarball
(From OE-Core rev: dc4c7e396833dd3d0839c458b8762a89e0979138)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-04-06 08:01:23 -07: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
Scott Rifenbark b631f486fe documentation/kernel-manual/kernel-manual.xml: Updated the title page
I updated the title page to add Revision 1.0 to the Revision history
table.

(From OE-Core rev: 5062c0e09b5e2c4894ccfe322977fdd432b87e39)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-18 16:48:00 +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 b8160345a0 documentation/kernel-manual: Kernel manual Style changes
Modifications to the figure image (figures/kernel-title.png),
the heading styles (style.css), and the numbering system with
TOC display (yocto-project-kernel-manual-customization.xsl).

I updated the title image to display the manual title using
color #00557D, which coordinates with the Yocto Project website
color scheme.  I also updated the style sheet to use this same
color for the section headings.  This helps to set them off better
from the text.  Finally, I flipped the switch back on for this
manual to create chapter-specific table of contents sections
prior to each chapter and to include a all-inclusive TOC at the
beginning of the book.

(From OE-Core rev: 2f24addbd02039fb9b6489c90c5d1c687c0d0698)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-04 22:26:42 +00:00
Scott Rifenbark cae622c0cc documentation/kernel-manual/figures/kernel-title.png: Updated title graphic
I changed the font to Arial Narrow and inserted a better logo.

(From OE-Core rev: 7b84f126b09125b306ea9f9b59c437bb741800d2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-04 22:26:41 +00:00
Scott Rifenbark f6fdcb661b documentation/kernel-manual/kernel-manual.xml: Updated copyright date
Changed the copyright date from "2010" to "2010-2011".

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-25 09:10:28 -08: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 ba3b0db61f documentation/kernel-manual/figures/kernel-architecture-overview.png: updated figure
Updated the figure to not use "preempt_rt".  Now uses "preempt-rt".

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-12-20 14:41:44 +00: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 be622ae87e documentation/kernel-manual/kernel-concepts.xml: Re-worded a note to state best practices for organizing shared features.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:28 -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 23dcc1bf97 documentation/kernel-manual: Added an image to the authorgroup so a title would display in the HTML version of the manual.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:21 -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 1722898e16 documentation/kernel-manual/kernel-manual.xml: Changed the copyright statement to conform to sharing.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:19 -08:00
Scott Rifenbark 14a8edb09c documentation/kernel-manual/kernel-concepts.xml: Updated the text so that the conceptual figure showing the kernel is out.
Feedback indicated by Dave suggested getting rid of this.  So I commented out the text around it and modified the reminder text so it did not reference a figure.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:18 -08:00
Scott Rifenbark 15cf572f3e documentation/kernel-manual: Modified to call new chapter structure.
The make process for the kernel book now includes multiple chapters instead of a single chapter.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:17 -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
Scott Rifenbark d2e540116f documentation/kernel-manual/yocto-project-kernel-manual.xml: Removed this file so manual could be structured into a book with chapters.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:16 -08:00
Scott Rifenbark 62ef8bdc57 documentation/kernel-manual/Makefile: changed the pdf, tgz, and html output files to be named "kernel-manual"
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:15 -08:00
Scott Rifenbark 05c8e137e4 documentation/kernel-manual/Makefile: changed the name of the PDF output file to "kernel-manual.pdf"
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:14 -08:00
Scott Rifenbark c479301fca documentation/kernel-manual/kernel-manual.xml: added this file so that PDF could be built.
This is inline with how the other docs are built.  kernel-manual.xml
is called by xsltproc from the Makefile.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:14 -08:00
Scott Rifenbark d468cc4e49 documentation/kernel-manual/yocto-project-kernel-manual.xml: removed the code that inserts the image.
I made this file similar to the bsp.xml file so that it would build into
a PDF file.  It was throwing an error because of the imagedata tag
that was up front.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:13 -08:00
Scott Rifenbark 5ed39a3770 documentation/kernel-manual/Makefile: Added code to create a PDF version.
Code now calls a new file called kernel-manual.xml that in turn
includes the yocto-project-kernel-manual.xml file.  This is in line
with how the other docs are built.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:13 -08:00
Scott Rifenbark 5d64bb0193 documentation/kernel-manual/figures/kernel-title.png: Added a PNG file to display in the PDF version on the title page.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:12 -08:00
Scott Rifenbark b89a971761 documentation/kernel-manual/yocto-project-kernel-manual.xml: Added a new section called "BSP: Creating:
this section is based on an email that Bruce Ashfield sent me.  It replaces
what was in there in the form of sub-sections for creating a new BSP,
cloning one and bsp bootstrapping.
2010-12-10 22:01:12 -08:00
Scott Rifenbark 7dbdd91eb9 documentation/kernel-manual/style.css: Changed h2 through h6 styles.
I needed more demarcation for these section titles.  They were not visually
different enough.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:11 -08:00
Scott Rifenbark 5b10a72004 documentation/kernel-manual/yocto-project-kernel-manual.xml: Removed sections not fit for 0.9 release.
These sections were commented out after a review by Bruce Ashfield.  They
need to be revisited as we continue with the 1.0 work.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:10 -08:00
Scott Rifenbark 2982e7c405 documentation/kernel-manual/yocto-project-kernel-manual.xml and yocto-project-kernel-manual-customization.xsl: Renamed files with correct spelling for kernel.
I had to rename these files because I had kernel mis-spelled when I committed
the original manual files.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:09 -08:00
Scott Rifenbark bad46abb89 documentation/kernel-manual/yocto-project-kernal-manual.xml: and yocto-project-kernal-manual-customization.xsl removed from tree.
I noticed I had mis-spelled kernel for these files names after committing
the new kernel manual.  I renamed the files and had to remove these two.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:09 -08:00
Scott Rifenbark 3e7a8a64af documentation/kernel-manual/Makefile: fixed mis-spelling of kernel for files
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:08 -08:00
Scott Rifenbark 000f052765 documentation/kerenl-manual: New directory and files for kernel manual.
This is the first draft of the Yocto Project Kernel manual.  The
manual consists of two sections: concepts and a practical section that
has examples.  It is based of Bruce Ashfield's kernel theory paper.
This first draft has been re-written and organized through the
concepts section.  The remainder was just placed in as-is due to
time constraints for getting some kernel documentation up on the website.
The manual still needs scrubbing and organization in the latter half.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:07 -08:00