summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* documentation/kernel-manual/Makefile: Added code to create a PDF version.Scott Rifenbark2010-12-101-4/+14
| | | | | | | | 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>
* documentation/kernel-manual/figures/kernel-title.png: Added a PNG file to ↵Scott Rifenbark2010-12-101-0/+0
| | | | | | display in the PDF version on the title page. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/kernel-manual/yocto-project-kernel-manual.xml: Added a new ↵Scott Rifenbark2010-12-101-9/+142
| | | | | | | | 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.
* documentation/kernel-manual/style.css: Changed h2 through h6 styles.Scott Rifenbark2010-12-101-9/+10
| | | | | | | I needed more demarcation for these section titles. They were not visually different enough. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/kernel-manual/yocto-project-kernel-manual.xml: Removed ↵Scott Rifenbark2010-12-101-47/+47
| | | | | | | | | 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>
* documentation/kernel-manual/yocto-project-kernel-manual.xml and ↵Scott Rifenbark2010-12-102-0/+2183
| | | | | | | | | 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>
* documentation/kernel-manual/yocto-project-kernal-manual.xml: and ↵Scott Rifenbark2010-12-102-2183/+0
| | | | | | | | | 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>
* documentation/kernel-manual/Makefile: fixed mis-spelling of kernel for filesScott Rifenbark2010-12-101-4/+4
| | | | Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/kerenl-manual: New directory and files for kernel manual.Scott Rifenbark2010-12-107-0/+3182
| | | | | | | | | | | | 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>
* documentation/yocto-project-qs/yocto-project-qs.xml: Corrected poky-qemu ↵Scott Rifenbark2010-12-101-1/+9
| | | | | | | | 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>
* documentation/poky-ref-manual/development.xml: Fixed orderedlist and ↵Scott Rifenbark2010-12-101-69/+69
| | | | | | itemizedlist spacing. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Poky Reference Manual: General edits to the developing chapter.Scott Rifenbark2010-12-101-245/+309
| | | | | | Completed the second half edits to this chapter. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Poky Reference Manual: Added INC_PR documentation.Scott Rifenbark2010-12-102-3/+27
| | | | | | | | 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>
* BSP Guide and BSP Chapter: Sync'ed these two filesScott Rifenbark2010-12-101-1/+1
| | | | | | | | | | | | | | 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>
* BSP Developers Guide: Edits to textScott Rifenbark2010-12-101-2/+2
| | | | | | | I made several spelling corrections and rewrote a sentence or two for better structure. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Poky Reference Manual: General edits up to the "Debugging with GDB ↵Scott Rifenbark2010-11-151-245/+274
| | | | | | Remotely" section. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Poky Reference Manual: Added a glossary definition for BBPATH.Scott Rifenbark2010-11-151-1/+6
| | | | Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Poky Reference Manual: Task wording made consistentScott Rifenbark2010-11-151-3/+3
| | | | | | | | 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>
* Poky Reference Manual: General edits for English.Scott Rifenbark2010-11-151-95/+95
| | | | Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Poky Reference Manual: Removed the bsp.xml file.Scott Rifenbark2010-11-151-469/+0
| | | | | | | | | 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>
* BSP Guide and BSP Chapter in Poky Reference Manual: Changed wordingScott Rifenbark2010-11-151-1/+2
| | | | | | | | 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>
* Poky Reference Manual: Changed source location of the bsp.xml fileScott Rifenbark2010-11-151-1/+1
| | | | | | | | | | 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>
* Poky Reference Manual: Fixed list tag.Scott Rifenbark2010-11-151-1/+1
| | | | | | | | 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>
* BSP Guide: Fixed tag mis-match.Scott Rifenbark2010-11-151-1/+1
| | | | | | | 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>
* BSP Guide and BSP Chapter: Sync'ed these two filesScott Rifenbark2010-11-152-195/+215
| | | | | | | | | | | | | | 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>
* Poky Reference Manual: Added XSL Customization layer fileScott Rifenbark2010-11-151-0/+6
| | | | | | | | | | 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>
* Poky Reference Manual: Added XSL Customization layer useScott Rifenbark2010-11-151-1/+1
| | | | | | | | | The xsltproc command 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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Poky Reference Manual: Clean up MakefileScott Rifenbark2010-11-151-5/+5
| | | | | | | | | I moved the XSLTOPTS variables to the top of the file so they will be defined first. This is an attempt to fix the seemingly random HTML runtime errors I am getting during the 'make html' command. It seems to be consistently working now. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Poky Reference Manual: Fixed broken link in Ref Images appendix.Scott Rifenbark2010-11-152-4/+4
| | | | | | | | In the Ref Images appendix there was a link to the section "External Development Using the Poky SDK" section that did not work due to the section id string changing. I fixed the link. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Poky Reference Manual: Added BBFILE_PRIORITY glossary term.Scott Rifenbark2010-11-151-0/+16
| | | | | | | The Extending Poky chapter referenced this non-existent term. I added it. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Poky Reference Manual: Added BBFILE_COLLECTIONS glossary term.Scott Rifenbark2010-11-151-0/+7
| | | | | | | The Extending Poky chapter was referencing a non-existent BBFILE_COLLECTIONS glossary term. I added the term. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Poky Reference Manual: Added BBLAYERS to glossary.Scott Rifenbark2010-11-151-0/+6
| | | | | | | | Added an entry for BBLAYERS in the ref-variables (glossary) appendix. The Extending Poky chapter was referencing this variable and it did not exist. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Poky Reference Manual: Spell check performed.Scott Rifenbark2010-11-151-15/+15
| | | | | | Found and corrected about 6 or 7 mis-spelled words. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Poky Reference Manual: Added consistency to literallayout text.Scott Rifenbark2010-11-151-19/+21
| | | | | | I added some indentation for better presentation of the literal text. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Poky Reference Manual: Cleaned up and checked all XML tags.Scott Rifenbark2010-11-151-8/+9
| | | | | | Just a few minor changes like creating consistent indentation. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Poky Reference Manual: XML tag clean up and command example text indentation.Scott Rifenbark2010-11-151-14/+17
| | | | | | | 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>
* Poky Reference Manual: A couple more minor fixes.Scott Rifenbark2010-11-151-3/+3
| | | | | | | I found another redundant </ulink> tag. I removed the word sections from within a section link in a couple of places. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Poky Reference Manual: Clean up of the XML tagsScott Rifenbark2010-11-151-4/+5
| | | | | | | Added a section id to the 'welcom to poky' section that was missing. Removed a redundant </ulink> tag that was not needed. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* BSP Guide: Updated xsltproc command to pass the bsp-guide-customization.xsl ↵Scott Rifenbark2010-11-151-1/+1
| | | | | | | | | | | | | | style sheet. Because I created the file 'bsp-guide-customization.xsl' to try and eliminate odd HTML runtime errors and to allow for customized XSL layer of formatting, it was necessary to update the Makefile to call the new file as the XSL style sheet. The Yocto Project Quickstart uses this technique and has no HTML build problems. HTML build errors seem to be eliminated so far. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* BSP Guide: I created a new figure for the title page.Scott Rifenbark2010-11-151-0/+0
| | | | | | | | Since the BSP Guide is under its own cover I thought it would be good to have its title page not have the Poky Handbook PNG image. I created this BSP image for use with the stand-alone BSP Guide. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* BSP Guide: Created new file for XSL customization expansion.Scott Rifenbark2010-11-151-0/+6
| | | | | | | | | | | I created the file 'bsp-guide-customization.xsl' to try and eliminate odd HTML runtime errors and to allow for customized XSL layer of formatting. The Yocto Project Quickstart uses this technique and has no HTML build problems. HTML build errors seem to be eliminated so far. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* BSP guide: Updated the book id.Scott Rifenbark2010-11-151-1/+1
| | | | | | | I updated the string used for the book id from 'poky-handbook' to 'bsp-guide' Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* BSP Guide Makefile: HTML generation debugging edits.Scott Rifenbark2010-11-151-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I am getting occasional errors while attempting to make the HTML version of this manual. The error is generated from line 367 of the html.xsl style sheet and seems to come from confusion of not finding the css style sheet parameter. Here is the error from the shell window. scottrif@scottrif-desktop:~/poky/documentation/bsp-guide$ make html xsltproc --stringparam html.stylesheet style.css --stringparam chapter.autolabel 1 --stringparam section.autolabel 1 --stringparam section.label.includes.component.label 1 --xinclude -o bsp-guide.html http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl bsp-guide.xml Note: namesp. cut : stripped namespace before processing WARNING: cannot add @xml:base to node set root element. Relative paths may not work. Note: namesp. cut : processing stripped document runtime error: file http://docbook.sourceforge.net/release/xsl/current/xhtml/html.xsl line 367 element choose Variable 'generate.css.header' has not been declared. make: *** [html] Error 10 The odd think is that running "make html" immediately again could cause the make to be entirely successful. So this commit involved moving the XSLTOPTS parameters to the top of the make file and the *_URI parameter declarations to the top as well. This takes them out of the "pdf" area of the make file and they should be more universal. The reason I tried this is because I have no such issues when building the yocto-project-qs HTML file. However, even with these changes the occasional runtime error (shown above) still occurs. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* BSP Developers Guide: Edits to textScott Rifenbark2010-11-151-25/+26
| | | | | | | I made several spelling corrections and rewrote a sentence or two for better structure. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Added a new PNG file into the tar command.Scott Rifenbark2010-11-151-3/+3
| | | | | | | | | | Since this manual is about BSP and not Poky as is the Poky Reference Manual I updated the title page to include the title combined with the Yocto Project logo. So for the background-image url in the .authorgroup style I replaced the poky-ref-manual.png file with bsp-title.png. Updates affect both the PDF and HTLM versions of the BSP Guide. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Added a new PNG file (bsp-title.png) as the imagedata tag.Scott Rifenbark2010-11-151-2/+2
| | | | | | | | | Since this manual is about BSP and not Poky as is the Poky Reference Manual I updated the title page to include the title combined with the Yocto Project logo. Updates affect both the PDF and HTLM versions of the BSP Guide. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Added a new PNG file into the tar command.Scott Rifenbark2010-11-151-1/+1
| | | | | | | | | Since this manual is about BSP and not Poky as is the Poky Reference Manual I updated the title page to include the title combined with the Yocto Project logo. Updates affect both the PDF and HTLM versions of the BSP Guide. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* poky-ref-manual: Drop non-commercial clauseRichard Purdie2010-11-131-1/+1
| | | | Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
* docmentation/poky-ref-manual: Remove unused Indexes titleRichard Purdie2010-11-041-2/+3
| | | | Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
* Performed general edits to this chapter.Scott Rifenbark2010-11-041-119/+127
| | | | | | many english corrections performed. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-17 18:32:28 +0000