Paul sent me a bunch of minor edits and technical corrections
for the ADT, BSP, Development, and YP reference manual.
Most changes were taken as he submitted them. However, some
formatting conventions were not followed in the commits he made
to yocto-docs/paule/docs2. After merging them to my yocto-docs/master
branch I fixed some issues.
(From yocto-docs rev: 93f4ea2dee976448f623953e801a80d59736450a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These documents do not have titles when showing up on the website; set
the title tag value so that they do.
(From yocto-docs rev: baf958e3f49317689275b14dd31c6141f36c8c65)
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a parallel textual construct at the beginning of each section
that details a directory in the Yocto Project file's structure.
I did not like starting these sections with a literallayout string.
(From yocto-docs rev: 5dde476f0c02d655217f3fa863522e8b7df57cda)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Note mentions possible differences between docs in the released
tarball and docs on the website. Suggests website for latest
docs.
(From yocto-docs rev: 1b729667498363a5bb451502975b0797796eea0b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
changed 'meta/recipes-kernel/kernel' to 'meta/recipes-kernel/linux'
as the location for existing YP kernels found in the repository.
(From yocto-docs rev: c8ce3a15429df5c980498ce217803cf5a59cbdc9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added an entry to represent the Yocto Project 1.0.1 Release into
the manual history table for all of the manuals except the Yocto
Project Quick Start, which does not have a table.
(From yocto-docs rev: d2c570b18854b3f15dfb20436a2212f569e96d5f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These changes fix the following issues:
1. Multiple Makefiles. There really is no need for this.
2. Unable to maintain more than one version of the docs on the webserver.
This is a quick fix to enable the above.
In order to build the documentation, at the top level, issue a:
make all DOC=<doc directory name>
make all DOC=kernel-manual
Also, some changes need to occur on the webserver to fully
incorporate these fixes.
http://www.yoctoproject.org/documentation/
The docs are now published to:
http://www.yoctoproject.org/docs/<Release MM.mm>/<doc name>
The main page should be changed to point not only to the current doc release,
but also to the prior releases. This will enable us to maintain prior release
documentation without stomping over it when we publish new docs. Also, we'll
need to repoint the yocto-quick-start link to yocto-project-qs. Or rename
documentation/yocto-project-qs/* to support the website naming.
(From yocto-docs rev: 2651790d80fd32cd4619eeb5375f6ee28e7e7fda)
Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added more explanation about the base directory (meta-<bsp_name>) to the
Example Filesystem Layout section. These changes were suggested by
Tom Zanussi to help users understand better how to add BSP layers
to the build system.
(From yocto-docs rev: ced445910363b2f10b5b5ca72236f54ae4b7e050)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the 'BSP Click-Through Licensing Procedure' section there was an
old link to the BSP download page on the Yocto Project website. The
link was non-functional. I fixed the link so that it points to the
Yocto Project BSP Download page. I also re-wrote the paragraph to
read better.
(From yocto-docs rev: b87714fa54f71aa061126b7f29d80723a90818e8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the '1.1.3 Pre-built User Binaries' section it said that the
ADT and minimal images were kept in the optional
meta-<bsp_name>/binary directory. Jianjun Xu pointed out that
in fact it is just the minimal and sato images here. I also
confirmed with Tom as well. I re-wrote this sentence to be
clearer and more accurate.
(From yocto-docs rev: 6757abff52841b5d1e1991ab22314fa7a243a87d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the '1.1.4 Layer Configuration File' section there was a BBFILES
statment that used the '\' character to indicate a continuation of the
command on the following line. However, the example did not use
a new line. I added the hard-return to correct that in the example.
(From yocto-docs rev: 185352ae2f5879a8418715053f3791b167bd6d7e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the example BSP name 'meta-intel_n450' to 'meta-n450' in
the section 'Example Filesystem Layout.' Error found by Jiajun Xu.
(From yocto-docs rev: 0dd6f97dcc51cec4bae96ca0430af9300619749f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I removed the hardcoded name from the publish option. This involved
updating the Makefiles. The publish option is still temporary as a
more permanent solution is being created.
(From yocto-docs rev: 6878b2ccdb98b18c438ca419e1caad0041a2bc00)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
BUGID#_956: I updated the Make file so that it will push the HTML and PDF files
automatically to the yocto project site. This takes care of
BUGID#_956 for the BSP Guide.
(From yocto-docs rev: 684f1836056c977c08a27a0a80d622e360977919)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed this figure as it is not used in the manual.
(From yocto-docs rev: 6fa2c18a7ea647386a113e0e50860d66ecb83e4a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added the URL for the manual to the rcp publishing process. This
is part of the fix for this bug.
(From yocto-docs rev: 4d25c5e1cd6f0b067d0a88fbde1ac6df7066dfa4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
For some reason the PDF version of this manual was not being included
in the tarball created by the Makefile. I fixed this.
(From OE-Core rev: f8ec09ab31c04b2ae9570b71174f50c58ad09f00)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Performed a spell check and caught a couple small things.
(From OE-Core rev: 17ae7d1e05df495a5e27168cdcdfbcf96337a3f9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the HTML style sheet to match that of the other online
manuals. Section heads are now in Yocto blue and tip box
color is inline with Yocto color schemes.
(From OE-Core rev: 815b71a6c66e529959a12bd9aa6aabc0afc78bb1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the revision table for the manuals to have better
wording and to go from oldest to newest top down.
(From OE-Core rev: 7a4f802bb4d12f863a13fc4ba095a3de149aa6df)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the figure for the title so that it uses the same color
scheme as the other manuals.
(From OE-Core rev: 23c40367c56e838bb9c1ad89cec8ca2e563a40a7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- use linux-yocto instead of linux-yocto-stable in examples
- change branch names to match linux-yocto usage
- remove outdated 'wrs' where it appears
(From OE-Core rev: 7f1662ef01b383c9fecb2b30ade50de97f17529a)
Signed-off-by: Tom Zanussi <tom.zanussi@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the revision history on the title page to reflect the upcoming
Release 1.0. I will likely have to change this as we get nearer the
release so I can be sure of the number and also add meaning release
remarks to the entry.
(From OE-Core rev: 5ba502311221c3a476465d148fcfecf557fbfe79)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the email address for Richard Purdie in the author title
page to richard.purdie@linuxfoundation.org.
(From OE-Core rev: 86e355f489437c4d20a717617d203a8a5aa1371a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
[BUGID# 695] - I updated the title to use a less bold and intrusive
font and one that is still common for systems. Also removed the
"s" in the title so it now reads "Board Support Package (BSP)
Developer's Guide." I also put a better looking Yocto logo in.
Once this commit is merged bug #695 can be marked resolved.
(From OE-Core rev: f6d9338bf98f2f6791231a5ff74142833ae1363e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
[BUGID# 553] - In the 'BSP Click-Through Licensing Procedure'
section, which is shared between the BSP Guide and the Poky
Reference Manual, there were three links to 'pokylinux.org'
sites. These links were intended to help a user get a license
for encumbered BSPs. However, the links never did work. The
section also had some wording that described a propsed naming
convention for BSP tarballs that were encumbered and non-encumbered.
The naming convention is a good idea but has not been followed
so far.
I removed the links and replaced them with general instructions
on how to get through the licensing situation. Also removed the
hard-line naming rules and replaces with a more general explanation
of how we are naming BSP (e.g. Crown Bay).
(From OE-Core rev: 4c2dcb376b4be0778cab97138fefdb8a27a0e708)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
Scott Rifenbark
Paul Eggleton
Beth Flanagan
Saul Wold
Richard Purdie
Tom Zanussi