summaryrefslogtreecommitdiff
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* documentation/adt-manual: New file structure for ADT ManualScott Rifenbark2011-03-1611-0/+1369
| | | | | | | | | | | | I have added a new directory to documentation named adt-manual. This directory holds a Figures folder, and the 9 files needed for the ADT manual. The book consists of five chapters: adt-intro, adt-prepare, adt-package, adt-eclipse, and adt-command. There is also a adt-manual.xml file called by the Makefile. There is also a style.css file. And finally, a adt-manual-customization.xsl file to control numbering. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation: Kernel Manual fixesTom Zanussi2011-03-141-59/+65
| | | | | | | | | 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] Signed-off-by: Tom Zanussi <tom.zanussi@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: BSP Developer's Guide fixesTom Zanussi2011-03-141-11/+11
| | | | | | | | - use linux-yocto instead of linux-yocto-stable in examples - change branch names to match linux-yocto usage - remove outdated 'wrs' where it appears Signed-off-by: Tom Zanussi <tom.zanussi@intel.com>
* documentation/kernel-manual: Kernel manual Style changesScott Rifenbark2011-03-043-16/+16
| | | | | | | | | | | | | | | | | 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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/kernel-manual/figures/kernel-title.png: Updated title graphicScott Rifenbark2011-03-041-0/+0
| | | | | | I changed the font to Arial Narrow and inserted a better logo. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp-guide.xml: Updated revision history on title page.Scott Rifenbark2011-03-021-1/+6
| | | | | | | | | 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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp-guide.xml: Updated RP email addressScott Rifenbark2011-03-021-1/+1
| | | | | | | Changed the email address for Richard Purdie in the author title page to richard.purdie@linuxfoundation.org. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* [BUGID# 695] - documentation/bsp-guide/figures/bsp-title.png: Updated title ↵Scott Rifenbark2011-03-021-0/+0
| | | | | | | | | | | | | graphic [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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* [BUGID# 553] - documentation/bsp-guide/bsp.xml: Re-write of click-throughScott Rifenbark2011-03-021-25/+34
| | | | | | | | | | | | | | | | | | | [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). Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* [BUGID# 553] - documentation/poky-ref-manual/resources.xml: Fixed pokylinux URLScott Rifenbark2011-03-021-1/+1
| | | | | | | | | | | [BUGID# 553] - In appendix I in the Contributions section (I.6) there is mention of a Poky contributions tree and the URL git://git.pokylinux.org/poky-contrib.git is given. I changed this URL to git://git.yoctoproject.org/poky-contrib.git. This is a partial fix for but 553. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/poky-ref-manual/resources.xml: Text addtions in Links section ↵Scott Rifenbark2011-03-021-3/+4
| | | | | | | | | in Appendix I I added text after the bulleted items "The Poky website" and "BitBake Uer Manual." These were blank and it was not consistent with the rest of the list. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* [BUGID# 553] - documentation/poky-ref-manual/resources.xml: Fixed pokylinux URLScott Rifenbark2011-03-021-2/+2
| | | | | | | | | | | | | [BUGID# 553] - In the "Bugtracker" section (appendix I - I.2) there is a reference to the bugtracker. The text shows just the string "bug tracker" but the hidden URL was http://bugzilla.pokylinux.org. I updated the text to say to report problems by using the Bugzilla application and then gave the URL http://bugzilla.yoctoproject.org as the reference. This is a partial fix for bug 553. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* [BUGID# 553] - documentation/poky-ref-manual/faq.xml: Fixed pokylinux.org ↵Scott Rifenbark2011-03-021-1/+2
| | | | | | | | | | | | | reference [BUGID# 553] - In the FAQ appendix item H.12 there was a reference to http://pokylinux.org/sources/* in the question portion. The reference should really be http://autobuilder.yoctoproject.org/sources/*. I made the change. This is a partial fix for bug 553. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* [BUGID# 553] - documentation/poky-ref-manual/development.xml: Fixed ↵Scott Rifenbark2011-03-021-4/+3
| | | | | | | | | | | | | | pokylinux.org URL [BUGID# 553] - In "The Anjuta Plug-in" section (5.1.2.2) there was an URL to the source for the Anjuta Plug-in. The URL had the pokylinux.org string in it and pointed to the old area. I changed the URL to http://git.yoctoproject.org and directed the user to look under IDE Plugins. This is a partial fix to bug 553. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* [BUGID# 553] - documentation/poky-ref-manual/development.xml: Fixed ↵Scott Rifenbark2011-03-021-2/+3
| | | | | | | | | | | | | | | | | | pokylinux URLs [BUGID# 553] - In "The Eclipse Plug-in" section (5.1.2.1) there were two URLs referencing the place to get the Eclipse plug-in. One specified the URL to put into the HTTP:// field in the Eclipse IDE when installing the software. This URL was incorrect. I replaced it with the correct URL, which was http://www.yoctoproject.org/downloads/eclipse-plugin/. The second URL that was fixed was referencing the source code for the plug-in. It had the old pokylinux.org string. I changed it to http://git.yoctoproject.org. These fixes partially address bug 553. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* [BUGID# 553] - documentation/poky-ref-manual/introduction.xml: fixed ↵Scott Rifenbark2011-03-021-1/+1
| | | | | | | | | | | pokylinux.org URL [BUGID# 553] - In the Development Checkouts section (1.5.3) there was a reference to our git repository located at git://git.pokylinux.org/poky.git. I changed this to git://git.yoctoproject.org/poky.git. This is a partial fix to Bug 553. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* [BUGID# 553] - documentation/poky-ref-manual/introduction.xml: Fixed ↵Scott Rifenbark2011-03-021-1/+1
| | | | | | | | | | | pokylinux.org URL [BUGID# 553] - In the Releases section (1.5.1) there was an URL to http://pokylinux.org/releases. This URL was old and I replaced it with http://yoctoproject.org/downloads/poky. This partially fixes bug 553. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/poky-ref-manual/introduction.xml: [BUGID# 553] - Fixed ↵Scott Rifenbark2011-03-021-1/+1
| | | | | | | | | | | | | | | pokylinux URL [BUGID# 553] - In the Development Checkouts section (1.5.3) there is a reference to http://git.pokylinux.org/. This URL resolves to an older looking source area. I determined that the URL http://git.yoctoproject.org/ resolves to the newer Yocto source web interface so I changed the URL to that. This is a partial fix to Bug 553. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/poky-ref-manual/introduction.xml: [BUGID# 553] - Fixed ↵Scott Rifenbark2011-03-021-1/+1
| | | | | | | | | | | | | pokylinux.org link in Nightly Build section [BUGID# 553] - In the nightly build section (1.5.2) there is a reference to http://autobuilder.pokylinux.org/. This URL resolves to an autobuilder page that has a bunch of pokylinux links. I determined that the URL http://autobuilder.yoctoproject.org/ also resolves to the autobuilder page so I updated the URL to use the YP link. This is a partial fix to Bug 553. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/poky-ref-manual/ref-images.xml: Update to Images AppendixScott Rifenbark2011-03-021-25/+34
| | | | | | | | | | Added command 'ls meta*/recipes*/images/*.bb' as the command to see the supported images. Also added poky-image-lsb as an image and noted that poky-image-sdk has becom poky-image-sato-dev. These fixes are in response to alpha testing for release 1.0 Yocto. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/yocto-project-qs/yocto-project-qs.xml: Added Copyright datesScott Rifenbark2011-03-011-0/+1
| | | | | | | | | | | | Added "Copyright 2010-2011 Linux Foundation" under the title. For now this will have to do. Once we get the converted website up I would like to see all manuals displayed as HTML files within the context of the site layout. At that point we can have a copyright and trademark stuff in a persistent footer. [BUGID #696] Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/kernel-manual/kernel-manual.xml: Updated copyright dateScott Rifenbark2011-03-011-1/+1
| | | | | | Changed the copyright date from "2010" to "2010-2011". Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp-guide.xml: Updated copyrightScott Rifenbark2011-03-011-1/+1
| | | | | | Changed copyright date from "2010" to "2010-2011" Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/poky-ref-manual/poky-ref-manual.xml: updated copyright dateScott Rifenbark2011-03-011-1/+1
| | | | | | Changed the copyright upper date from 2010 to 2011. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/poky-ref-manual/faq.xml: [BUGID# 628] - Added new question for ↵Scott Rifenbark2011-03-011-0/+41
| | | | | | | | | Python 2.6 requirement. As part of the fix for #628 I added a new question to the FAQ for use of Poky when you do not have Python 2.6. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/yocto-project-qs/yocto-project-qs.xml: [BUGID# 628] - Added ↵Scott Rifenbark2011-03-011-0/+6
| | | | | | | | | | | | note about Python 2.6 bitbake requirement Part of the fix for Bug 628 is to add a note that bitbake requires python 2.6. I added this note before the example bitbake command that builds an image. I also added a linked reference to the Poky Reference Manual and mentioned the FAQ appendix. There will be more information about the python requirement in the FAQ. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/kernel-manual/kernel-how-to.xml: Changes to section 3.4.4 and ↵Scott Rifenbark2011-02-181-0/+31
| | | | | | | | | | new 3.4.5 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>
* documentation/kernel-manual/kernel-how-to.xml: fix to step 3 and 4 of ↵Scott Rifenbark2011-02-181-1/+6
| | | | | | | | | | | | | section 3.4.4 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>
* documentation/kernel-manual/kernel-how-to.xml: Fix to step 3 of section 3.4.4Scott Rifenbark2011-02-181-1/+1
| | | | | | | | 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>
* documentation/kernel-manual/kernel-how-to.xml: Fix to step 1 of section 3.4.4Scott Rifenbark2011-02-181-1/+2
| | | | | | | | | | 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>
* documentation/kernel-manual/kernel-how-to.xml: More changes to the creating ↵Scott Rifenbark2011-02-141-12/+17
| | | | | | | | | BSP section. 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>
* documentation/kernel-manual/kernel-how-to.xml: Fixed typeScott Rifenbark2011-02-141-1/+1
| | | | | | | 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>
* documentation/kernel-manual/kernel-how-to.xml: - Condense and merge example ↵Scott Rifenbark2011-02-141-1/+1
| | | | | | | | | | changed. 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>
* documentation/kernel-manual/kernel-how-to.xml: [BUGID# 597] Reversing ↵Scott Rifenbark2011-02-141-6/+6
| | | | | | | | | | | common-pc-standard [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>
* documentation/yocto-project-qs/yocto-project-qs.xml: [BUGID# 631] - Added ↵Scott Rifenbark2011-02-141-0/+11
| | | | | | | | | | tip for saving disk space during a build. [BUGID# 631] - I added a tip in the section where we show a sample build. The tip says that you can add 'INHERIT += "rm_work"' to the local.conf file to help conserve disk space during a build. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/kernel-manual/kernel-how-to.xml: [BUGID# 597] Fixed common_pcScott Rifenbark2011-02-141-6/+6
| | | | | | [BUGID# 597] - Changed the string "common_pc" to "common-pc". Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/poky-ref-manual/extendpoky.xml: Fixed make problemScott Rifenbark2011-02-011-1/+1
| | | | | | | | Discovered that the manual was not making correctly due to a stray </literallayout> statement. I removed this statement and the manual now builds. Signed-off-by: Scott Rifenbark <scott@scott-desktop.(none)>
* documentation/yocto-project-qs/yocto-project-qs.xml: Added note to ↵Scott Rifenbark2011-01-251-2/+13
| | | | | | | | | | | poky-qemu command Depending on the architecture you are booting and the profile of the filesystem image QEMU might come up in a new shell, and existing shell, have a GUI, or be in command-line mode. I added a note indicating this behavior. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/yocto-project-qs/yocto-project-qs.xml: Updated <arch> value ↵Scott Rifenbark2011-01-251-23/+23
| | | | | | | | | for environment setup command The value for the 64-bit architecture was "x86-64" and not "x86_64". Changed it to be correct. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/yocto-project-qs/yocto-project-qs.xml: Updated list ↵Scott Rifenbark2011-01-251-2/+9
| | | | | | | | | | introducing pre-built section The section that introduces the using a pre-built binary section needed more items in the list. I added text for setting up the environment and for starting QEMU. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/yocto-project-qs/yocto-project-qs.xml: Added sub-sections to ↵Scott Rifenbark2011-01-251-15/+27
| | | | | | | | | | pre-built image section The pre-built image section was one long section that naturally broke into several areas. I inserted some sub-sections for better organization. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/yocto-project-qs/yocto-project-qs.xml: Corrected environment ↵Scott Rifenbark2011-01-251-2/+5
| | | | | | | | | | setup command I added the exact architecture strings for each of the five supported architectures as part of the /opt/poky/environment-setup.... commands resulting from installing the toolchain tarballs. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/yocto-project-qs/figures/using-a-pre-built-image.png: Updated ↵Scott Rifenbark2011-01-201-0/+0
| | | | | | | | figure Changed the figure so that "File System" is "Filesystem" Signed-off-by: Scott Rifenbark <scott@scott-desktop.(none)>
* documentation/yocto-project-qs/yocto-project-qs.xml: General edits to YP QS.Scott Rifenbark2011-01-201-54/+133
| | | | | | | Revised the manual for better grammar and more technically accurate wordings. Worked closely with Scott Garman on the revision. Signed-off-by: Scott Rifenbark <scott@scott-desktop.(none)>
* documentation/poky-ref-manual: expand discussion of PR and INC_PRPaul Eggleton2011-01-202-8/+17
| | | | | | Expands a little on PR and INC_PR. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
* documentation/bsp-guide/bsp.xml: fix typo in variable namePaul Eggleton2011-01-201-1/+1
| | | | | | FILESEXTRAPATH -> FILESEXTRAPATHS Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
* documentation/yocto-project-qs: Updated the Packages section.Scott Rifenbark2011-01-181-2/+3
| | | | | | | | | Added the packages autoconf and automake to both the Debeian-based host and the RPM-based host example commands. During a fresh development host system test run I found these packages were necessary to develop Yocto projects using Eclipse IDE. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/yocto-project-qs/yocto-project-qs.xml: Corrections to Using ↵Scott Rifenbark2011-01-061-4/+11
| | | | | | | | | | | | | Pre-Built Binaries and QEMU section. Made several small changes: - Added a period to three-bullet list for consistency - grammar fix to sentence - Added clarification for getting stuff from qemu URL - Fixed the forms for the image and the file system image Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Commented out three sections.Scott Rifenbark2011-01-061-1/+1
| | | | | | | | | 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>
* poky-ref-manual: Fix my email addressRichard Purdie2011-01-061-2/+2
| | | | Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3 (git 2.46.0) at 2024-11-08 23:12:52 +0000