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>
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>
I removed the figures/kernel-big-picture.png file as it is not used
in the manual. I also had to update the Makefile so that it would
not include this PNG file in the tarball.
(From yocto-docs rev: 461ab9525d16dbbdf5f5c56c16028cae911309b9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
BUGID#_956 - I updated the makefile so that the publish option automatically
pushes the HTML and PDF files to the Yocto Project website. This takes
care of BUGID#_956 for the Kernel Manual.
(From yocto-docs rev: d67a05f2256df63e182e43f8dd10ec7a54763762)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I removed this PNG file as the picture is not used in the manual.
(From yocto-docs rev: be06cb5854d66974606616c73c9574152bf80973)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed the URL used to publish the HTML and PDF docs to the
yoctoproject.org server and website.
(From yocto-docs rev: 887a007ae9203317e0bbb7e8b2c5be3843aae3dc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Performed a spell check and found a couple items.
(From OE-Core rev: 45039d008519c13f97d9b195bba4505b3865b5ea)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the title page to add Revision 1.0 to the Revision history
table.
(From OE-Core rev: 5062c0e09b5e2c4894ccfe322977fdd432b87e39)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Upgraded to reflect 1.0 usage rather than 0.90 usage, and some other
clarifications and minor changes.
[RP - added tweaks suggested by Darren Hart]
(From OE-Core rev: c6f06f478ac229c4619f815b8b313711d47b1551)
Signed-off-by: Tom Zanussi <tom.zanussi@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Modifications to the figure image (figures/kernel-title.png),
the heading styles (style.css), and the numbering system with
TOC display (yocto-project-kernel-manual-customization.xsl).
I updated the title image to display the manual title using
color #00557D, which coordinates with the Yocto Project website
color scheme. I also updated the style sheet to use this same
color for the section headings. This helps to set them off better
from the text. Finally, I flipped the switch back on for this
manual to create chapter-specific table of contents sections
prior to each chapter and to include a all-inclusive TOC at the
beginning of the book.
(From OE-Core rev: 2f24addbd02039fb9b6489c90c5d1c687c0d0698)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I changed the font to Arial Narrow and inserted a better logo.
(From OE-Core rev: 7b84f126b09125b306ea9f9b59c437bb741800d2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I made some updates to the 3.4.4 section according to Bruce Ashfield's
feedback. I also added a new section 3.4.5 (Creating a BSP Based on an
Existing Similar BSP Without a Local Kernel Repository).
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Added text after the sample bbappend file stating that the user needs
to update the KSRC assignment statement and also remove its comment.
Also they have to remove the comment from the SRC_URI line.
Changed the bitbake command in step 4 to use the linux-yocto-stable
file rather than the linux-yocto file.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Changed 'linux-yocto_git.bbappend' to 'linux-yocto-stable_git.bbappend'
in step 3 just before the code example. This makes the code consistent
with the rest of the example supporting the 2.6.34 kernel.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Step one states that the linux-yocto_git.bbappend file is left. This
file is associated with distro 2.6.37 kernel and the rest of the
example is associated with the 2.6.34 kernel. So, I changed the
step to indicate that the directory is left with a linux-yocto-stable_git.bbappend
file.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
These changes implemented Bruce Ashfield's next round of changes to the
section 4.3.3 example.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
In section 4.3.3 step 2 there was a directory 'build/donf/bblayers.conf'.
I fixed the typo to 'build/conf/bblayers.conf'.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
The example used to show how to condense and merge two BSPs into a second
SCM used a non-existant machine (cav_ebt5800-standard). I replaced this
machine with 'common_pc_64-standard, which is a real machine.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
[BUGID# 597] - After talking with Bruce Ashfield the kernel documentation
needs to support the 2.6.34 disribution. So, the 'common-pc-standard'
strings need to be changed back to 'common_pc-standard'. This fix restores
them.
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>
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>
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>
Beth Flanagan
Scott Rifenbark
Saul Wold
Richard Purdie
Tom Zanussi