Added wording to indicate this directory as optional if the BSP had
special requirements for graphics support.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Found a mis-spelling that I corrected.
Also added wording to indicate this directory is optional.
Put in a note telling that defaults are set if a formfactor is
not found.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Added wording to be sure user knows to replace "bsp" and "_bsp" in the
boilerplate template example with the actual BSP name (i.e. <bsp_name>).
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
It makes more sense to have the sections that describe the various
parts of the common structure as sub-sections to that. That pulls
out the click-through licensing into a higher-level section.
This is better overall section organization.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
There are some sections now that don't correspond one-to-one with the
standard file structure presented in section 1.1. So I am commenting them
out for now. Since I am still in the process of iterating on this
manual I don't want to just delete the information.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Added some text in section 1.1 explaining that the file structure example
is an example and that the file structure of specific BSPs could differ.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Lowered the "E" for the "meta-emenlow" BSP.
Removed the "oaktrail" one, which is an Intel code name and replaced
it with "beagleboard", which is a non-Intel board.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Added information in the section about Pre-built User Binaries.
In the first paragraph I stated that this directory would contain
the Application Development Toolkit and minimal live images when the
BSP is "tarred" up and placed on the Yocto Project website.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Two lines had been earlier turned into a single sentence but the
capitalization of the second line still remained.
I switched "The" into "the".
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Inserted a note that states the BSP file structure shown is an example
only and that a given BSP could have different files.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Replaced meta-<bsp_name>/recipes-<bsp_name> with meta-<bsp_name>/recipes-bsp.
This conforms to how the BSP standard will be working.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
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>
1. Edited to incorporate new file system naming structure per Saul Wold. This
is the version I am sending him and Tom Z. to review.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Conflicts:
documentation/bsp-guide/bsp.xml
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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.
I needed more demarcation for these section titles. They were not visually
different enough.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
