summaryrefslogtreecommitdiff
path: root/documentation
AgeCommit message (Collapse)AuthorFiles
2010-12-10documentation/kernel-manual/kernel-concepts.xml: Re-worded a note to state ↵Scott Rifenbark1
best practices for organizing shared features. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10documentation/kernel-manual: Added Bruce Ashfields review comments.Scott Rifenbark3
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-10documentation/poky-ref-manual: changes applied from a patch submitted by ↵Scott Rifenbark4
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-10documentation/poky-ref-manual: General edits up the Parsing section.Scott Rifenbark1
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10documentation/poky-ref-manual: Changed spelling of bitbake to "BitBake" when ↵Scott Rifenbark1
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-10documentation/poky-ref-manual: English scrub performed for consistency.Scott Rifenbark1
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10documentation/poky-ref-manual: Updated Mailing Lists and IRC sections in ↵Scott Rifenbark1
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-10documentation/yocto-project-qs: Added the gnome-doc-utils package to the ↵Scott Rifenbark1
Fedora required pacakge list. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10documentation/poky-ref-manual: Fixed two typo'sScott Rifenbark1
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10documentation/poky-ref-manual: Fixed to mis-spellingsScott Rifenbark1
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10documentation/poky-ref-manual: Updated the list of links to include a link ↵Scott Rifenbark1
to the Yocto Project site. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10documentation/kernel-manual: Added an image to the authorgroup so a title ↵Scott Rifenbark1
would display in the HTML version of the manual. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10documentation/kernel-manual/kernel-how-to.xml: Completed scrub to the text.Scott Rifenbark1
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-10documentation/kernel-manual/kerenel-how-to.xml: Edits to clean up text.Scott Rifenbark1
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-10documentation/kernel-manual/kernel-manual.xml: Changed the copyright ↵Scott Rifenbark1
statement to conform to sharing. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10documentation/kernel-manual/kernel-concepts.xml: Updated the text so that ↵Scott Rifenbark1
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-10documentation/kernel-manual: Modified to call new chapter structure.Scott Rifenbark1
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-10documentation/kernel-manual: Added these files so the book could have chapters.Scott Rifenbark3
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10documentation/kernel-manual/yocto-project-kernel-manual.xml: Removed this ↵Scott Rifenbark1
file so manual could be structured into a book with chapters. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10documentation/poky-ref-manual/poky-ref-manual.xml: Changed the revision ↵Scott Rifenbark1
date to 24 November 2010 Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10documentation/kernel-manual/Makefile: changed the pdf, tgz, and html output ↵Scott Rifenbark1
files to be named "kernel-manual" Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10documentation/kernel-manual/Makefile: changed the name of the PDF output ↵Scott Rifenbark1
file to "kernel-manual.pdf" Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10documentation/kernel-manual/kernel-manual.xml: added this file so that PDF ↵Scott Rifenbark1
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-10documentation/kernel-manual/yocto-project-kernel-manual.xml: removed the ↵Scott Rifenbark1
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-10documentation/kernel-manual/Makefile: Added code to create a PDF version.Scott Rifenbark1
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-10documentation/kernel-manual/figures/kernel-title.png: Added a PNG file to ↵Scott Rifenbark1
display in the PDF version on the title page. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10documentation/kernel-manual/yocto-project-kernel-manual.xml: Added a new ↵Scott Rifenbark1
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-10documentation/kernel-manual/style.css: Changed h2 through h6 styles.Scott Rifenbark1
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-10documentation/kernel-manual/yocto-project-kernel-manual.xml: Removed ↵Scott Rifenbark1
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-10documentation/kernel-manual/yocto-project-kernel-manual.xml and ↵Scott Rifenbark2
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-10documentation/kernel-manual/yocto-project-kernal-manual.xml: and ↵Scott Rifenbark2
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-10documentation/kernel-manual/Makefile: fixed mis-spelling of kernel for filesScott Rifenbark1
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10documentation/kerenl-manual: New directory and files for kernel manual.Scott Rifenbark7
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-10documentation/yocto-project-qs/yocto-project-qs.xml: Corrected poky-qemu ↵Scott Rifenbark1
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-10documentation/poky-ref-manual/development.xml: Fixed orderedlist and ↵Scott Rifenbark1
itemizedlist spacing. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10Poky Reference Manual: General edits to the developing chapter.Scott Rifenbark1
Completed the second half edits to this chapter. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10Poky Reference Manual: Added INC_PR documentation.Scott Rifenbark2
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-10BSP Guide and BSP Chapter: Sync'ed these two filesScott Rifenbark1
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-10BSP Developers Guide: Edits to textScott Rifenbark1
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-11-15Poky Reference Manual: General edits up to the "Debugging with GDB ↵Scott Rifenbark1
Remotely" section. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15Poky Reference Manual: Added a glossary definition for BBPATH.Scott Rifenbark1
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15Poky Reference Manual: Task wording made consistentScott Rifenbark1
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-15Poky Reference Manual: General edits for English.Scott Rifenbark1
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15Poky Reference Manual: Removed the bsp.xml file.Scott Rifenbark1
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-15BSP Guide and BSP Chapter in Poky Reference Manual: Changed wordingScott Rifenbark1
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-15Poky Reference Manual: Changed source location of the bsp.xml fileScott Rifenbark1
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-15Poky Reference Manual: Fixed list tag.Scott Rifenbark1
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-15BSP Guide: Fixed tag mis-match.Scott Rifenbark1
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-15BSP Guide and BSP Chapter: Sync'ed these two filesScott Rifenbark2
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-15Poky Reference Manual: Added XSL Customization layer fileScott Rifenbark1
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>