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>
Section 1.1 has the example filesystem layout. The last line of the
example filesystem layout had linux-wrs. It has been changed to
linux-yocto-stable.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
I added a reference to the specific section in the kernel documentation
that describes how to create a BSP Based on an existing similar
BSP. The tools we have that create the PDF manuals from the DocBook
XML do not support cross-referencing to another PDF manual. So, I was
left with adding a clunky text-based reference to the section and a link
to the docs page on the web-site.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
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>
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>
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 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>
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>
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>
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>
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>
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>
I created a new sub folder to hold the BSP Guide by itself so there are
three folders now for each of the Yocto manuals: BSP Guide, quick start
and poky ref manual. The new folder for the BSP guide is 'bsp-guide'.
It contains the bsp.xml file, its own Makefile, a bsp-guide.xml file,
and its own 'Figures' directory. The 'bsp-guide.xml' file that was
in the poky reference folder was deleted.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Scott Rifenbark
Paul Eggleton
Darren Hart