Commit Graph

4565 Commits

Author SHA1 Message Date
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
9f4c630dbd documentation/poky-ref-manual: changes applied from a patch submitted by Cyril Humbert.
Cyril submitted a patch via email form for several spelling corrections.  The master docs, however, are not up-to-date with what I have on my contrib area.  Many of Cyril's corrections were already addressed.  A few were not and I have updated them here with this commit.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:27 -08:00
Scott Rifenbark
111f0678ee documentation/poky-ref-manual: General edits up the Parsing section.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:26 -08:00
Scott Rifenbark
fcbacff683 documentation/poky-ref-manual: Changed spelling of bitbake to "BitBake" when used in text.
There is inconsistent use of how BitBake is spelled.  Sometimes it uses no capitalization, just a leading "B", or "BitBake".  I looked at the BitBake manual and it seems that "BitBake" is the correct way to refer to it.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:25 -08: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
Scott Rifenbark
57d38a7e7a documentation/poky-ref-manual: Updated Mailing Lists and IRC sections in Appendix I
I pulled the openembedded mailing list information and provided information for yocto@yoctoproject.org, yocto-announce@yoctoproject.org, and poky@yoctoproject.org.  I also updated the IRC section to include both #poky and #yocto channels.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:24 -08:00
Scott Rifenbark
11cdfab9cd documentation/yocto-project-qs: Added the gnome-doc-utils package to the Fedora required pacakge list.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:24 -08:00
Scott Rifenbark
4fe7cb5b21 documentation/poky-ref-manual: Fixed two typo's
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:23 -08:00
Scott Rifenbark
2f4db319b0 documentation/poky-ref-manual: Fixed to mis-spellings
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:22 -08:00
Scott Rifenbark
6d46bc3fcf documentation/poky-ref-manual: Updated the list of links to include a link to the Yocto Project site.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:22 -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
c272830d8c documentation/poky-ref-manual/poky-ref-manual.xml: Changed the revision date to 24 November 2010
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
Scott Rifenbark
aa58345393 documentation/yocto-project-qs/yocto-project-qs.xml: Corrected poky-qemu command example in the 'Using Pre-Build Binaries and QEMU' section.
Added fstype to the command form and also inserted an example use.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:07 -08:00
Scott Rifenbark
eccaafa620 documentation/poky-ref-manual/development.xml: Fixed orderedlist and itemizedlist spacing.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:06 -08:00
Scott Rifenbark
a20a167cf7 Poky Reference Manual: General edits to the developing chapter.
Completed the second half edits to this chapter.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:06 -08:00
Scott Rifenbark
8feae13423 Poky Reference Manual: Added INC_PR documentation.
Added an entry in the glossary for INC_PR.  Also updated section
"Package Revision Incrementing" to mention the use of INC_PR in conjuntion
with the PR and PV variables.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:05 -08:00
Scott Rifenbark
e7e12483e4 BSP Guide and BSP Chapter: Sync'ed these two files
After moving BSP Guide into its own folder for documentation I discovered
a consequence of that.  There are two separate bsp.xml files now:  one
in the poky-ref-manual folder and one in the bsp folder.  I had done some
good cleanup work in the version in the poky-ref-manual folder.  This
commit reflects a 'meld' operation where I re-sync'ed the bsp.xml
file in the bsp-guide folder to be the same (almost) as the one in the
poky-ref-manual folder.  There is still one slight difference between the
two files due to one's context as a stand-alone manual and the other as
a section in a larger book.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:05 -08:00
Scott Rifenbark
12d1378990 BSP Developers Guide: Edits to text
I made several spelling corrections and rewrote a sentence or two for
better structure.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:04 -08:00
Scott Rifenbark
62f93ac42d Poky Reference Manual: General edits up to the "Debugging with GDB Remotely" section.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:26 +00:00
Scott Rifenbark
175be120f3 Poky Reference Manual: Added a glossary definition for BBPATH.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:26 +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
8914519565 Poky Reference Manual: General edits for English.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00:00
Scott Rifenbark
c2f7ed472c Poky Reference Manual: Removed the bsp.xml file.
Because I am single-sourcing the bsp.xml file that is used both as
chapter 4 in the Poky Reference Manual and as the singe file in the BSP
Guide I removed the bsp.xml file that was local to the poky-ref-manual
folder.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00:00
Scott Rifenbark
b1f69283b3 BSP Guide and BSP Chapter in Poky Reference Manual: Changed wording
I created wording in the second paragraph of this file so that it can
fit both the context of the BSP Guide and the BSP chapter of the
Poky Reference Manual.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00:00
Scott Rifenbark
2cf5aafc28 Poky Reference Manual: Changed source location of the bsp.xml file
Because BSP chapter (bsp.xml) is identical to the single file used
in the BSP Guide (also bsp.xml but in the bsp-guide folder) I have decided
to change where the Poky Reference Manual get the bsp.xml file.  This commit
causes it to get the file from the bsp-guide folder instead of an identical
but separate bsp.xml file local to the poky-ref-manual folder.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00:00
Scott Rifenbark
4e6a8212c0 Poky Reference Manual: Fixed list tag.
There was a mis-matched list element in an ordered list near the end
of the chapter.  I had an <orderedlist> tag matched with an </itemizedlist>
tag preventing the make.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00:00
Scott Rifenbark
f30a2a7e4d BSP Guide: Fixed tag mis-match.
There was a errant tag mis-match where I had used <orderedlist> and
ended it with </itemizedlist>.  This was preventing the make.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00:00
Scott Rifenbark
2d6441d17e BSP Guide and BSP Chapter: Sync'ed these two files
After moving BSP Guide into its own folder for documentation I discovered
a consequence of that.  There are two separate bsp.xml files now:  one
in the poky-ref-manual folder and one in the bsp folder.  I had done some
good cleanup work in the version in the poky-ref-manual folder.  This
commit reflects a 'meld' operation where I re-sync'ed the bsp.xml
file in the bsp-guide folder to be the same (almost) as the one in the
poky-ref-manual folder.  There is still one slight difference between the
two files due to one's context as a stand-alone manual and the other as
a section in a larger book.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00:00
Scott Rifenbark
89e64dbe9e Poky Reference Manual: Added XSL Customization layer file
The xsltproc command in the Makefile now uses the XSL Customization
layer style sheet poky-ref-manual-customization.xsl for the style
sheet parameter.  This method will allow for customization of the
HTML version formatting that might be unique for the manual. I have
added the new file to the file structure.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00:00