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 a new FAQ entry per Richard Purdie answering the question
'How do I use an external toolchain?'
(From yocto-docs rev: 58b78df0d78637234cbcb0e70e225b72ba0f9a2b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the section 2.1.1 BitBake I added a paragraph at the end of the discussion
about BitBake explaining the benefits of the '-k' and '--continue' options.
(From yocto-docs rev: 409e01cedbe8d93c29856fa2a49d5f9db91f5201)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a new entry for we do not support spaces in filenames.
This entry was suggested by Richard.
(From yocto-docs rev: 27d7f951056fb55bddcd7a71374359583c635073)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the hello_2.2.bb example to hello_2.3.bb
(From yocto-docs rev: b1d07533b82a37aa5e52ebdbb3e9629e2b8ba549)
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#_807 - I updated the description of the BBFILE_PRIORITY variable
to provide more detail. Input from Tom Zanussi on this fix.
(From yocto-docs rev: 90f9fd0c3bcf5c772423fa53f1f00579eba1bdeb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The directory screenshots is no longer used in this manual. Previously,
only one file (ss-sato.png) was used and I have moved it to the
figures folder.
(From yocto-docs rev: 1c75a62b33910ff951601dedd32b79bebb41090c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I have removed the multi-colored POKY image that was used for
the title of the Poky Handbook. The image I put in here is in
line with the other graphics used as titles for our Yocto Project
documentation. To accomplish this I had to create and add a new
PNG file named poky-title.png. I placed this image in the figures
folder. I removed the poky-ref-manual.png file (old figure).
I also had to alter the Makefile to use the new figure as part of the
tarball. Finally, I had to alter the HTML style sheet (style.css)
to include the new file.
(From yocto-docs rev: 6c44fca054c1c105daea6fa42f89a7f78a6d12cd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I moved this file from the screenshots directory to the figures
directory so that all figures would be in the figures directory.
(From yocto-docs rev: b61915e6cdf7dfedc4588cd59f252088a1069b65)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I removed two figures from the figures directory:
cropped-yocto-project-bw.png and yocto-project-transp.png.
Both figures are relics and not used in the manual. I also
altered the Makefile to pull the ss-sato.png file from the
figures directory instead of the screenshots directory. I moved
this PNG file from the screenshots directory to the figures
directory so that all figures would be in the figures directory.
Finally, I updated the introduction.xml file so that the html
code to include the ss-sato.png file pulls it from the figures
directory and not the screenshots directory.
(From yocto-docs rev: daa15c232d8c46d94cafd080e03318c733ec089f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
BUGID#_956: I updated the publish option so that the HTML and PDF
versions of the manual are automatically pushed to the Yocto Project
website. This fix takes care of BUGID#_956 for the Poky Reference Manual.
(From yocto-docs rev: aed87d15ce9df0835b704fda1e9d8f464d070e32)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed the remote publish URL used to push the HTML and PDF files to
the website.
(From yocto-docs rev: c5c170c582ca0a483aca13b7ddaa7f4d99a3aaf9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was a reference to the pokylinux.org home site. I commented this
item out so it does not show in the user documentation. I was unclear
on whether the reference should have been entirely removed from the manual
or not.
(From yocto-docs rev: 1cda8aab1336cc81648536e1f7d2777047673a64)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was a link whose URL was http://autobuilder.pokylinux.org:8010.
I changed the link to use yoctoproject.org. Note that this URL
was not visible to the reader in the manual. However, it was there
in the DocBook code.
(From yocto-docs rev: ca1cf9fb404f148fe4f0868630dc4f109231c5c3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
[BUGID#_1004] - The statement indicating to comment out EXTRA_IMAGE_FEATURE was
incorrectly shown as IMAGE_EXTRA_FEATURE. I corrected this.
(From yocto-docs rev: e18da2d4e4520a60045f869ca0c63a34c16e3e89)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I got rid of the <filename class='directory'...> and
<filename class='extension'...> and replaced with simple
<filename>/</filename> pairs.
(From OE-Core rev: 1bcdaf8d3d39680c154144227ee2caca9a7bb3e5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In section B.1 (Parsing) it said that BBFILES variable by default
specified the direcotyr 'meta/packages/' as the place to look for .bb
files. This directory is invalid and needed to be changed to
'meta/packages/'.
(From OE-Core rev: c48325b1f23201a1e7790bfd7c52191baf14878f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Due to some changes in the file structure for 1.0 there is a new directory
for the shared state. The variable SSTATE_DIR can be used to point to
the directory. I added this variable to the list of documented variables.
(From OE-Core rev: fe939d7181856145ea26c193be131883da182fcd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These edits reflect changes in the directory structure from the 0.9
version of the software to the 1.0 version. This set of changes still
is missing a few items. Changes were based on Saul Wold's input.
(From OE-Core rev: 6288e2af1b05d849e53b90071c66bc893ba015b6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed the various styles for commands and such and replaced with
simple <filename>/</filename> pairs.
(From OE-Core rev: c5a0cc3e6a2f1e7eb1a90c67d2a038d3dc18b1ba)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Section C.2 (Autotooled Packages) was re-written. I removed a bunch
of <variable> tags and replaced them with <filename>. Also removed
some Britishisms.
(From OE-Core rev: 7a932962fb8f0dbfe14eb2d3636ddbb1c974b947)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Had to fix the <variable> tag by replacing it with <filename>.
Previous commit didn't work so this is fixing it.
(From OE-Core rev: 263e572055b09ad2f432f1feda797813ef254e74)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I got rid of the <function> tag and replaced with <filename>. We
have too many styles.
(From OE-Core rev: 5ac97ba191c8707ff20105626427998df997d221)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Section B.4 (The Task List) had the typo "taksks". Changed to
"tasks."
(From OE-Core rev: 7cbd6bb020e16ceb1894a408852648a915f193f3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Section B.2 (Preferences and Providers) had a grammar error.
It said "An common example is..." I fixed it.
(From OE-Core rev: 6d04a9ff381b7771b6f080928d4416b76e76cbb0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I replaced varname style with filename style. Looks better. We have
too many styles.
(From OE-Core rev: 1b63d69c3c2e4b5561dc59d020b59d875420872f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Section A.1.1 (bitbake/) contained two URLs. One supposedly went to
a BitBake site and the other to the BitBake online manual. In reality,
they both went to the online manual. I removed the one referencing
the site.
(From OE-Core rev: 02c360c3e57409a3982db73ed2b998a7c58610a6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Section 5.3.2 (Using OProfileUI) was out of date. Several of the URLs
would not resolve. They were pointing to openedhand links that had
not been maintained. I updated the entire section.
(From OE-Core rev: 4678fcba5ab02669009d0ab67ec802f2ce1b087f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In section 5.2.2. (Building the Cross-GDB Package) there was a resulting
directory listed where you could find the binary. The directory had
a couple of variables for 'host-arch' and 'target-abi'. There was
a mis-guided angle bracket wrapping the 'host-arch' variable. This
was fixed.
(From OE-Core rev: a4fbf5caabb9ded34885612ae093759c82d7d2cb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I commented out a large section of the chapter, which went into detail
on how to locate, install, configure, and use the Yocto Ecliple
plug-in. This information is redundant in this book and is better
explained in the ADT Manual. I am referencing the information from
this chapter now.
(From OE-Core rev: f4f4efbf3f0b19fdb05ddf48ab48b4f42109a289)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the revision history table for the manual.
(From OE-Core rev: 65c7bb8489de654cc02dcff0dfff21754e2e5ce8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In chapter 2 where we talk about building images I added a new
note indicating that the user should not switch around using different
GPL versions when trying to rebuild an image as it can cause dependency
failures.
(From OE-Core rev: f84441dbcc8254062d55d2452d3d6f4bc6f907fe)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
[BUGID# 873] - Added a note in the Images Appendix indicating that
building an image without GPLv3 components is only supported for
base and minimal images. Also put the two changes you have to do
to the local.conf file for the build.
Added a note in the second chapter in the section on building images.
The note indicates the same as in the appendix but does not go into the
local.conf file detail.
(From OE-Core rev: c7960a2e820d7ddb8649ab0b27b3f04843f7af0d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This is an explanation on how to get by the proxy or around the
firewall when Poky is trying to find and download sources.
(From OE-Core rev: 426df8458bb37c81afc6fe03f0e1300985c8d059)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I changed the path 'meta/packages/formfactor/files/config'
to 'meta/recipes-bsp/formfactor/files/config' per Joshua Lock's
instruction for correctness.
(From OE-Core rev: b89ea64db2978f0ec9271565590a5a0529d396f1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Various small edits and format changes.
(From OE-Core rev: 259128eb1b7676a71d5c0df4ef5db065ba5c3c88)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I made some minor edits.
(From OE-Core rev: bb6fbb484ec912aabca77fd4d124c97fc7f956e1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added three FAQ entries per Joshual Lock.
1. How do I disable the cursor on my touchscreen device?
2. How do I make sure connected network interfaces are brought
up by default.
3. How do I create images with more free space?
(From OE-Core rev: 9cfed91ee7c0a619e52abc098c20d6ed8b69416b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Forgot to search for "Bitbake" occurances. These are now changed
to "BitBake."
(From OE-Core rev: 982826b61bf68244fad46ef52b5a203e648e330b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed a grammar problem and then did a search and replace for
"bitbake" to replace with "BitBake".
(From OE-Core rev: a25074cf7f3383ea3963c4dabb9507af34f2e3df)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I changed several occurances of "Yocto Project" to "the Yocto Project."
Also changed the statement about what Poky release the book supported.
It previously said "applies to Poky Release 4.0 (Laverne)." I changed
this to "applies to Poky Release 5.0 (Bernard)."
(From OE-Core rev: 021bc37ad0698c567f9b7089fde99fe985ae3551)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed a link to the Intel Website. Upon testing this link I
discovered that it loads the Intel site into the current web
page and then disables the back button. Rather annoying. I tried
to change the link to pop a new window but couldn't get the
ulink.target parameter to work. Ran out of time to try and figure
it out so I removed the link.
(From OE-Core rev: 8f75a06300714938e79800e0e140dd76ba42de86)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Performed a spell check and corrected several problems.
(From OE-Core rev: e26e9f41eac1bb34a7d9276921d14e843444622d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Beth Flanagan
Scott Rifenbark
Saul Wold
Richard Purdie