Commit Graph

29 Commits

Author SHA1 Message Date
Scott Rifenbark b97cdc1c8c documentation/dev-manual: Reference link clean-up
I made another pass through the document and cleaned up some
mistakes and also removed redundant links to manuals where I had
already provided a link to the specific section.

(From yocto-docs rev: 5da8ffe100127f5fe4bfd2b478f177d6bef3a968)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:51 -08:00
Scott Rifenbark 4d09a3c211 documentation/dev-manual/dev-manual-bsp-appendix.xml: Edits to examples
Updated the tarball and Git repo example in section where user
is getting the source files.  I was not using the default
Yocto Project Files top-level name for the tarball method.

Reported-by: Joshua.lock <joshua.lock@intel.com>
(From yocto-docs rev: 770c6799ea58df3d81df8f466f1bb9878532a995)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:50 -08:00
Scott Rifenbark 11c290c3cf documentation/dev-manual/dev-manual-bsp-appendix.xml: tags/branches edits
Edits to the section describing how to set up the YP files before the
BSP example.  I am working with Joshua Lock on these to settle them
down.  The edits are trying to establish understanding between a
Git repository and a tarball... just what the user has a hold of
after getting the files by either method.

Reported-by: Joshua Lock <joshua.lock@intel.com>
(From yocto-docs rev: ddb8333ea2f9898b7016ca01887e1acdc0581c06)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:49 -08:00
Scott Rifenbark 81629e3aa5 documentation/dev-manual/dev-manual-bsp-appendix.xml: edits to poky repo setup
There is confusion as to how to set up the Git repository and be
sure you have the snapshot of the release.  I have changed the
description to use a tag rather than the branch names.  The
stuff is out for review with Josh.

(From yocto-docs rev: 2521873e1bf8e1ad398fae4b7297f8746a34258f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:46 -08:00
Scott Rifenbark affc8b985a documentation: BB_NUMBER_THREADS and PARALLEL_MAKE suggestions
Text that suggests setting the BB_NUMBER_THREADS and
PARALLEL_MAKE variables to speed build time has been updated to
suggest a setting of twice the number of host cores supported.

The 2x number came to light through a discussion on the project
mailing list initiated by Robert P. J. Day.

Reported-by: Robert P. J. Day
(From yocto-docs rev: 1846b41a595b7bd905ca828eaa04112d1533d7a1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-25 15:24:19 +00:00
Scott Rifenbark 684c35b7aa documentation: Changed all manual links to point to "latest"
There are many references to YP documentation throughout the
YP manual set.  They used to have hard-coded links to the
current release (e.g. yoctoproject.org/docs/1.1 for Edison).
This created a situation where if you went to a document on
the website and clicked on a external reference to another
manual, you would redirect to the current manual on the website.
Really, you would want to go to the latest manual, which is
one that is under development.  Changing the links to
"yoctoproject.org/docs/latest" makes the tip of master, which
is used for devloping the next release, always have references
to the manuals being developed and not back to the stable
released set of manuals.

This "latest" and "current" scheme for the links is not perfect.
What has to happen when the latest set of the manuals freezes
and becomes the next stable release, all the links in the docs
will need to be changed from "latest" in the URL to the new
release number.  So for example, all the "latest" occurences
would need to be changed to "1.2".  Then for the next cycle
as development begins again, the links need to be infused with
"latest" again.

(From yocto-docs rev: a234aef34303b07671da956de0e94b352797143e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-25 15:24:17 +00:00
Scott Rifenbark 468c879a9c documentation/dev-manual/dev-manual-bsp-appendix.xml: Added footnote
Per Tom Zanussi's suggestion, we added a footnote to the paragraph
instructing the user on build problems for the example.  I don't
have clean fonts in the HTML version of the output.  I am still working
on figuring that out.

Reported by: Tom Zanussi
(From yocto-docs rev: 30fe7bd239292ed92f76fbc2f1fad62469f7fe9b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-08 16:26:32 +00:00
Scott Rifenbark e8f5b17e86 documentation/dev-manual/dev-manual-bsp-appendix.xml: Tom Zanussi edits.
Some wording changes to keep things accurate.  Also inserted some
"&nbsp" characters in some headings to force an extra space between
normal font and courier font words.  It appears the PDF version of
the generated manual shoves these words together with no intervening
space.  Looks like hell.

Reported by: Tom Zanussi
(From yocto-docs rev: 5dcb9ae99f1752599fd56a276ccafd79a52334f8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-08 16:26:32 +00:00
Scott Rifenbark e7b5027f54 documentation/dev-manual/dev-manual-bsp-appendix.xml: Robert P. J. Day edits
As Reported by:  Robert P. J. Day.

Two corrections identified by Robert.  One is a wrong reference to the
tarball needed for the example.  The other is a more complete description
of what the appendix is trying to accomplish.

(From yocto-docs rev: 387c6cbd84bafd7f15c064a8e801d0750b0b4007)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-08 16:26:31 +00:00
Scott Rifenbark ff644c92a5 documentation/dev-manual/dev-manual-bsp-appendix.xml: Added text to find t-ball
As Reported by Robert P. J. Day.

Robert indicated that it was a bit of a search to find the tarball
for the example.  Tom suggested that we have some text that helps
to locate the Crown Bay no-emgd tarball for edison.  I added some
clarifying text to help.

(From yocto-docs rev: d21120bbae81f58a9816cf56c61181d287afd295)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-08 16:26:31 +00:00
Tom Zanussi 6ff754f479 documentation/dev-manual/dev-manual-bsp-appendix.xml: BSP example scrub
As Reported by Robert P. J. Day.

Robert was working through this BSP example in the development manual
and ran into some problems and some confusion in areas.  This launched
a long "help-desk" session with Tom Zanussi.  In addressing Robert's
issues, Tom decided to make a run through of the example as it was
written.  For the most part the example was sound but needed some
technical tweaks as well as some expansion of the text to make things
clearer.  Tom submitted the patch that addressed these concerns.

Scott Rifenbark reviewed the patch and further modified some of the
writing to make it consistent with the existing writing in the manual.

(From yocto-docs rev: deda08b372c02889398d24ae7159f8b2fbe3c8cf)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-08 16:26:31 +00:00
Robert P. J. Day e64946e8c7 documentation/dev-manual/dev-manual-bsp-appendix.xml: Robert P. J. Day edits.
Two typos fixed.

(From yocto-docs rev: 6d99eb7f728b812be37a3865cbebd3c4cb4b67be)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-08 16:26:31 +00:00
Scott Rifenbark 42f6bc47c7 documentation/dev-manual/dev-manual-bsp-appendix.xml: changes to references
More changes to the internal section references.  Using <link> rather than
<xref> to get rid of the section number in the reference.

(From yocto-docs rev: 4351fd4898c517e25235611893b1cd059cbcc2f8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 23:12:06 +01:00
Scott Rifenbark addab8aa4c documenation/dev-manual/dev-manual-bsp-appendix.xml: fixed reference form
I am using a certain form to reference other sections in the current
or other manual.  I updated the references to follow this form.

(From yocto-docs rev: 2ba41ac2f355dbe66af19e356f9246b7485585b5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 23:12:06 +01:00
Scott Rifenbark 71cfe031c3 documentation/dev-manual/dev-manual-bsp-appendix.xml: fixed typo.
(From yocto-docs rev: a66bb0402dd3f1499278277486e482b573a97777)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 23:12:06 +01:00
Scott Rifenbark 8c10e06931 documentation/dev-manual/dev-manual-bsp-appendix.xml: scrubbed example
I changed several small things in the example as I worked through it
once again.  The commit IDs changed for using the atom-pc kernel.
Also the command to build the sato image can no longer use 'live'.

(From yocto-docs rev: faff1e7f21b5059dfe708c6a3d83116c7349fe55)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:46:44 +01:00
Scott Rifenbark 4884e38a6c documentation/dev-manual/dev-manual-bsp-appendix.xml: Fixed BBFILES_COLLECTIONS.
Jim Abernathy ran into an error in the BSP example.  The error had the
BBFILES_COLLECTIONS_mymachine in it (incorrect).  It needs to be
BBFILES_COLLECTIONS.

(From yocto-docs rev: 267a385aa5ab0eb46cf583db418cbbcab1e8b89b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-02 23:38:50 +01:00
Scott Rifenbark ca9366edf2 documentation/dev-manual/dev-manual-bsp-appendix.xml: Corrected the SRCREV statement
Comment from Bruce Ashfield indicated that this statement needed to be
SRCREV_meta_pn-linux-yocto_mymachine ?= \
        "84f1a422d7e21fbc23a687035bdf9d42471f19e0"

(From yocto-docs rev: 917bfca1af7f82ad330854849e0ec4f30289543a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-20 17:51:59 -07:00
Scott Rifenbark e04e02cd46 documentation/dev-manual: Changed 2.6.37 to 3.0 for 1.1 release.
Bruce Ashfield's review comments indicated that we will be using
linux-yocto-3.0 and not linux-yocto-2.6.37.  So I am putting these
changes in to anticipate the 1.1 release.

(From yocto-docs rev: ecbe1c90c5aa65b2dde77ba6094b5956e37d061d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-15 15:27:03 +01:00
Scott Rifenbark ae7a214522 documentation/dev-manual/dev-manual-bsp-appendix.xml: changed file name
I changed 'linux-yocto-2.6.37.bbappend' to 'linux-yocto_2.6.37.

(From yocto-docs rev: 0eb284374ef9dfb26142ae4d0254a0fe4056d0ab)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-15 15:27:01 +01:00
Scott Rifenbark 07544deddc documentation/dev-manual/dev-manual-bsp-appendix.xml: better link added.
In the section that describes how to get the local Yocto Project files
I was referencing the general section.  I have added a more specific link
to the bulleted item that describes how to get these files.

(From yocto-docs rev: 2b03c4d39a83d731581a6cd63a5c9e5c7e4cb57b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-15 15:26:58 +01:00
Scott Rifenbark ea7d4cbd57 documentation/dev-manual: replaced "&dash;" with "-".
Character does not display in PDF version.

(From yocto-docs rev: 8f9b114190257cfe5425f6e322dcfb6f03941bf8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:07:50 +01:00
Scott Rifenbark ebf0399891 documentation/dev-manual: Added reference to example appendices
In dev-manual-model.xml I included two references:  one to the
BSP Development Example and one to the Kernel Modification Example.
I had to add the target "id" stuff to both dev-manual-bsp-appendix.xml
and dev-manual-model.xml

(From yocto-docs rev: bcae1e723610e1769f0a524e3c1d9918c7cb1061)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:06:49 +01:00
Scott Rifenbark fd02be8686 documentation/dev-manual/dev-manual-bsp-appendix.xml: removed redundancies
Some of the more general BSP development information was more appropriate
in the dev-manual-cases chapter.  I removed this information and left
example-specific (mostly) text.

(From yocto-docs rev: d44c0fa8bdea9a2cad51ae3ca4b861a12d9fcdf9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:06:47 +01:00
Scott Rifenbark b67922f0c3 documentation/dev-manual/dev-manual-bsp-appendix.xml: Added section hierarchy.
The section for changing the recipes was deep and complex.  So I broke
it into several sub-sections.

(From yocto-docs rev: f964b7644502fe5995c57de4a7a4fff47f71cf79)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:06:46 +01:00
Scott Rifenbark 0dbc9ba611 documentation/dev-manual/dev-manual-bsp-appendix.xml: re-wrote the Base BSP
I re-wrote the Getting your Base BSP section to reflect the example only.
Previously, there was a lot of information in there about getting BSP
files that was deemed universal and was moved to the getting started
chapter.

(From yocto-docs rev: addcbca37e3dfad27b388245a4085cd0a2747177)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:06:46 +01:00
Scott Rifenbark 60eb60cd08 documentation/dev-manual/dev-manual-bsp-appendix.xml: Modified the setup section.
(From yocto-docs rev: 78224ffa3cfd5e110a2d2e43e8c84b259a84ee63)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:06:45 +01:00
Scott Rifenbark 24cbfd4926 documentation/dev-manual/dev-manual-bsp-appendix.xml: spacing fixed
Fixed the spacing to follow my indentation scheme for Docbook files.

(From yocto-docs rev: 6ed8cbc7dc48e5a380d27ee280fb92809b931223)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:06:45 +01:00
Scott Rifenbark 313f932aaa documentation/dev-manual/dev-manual-bsp-appendix.xml: New appendix for BSP
I decided to take the long detailed example of the BSP creation and
make it an appendix.  This commit represents a simple copy of the existing
dev-manual-cases chapter.  Further commits will change the text to
make it suitable as an appendix.

(From yocto-docs rev: 8c1308c4361f48ce7f7aa104cde7e6f6a820faa4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:06:44 +01:00