Commit Graph

780 Commits

Author SHA1 Message Date
Scott Rifenbark
6e82f12f79 documentation/bsp-guide/bsp.xml: Updated common form for file structure.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-21 12:49:43 +00:00
Scott Rifenbark
91cf2634c7 documentation/bsp-guide/bsp.xml: Inserted text before the file structure example
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>
2010-12-21 12:49:43 +00:00
Scott Rifenbark
49ebf6b85c documentation/bsp-guide/bsp.xml: Created better BSP example base names
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>
2010-12-21 12:49:43 +00:00
Scott Rifenbark
e2b180ab54 documentation/bsp-guide/bsp.xml: Added information about /binary
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>
2010-12-21 12:49:43 +00:00
Scott Rifenbark
775b4aea12 documentation/bsp-guide/bsp.xml: Fixed typo
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>
2010-12-21 12:49:43 +00:00
Scott Rifenbark
5405b3de3e documentation/bsp-guide/bsp.xml: Added note qualifying BSP file structure.
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>
2010-12-21 12:49:43 +00:00
Scott Rifenbark
7e4b55b098 documentation/bsp-guide/bsp.xml: Changed meta naming convention
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>
2010-12-21 12:49:42 +00:00
Scott Rifenbark
eac0898c4e documentation/yocto-project-qs/yocto-project-qs.xml: Fixed grammar problem
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-12-20 14:43:56 +00:00
Scott Rifenbark
ba3b0db61f documentation/kernel-manual/figures/kernel-architecture-overview.png: updated figure
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>
2010-12-20 14:41:44 +00:00
Saul Wold
2c37d41ab1 Add glossary for PACKAGE_DESCRIPTION and PACKAGE_SUMMARY for binary packaging
Signed-off-by: Saul Wold <Saul.Wold@intel.com>
2010-12-16 15:52:50 +00:00
Scott Rifenbark
27c117141f documentation/bsp-guide/bsp.xml: General edits.
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>
2010-12-14 13:43:55 -08:00
Darren Hart
e7f5bc2504 bsp-guide: correct BBPATH example
The BBPATH example was missing a : to separate the path elements.

Signed-off-by: Darren Hart <dvhart@linux.intel.com>
2010-12-14 13:43:55 -08:00
Scott Rifenbark
ef8e0d6f38 documentation/kernel-manual/kernel-how-to.xml: added newline character
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>
2010-12-14 13:43:55 -08:00
Scott Rifenbark
22cd27dac4 documentation/kernel-manual/kernel-how-to.xml: fixed typo bug 588
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>
2010-12-14 13:43:54 -08:00
Scott Rifenbark
732a117c77 documentation/poky-ref-manual/ref-bitbake.xml: Completed general edits.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:29 -08:00
Scott Rifenbark
be622ae87e documentation/kernel-manual/kernel-concepts.xml: Re-worded a note to state best practices for organizing shared features.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:28 -08:00
Scott Rifenbark
579b5c2947 documentation/kernel-manual: Added Bruce Ashfields review comments.
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>
2010-12-10 22:01:27 -08:00
Scott Rifenbark
9f4c630dbd documentation/poky-ref-manual: changes applied from a patch submitted by Cyril Humbert.
Cyril submitted a patch via email form for several spelling corrections.  The master docs, however, are not up-to-date with what I have on my contrib area.  Many of Cyril's corrections were already addressed.  A few were not and I have updated them here with this commit.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:27 -08:00
Scott Rifenbark
111f0678ee documentation/poky-ref-manual: General edits up the Parsing section.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:26 -08:00
Scott Rifenbark
fcbacff683 documentation/poky-ref-manual: Changed spelling of bitbake to "BitBake" when used in text.
There is inconsistent use of how BitBake is spelled.  Sometimes it uses no capitalization, just a leading "B", or "BitBake".  I looked at the BitBake manual and it seems that "BitBake" is the correct way to refer to it.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:25 -08:00
Scott Rifenbark
252cecf379 documentation/poky-ref-manual: English scrub performed for consistency.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:25 -08:00
Scott Rifenbark
57d38a7e7a documentation/poky-ref-manual: Updated Mailing Lists and IRC sections in Appendix I
I pulled the openembedded mailing list information and provided information for yocto@yoctoproject.org, yocto-announce@yoctoproject.org, and poky@yoctoproject.org.  I also updated the IRC section to include both #poky and #yocto channels.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:24 -08:00
Scott Rifenbark
11cdfab9cd documentation/yocto-project-qs: Added the gnome-doc-utils package to the Fedora required pacakge list.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:24 -08:00
Scott Rifenbark
4fe7cb5b21 documentation/poky-ref-manual: Fixed two typo's
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:23 -08:00
Scott Rifenbark
2f4db319b0 documentation/poky-ref-manual: Fixed to mis-spellings
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:22 -08:00
Scott Rifenbark
6d46bc3fcf documentation/poky-ref-manual: Updated the list of links to include a link to the Yocto Project site.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:22 -08:00
Scott Rifenbark
23dcc1bf97 documentation/kernel-manual: Added an image to the authorgroup so a title would display in the HTML version of the manual.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:21 -08:00
Scott Rifenbark
ddbd172dd8 documentation/kernel-manual/kernel-how-to.xml: Completed scrub to the text.
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>
2010-12-10 22:01:20 -08:00
Scott Rifenbark
5bda926c80 documentation/kernel-manual/kerenel-how-to.xml: Edits to clean up text.
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>
2010-12-10 22:01:19 -08:00
Scott Rifenbark
1722898e16 documentation/kernel-manual/kernel-manual.xml: Changed the copyright statement to conform to sharing.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:19 -08:00
Scott Rifenbark
14a8edb09c documentation/kernel-manual/kernel-concepts.xml: Updated the text so that the conceptual figure showing the kernel is out.
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>
2010-12-10 22:01:18 -08:00
Scott Rifenbark
15cf572f3e documentation/kernel-manual: Modified to call new chapter structure.
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>
2010-12-10 22:01:17 -08:00
Scott Rifenbark
2a993a0dac documentation/kernel-manual: Added these files so the book could have chapters.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:17 -08:00
Scott Rifenbark
d2e540116f documentation/kernel-manual/yocto-project-kernel-manual.xml: Removed this file so manual could be structured into a book with chapters.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:16 -08:00
Scott Rifenbark
c272830d8c documentation/poky-ref-manual/poky-ref-manual.xml: Changed the revision date to 24 November 2010
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:16 -08:00
Scott Rifenbark
62ef8bdc57 documentation/kernel-manual/Makefile: changed the pdf, tgz, and html output files to be named "kernel-manual"
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:15 -08:00
Scott Rifenbark
05c8e137e4 documentation/kernel-manual/Makefile: changed the name of the PDF output file to "kernel-manual.pdf"
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:14 -08:00
Scott Rifenbark
c479301fca documentation/kernel-manual/kernel-manual.xml: added this file so that PDF could be built.
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>
2010-12-10 22:01:14 -08:00
Scott Rifenbark
d468cc4e49 documentation/kernel-manual/yocto-project-kernel-manual.xml: removed the code that inserts the image.
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>
2010-12-10 22:01:13 -08:00
Scott Rifenbark
5ed39a3770 documentation/kernel-manual/Makefile: Added code to create a PDF version.
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>
2010-12-10 22:01:13 -08:00
Scott Rifenbark
5d64bb0193 documentation/kernel-manual/figures/kernel-title.png: Added a PNG file to display in the PDF version on the title page.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:12 -08:00
Scott Rifenbark
b89a971761 documentation/kernel-manual/yocto-project-kernel-manual.xml: Added a new section called "BSP: Creating:
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.
2010-12-10 22:01:12 -08:00
Scott Rifenbark
7dbdd91eb9 documentation/kernel-manual/style.css: Changed h2 through h6 styles.
I needed more demarcation for these section titles.  They were not visually
different enough.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:11 -08:00
Scott Rifenbark
5b10a72004 documentation/kernel-manual/yocto-project-kernel-manual.xml: Removed sections not fit for 0.9 release.
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>
2010-12-10 22:01:10 -08:00
Scott Rifenbark
2982e7c405 documentation/kernel-manual/yocto-project-kernel-manual.xml and yocto-project-kernel-manual-customization.xsl: Renamed files with correct spelling for kernel.
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>
2010-12-10 22:01:09 -08:00
Scott Rifenbark
bad46abb89 documentation/kernel-manual/yocto-project-kernal-manual.xml: and yocto-project-kernal-manual-customization.xsl removed from tree.
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>
2010-12-10 22:01:09 -08:00
Scott Rifenbark
3e7a8a64af documentation/kernel-manual/Makefile: fixed mis-spelling of kernel for files
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:08 -08:00
Scott Rifenbark
000f052765 documentation/kerenl-manual: New directory and files for kernel manual.
This is the first draft of the Yocto Project Kernel manual.  The
manual consists of two sections: concepts and a practical section that
has examples.  It is based of Bruce Ashfield's kernel theory paper.
This first draft has been re-written and organized through the
concepts section.  The remainder was just placed in as-is due to
time constraints for getting some kernel documentation up on the website.
The manual still needs scrubbing and organization in the latter half.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:07 -08:00
Scott Rifenbark
aa58345393 documentation/yocto-project-qs/yocto-project-qs.xml: Corrected poky-qemu command example in the 'Using Pre-Build Binaries and QEMU' section.
Added fstype to the command form and also inserted an example use.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:07 -08:00
Scott Rifenbark
eccaafa620 documentation/poky-ref-manual/development.xml: Fixed orderedlist and itemizedlist spacing.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:06 -08:00