aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/adt-manual
AgeCommit message (Collapse)Author
2012-12-11documentation: adt-manual - Removed all trailing whitespace.Scott Rifenbark
(From yocto-docs rev: c1c271c0404dff9ed49597a4582a56def8237dd7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-03documentation: adt-manual - Fixed autotools command-line example.Scott Rifenbark
Re-ran this using Danny and the configure.in command does not need a AC_CONFIG_HEADERS statement so I removed it. Also fixed a typo for the touch command s/ChangeLog/ChangLog (From yocto-docs rev: 51aab0d5af1067f4144dacd3e53964aa6e00c2b0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-03documentation: adt-manual - Fixed configure command syntaxScott Rifenbark
The example configure command did not have the correct shell syntax. I changed it to "./configure". (From yocto-docs rev: a14ab06b78248cbf7caead26ee27a9d23e75d2ef) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-03documentation: adt-manual - autotools-based projectsScott Rifenbark
Fixes [YOCTO #2645] In the section that describes how to build a toolchain using bitbake meta-toolchain, I updated the note about the MACHINE and SDKMACHINE variables. These needed to be pointed out to the user as important variables for correct settings before generating the toolchain. I added a new section for the autotools-based programs that now includes a simple "Hello World" example. This section precedes the section that describes how to pass host options to configure.sh. (From yocto-docs rev: 9849e7b94d42a851f30f0fba8ae60916697956dd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-03documentation: adt-manual - Added information for required packagesScott Rifenbark
The note alerting the user to required host development packages necessary for ADT installation and use was antiquated and did not point to the new structure, which is in the YP Reference Manual. I updated the information. (From yocto-docs rev: edced821838391315fb2f12488cffec9f08eb78c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-03documentation: prepare for 1.4Scott Rifenbark
Made changes to the poky.ent file to change the three variables needed to build manuals for 1.4. Made new entries in the manual revision history tables for the five manuals that have them. Each entry shows the "TBD" release coming up. (From yocto-docs rev: f7f75a238d709698f1582ce22e209c09ee60581b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-23documentation: adt-manual - final edits before 1.3 lockdown.Scott Rifenbark
Made some minor edits to the book before locking down the files for 1.3. (From yocto-docs rev: 2b941103585a31b5dbcb65b784cc3381467ed697) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-17documentation: Release date updated.Scott Rifenbark
Updated the release month in all the manual revision history tables to say "October 2012" from "Sometime in 2012". (From yocto-docs rev: 1fc9313fe6c69db3d8cece6d940f78a2f0dc8386) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-28documentation: adt-manual, yocto-project-qs - Added tarball installer infoScott Rifenbark
Turns out the .sh file that installs the tarball comes down without executable permissions. I added a sentence in each manual instructing the user to set the permissions to the script before attempting to run it. (From yocto-docs rev: c1699971b3e03893aa1af5033e19d8f5c0b21ff4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-28documentation: adt-manual - updates to adt_installer location choiceScott Rifenbark
Fixes [YOCTO_#2930] You can now select the install location directory instead of automatically going to /opt/poky. Some small edits to the section that describes what happens when you fire off the adt_installer script. (From yocto-docs rev: 57f34c9b3a82222ed0ffc99e998614884b9a3486) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-28documentation: adt-manual - Added dev package informationScott Rifenbark
Added a new paragraph to the section that talks about getting images to state that if the user is not using or building a core-image-*-dev type image and they want to develop against their image, they need to be sure to include the development packages in their image recipe. Reporte-by: Jessica Zhang <jessica.zhang@intel.com> (From yocto-docs rev: 8da6f6172d3ad27c1cf6d52fd3d029d75ec9d0fd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-24documentation/adt-manual/adt-prepare.xml: replaced oe-init-build-envScott Rifenbark
Replaced with the variable OE_INIT_FILE. (From yocto-docs rev: 1deaa02f29b2a4b9cc7ff3307c8a3ebd0dfb9623) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-14documentation: Toolchain corrections from tarball to .sh fileScott Rifenbark
For 1.3 there is not longer a toolchain tarball. Instead, there is a wrapper script that lets you install the tarball. This fundamental usage model change caused several ripples throughout the documentation set. I have changed wordings and examples to reflect the new paradigm. (From yocto-docs rev: afb2069daa91e04c0f78ba425a6b184cb820d888) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-14documentation/adt-manual/adt-prepare.xml: Notes about installing sysrootScott Rifenbark
I added a couple of reminders and some links to information about separately extracting and installing the sysroot filesystem. (From yocto-docs rev: d340dcb5021fe1dcdaae0830ef8624c0fc54bedf) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-14documentation/adt-manual/adt-prepare.xml: updated ADT Installer exampleScott Rifenbark
Added text indicating that the user is prompted to verify the cross-toolchain installation location. (From yocto-docs rev: 3226eb2f0807687e8685702850a3a12b3d60ae5f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-14documentation/adt-manual/adt-prepare.xml: Update adt_install exampleScott Rifenbark
I added a command to the example that places the user in the adt-installer folder before they attempt to run scripts/adt_installer for completeness. (From yocto-docs rev: f098e1095d24d0271fb21f50aa848ebc05b828b1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation: Title changesScott Rifenbark
Removed "The" from all the titles of the books. This makes it easier to reference to them and easier for the automated processing of the mega-manual. (From yocto-docs rev: af566d6d007cff642648698ea487a6eeaa8cc930) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation: Fixes to note for mega-manual processingScott Rifenbark
the notes that say "Due to production processes..." at the start of each manual contain links to manuals. the links needed to be formatted such that the entire <ulink> code and manual name appeared on the same line so that the sed script can effectively remove the link in the resulting mega-manual. (From yocto-docs rev: 0a41971c331ad1961e6ee1e067b59c36c9f048f6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation: fixed Quick Start referencesScott Rifenbark
The way I refered to the YP Quick Start was inconsistant. I have made edits to remove these. (From yocto-docs rev: d9487c60db23861e8a9dd2c81ac46d4960abd462) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation: Style sheet naming changesScott Rifenbark
I had to rename individual style.css sheets to have book-specific names. So style.css for the ADT manual becomes adt-style.css and so forth. Turns out, this isn't really necessary for the solution to create the mega-manual but I am leaving the changes as a separate commit because it makes sense. It causes no disruption to making the six YP manuals. (From yocto-docs rev: 8cbdae1fe86988243f91dfd611c14f8a37007886) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation: tag change adt and kernel manualsScott Rifenbark
I changed a couple of id strings so that they are not duplicates. I did this to eliminate a make error while experimenting with creation of the single HTML YP document comprised of the individual docs. Changing the id strings has no consequence on the individual Application Developer's Guide and Kernel Manual. (From yocto-docs rev: 4e6832eca319a637be693dfe67ee56c540dfddfa) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-24documentation: Updated the h6 style to use a larger fontScott Rifenbark
(From yocto-docs rev: 5fa8d627fe671f0eb7bbc67ce852e2010cbd723f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-24documentation: Moved the Eclipse chapter to the YP Dev Manual.Scott Rifenbark
The detailed chapter that describes how to install and configure the Eclipse Yocto Plug-in has been moved to become a subsection of the "Workflow" chapter in the YP Development Manual. This commit accomplished the bulk move, edits to integrate the information, and fixes to all cross-references. Moving the chapter creates a sectioning issue in the YP Development manual that results in subsections that are six levels deep. Not ideal. Will look at fixing these with a subsequent commit. (From yocto-docs rev: e6abff8f578f2cf6997895260f607395281ae8e8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-18documentation/adt-manual/adt-package.xml: Edits to packaging chapterScott Rifenbark
Some minor edits to create some links to some terms used. (From yocto-docs rev: 1559b8caca07cce8630de9ddf8c84f0b24fa35e7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-18documentation/adt-manual/adt-prepare.xml: Edits affecting rename and clarityScott Rifenbark
I made a pass through this chapter and focused on better descriptions for getting the system ready for application development. I made adjustments to better represent what is really being done. It is not all ADT here as was being described before. Miscellaneous edits and improvements throughout. (From yocto-docs rev: 3544beda4794005fe139d7620fd13618fab05534) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-18documentation/adt-manual/adt-intro.xml: Edits to introduction chapterScott Rifenbark
I edited the text so that the purpose of the manual is clearer. I have segmented out the ADT into distinct components and made sure the overviews of each is good. Edits to clarify the role of the ADT as well. (From yocto-docs rev: c4abd8305dcdba986f1e761887c740e8322bb331) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-18documentation/adt-manual/adt-manual.xml: Title change for link.Scott Rifenbark
(From yocto-docs rev: 4b34f9e53230b792a7f57f2880177299286d057d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-18documentation/adt-manual/figures/adt-title.png: Changed ADT Manual titleScott Rifenbark
figure updated to reflect new manual title. (From yocto-docs rev: 420bad21ffe1d1fd60a1bbbe66f3e1463b80cff9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation: converted ref-images and ref-features to chaptersScott Rifenbark
As part of moving the reference manual to a real reference manual I am removing the "appendix" classification and having everthing be a chapter. I changed the "ref-imagese" and "ref-features" appendices to chapters and made any references in the doc set use the proper term now (chapter). (From yocto-docs rev: 08117634034a5cd5567c971957583d986c9ee9a4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-29documentation/adt-manual: Adjustments to Yocto Project termScott Rifenbark
Changes throughout the manual that either eliminate or change many of the "Yocto Project" strings. The file structure for the meta data is now called "source directory." The build directory is referred as just that - "build directory." Any where the build system is referred to it is called the "OpenEmbedded build system." (From yocto-docs rev: 1210c19f90d4a52042fec12657212ae3e58e13d6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-28documentation/adt-manual/adt-prepare.xml: Inserted noteScott Rifenbark
Added a note to warn the user about mixing ADT Intaller installation methods. (From yocto-docs rev: 718a48a7ea4753eb1e59e17a75c3d94a9ed166bb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-25documentation/adt-manual/adt-eclipse.xml: Updated YP settings dialogueScott Rifenbark
The dialogue for the Yocto Project Settings is now "Yocto Project Settings" instead of "Project Yocto Settings." Updated the manual. (From yocto-docs rev: 980b4d22dab4ac681c6dc1a85e78306213799062) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-25documentation/adt-manual/adt-eclipse.xml: Updated Yocto ADT Project itemScott Rifenbark
The selection "Yocto ADT Project" has changed to "Yocto Project ADT Project." (From yocto-docs rev: aa61cd4f93e08373ef430926c008da9f28f72ff8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-25documentation/adt-manual/adt-prepare.xml: Re-worded toolchain generationScott Rifenbark
The section that describes how to generate the cross-toolchain into the Yocto build tree erroneously referred to this process as installing the toolchain. Furthermore, it actually mentioned the creation of a toolchain tarball, which is wrong. I updated the section to more properly refer to this procedure as generating the toolchain. I also removed the bit about the tarball creation. (From yocto-docs rev: 5ae8faa651ed6bf22c5475a4eacb5c758c62cea1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-25documentation/adt-manual/adt-eclipse.xml: Updated Yocto Project ADT itemScott Rifenbark
The item to click in the step to configure the Eclipse Yocto Plug-in changed from "Yocto ADT" to "Yocto Project ADT." (From yocto-docs rev: fc860fe497be6da189e8e48f9546b105b9ff0075) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-25documentation/adt-manual/adt-prepare.xml: grammar fix.Scott Rifenbark
(From yocto-docs rev: e698503896615cf08366b004a66b4562f304e3b5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-21documentation/adt-manual/adt-prepare.xml: Added text about host gccScott Rifenbark
It is important that the environment uses a host gcc when running the adt installer. I put some text in noting that. (From yocto-docs rev: 7f63662913d6d79843e1bdcadc49bb120bb72688) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-05-31documentation/adt-manual/adt-eclipse.xml: Added not and updated versionScott Rifenbark
Fixes [YOCTO #2445] Added a note telling the user not to install Eclipse from the distribution's package repository but to rather be sure to install from the official Eclipse download site. Also, changed the tarball name from having a "3.7.1" in it to the recent version of "3.7.2". Reported-by: Lianhao Lu <lianhao.lu@intel.com> (From yocto-docs rev: f50d0071e39a5e8424633a55ab2c3fdc75e9686d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-05-31documentation: Added manual history for 1.3Scott Rifenbark
Added entries for the Manual History table for upcoming 1.3 docs. (From yocto-docs rev: 430b384035593cd05c4f286e20c01f0fe72da8ec) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-23documentation: Updated Manual Revision Tables again.Scott Rifenbark
After some discussion from Song and Richard, the dates in the manual revision table has been updated to "April 2012" for the 1.2 release. (From yocto-docs rev: b3fc2ec7c5aedb8ea0a2d502bdcd7e8f4092ed96) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-23documentation: Replacements for "1.1" and "edison", etc.Scott Rifenbark
I did a quick and dirty scrub over the manuals for the strings "1.1" and "edison". I found some instances that were not properly variablized. Also, discovered some references to the linux-yocto-3.0-1.1.x. All but one instance of this needed changed to linux-yocto-3.2. (From yocto-docs rev: 620fb4b7626defcefc8a039de09ae4599ee7f454) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-23documentation: Manual Revision Tables updatedScott Rifenbark
Five tables updated for the five manuals that have the tables. Used "May 2012" as the date. (From yocto-docs rev: 0d4d46ba300c07ff9c73186506be5b409bef9d1b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-28documentation: Added TBD entry to 1.2 manual history table.Scott Rifenbark
There needed to be an entry in all the manual history tables that indicated this version of the manual is for 1.2 but is WIP. Reported-by: Rudolf Streif <rudolf.streif@linux.com> (From yocto-docs rev: 6792b88af4f0171cfc84e4d77bda871d4af3d36c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-26documentation/adt-manual/adt-eclipse.xml: Added new commander sectionScott Rifenbark
Hongna Xu realized that the whole Bitbake Commander part is missing in the ADT manual. This should be Section 4.8. She sent the info and I created a new section titled "Customizing and Image Using a BitBake Commander Project and Hob". Reported-by: Hongna Xu <hongnax.xu@intel.com> (From yocto-docs rev: eb207806dbd2f73089068ef9e3fa447aa8a38404) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-26documentation/adt-manual: Edits to fix ADT manual for 1.2 per bug 2025Scott Rifenbark
Addressed all issues specified by [YOCTO #2025] except for the very first one that says bring the versions up to 1.2. This will be accomplished by the poky.ent bump at release time. Fixes [YOCTO #2025] (From yocto-docs rev: 926e5635d8cd74fff7e00002108ce8c039252203) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-23documentation/adt-manual/style.css: Added new style for Note headingsScott Rifenbark
The style for the note, caution, warning, and tip headings was a bit over-bearing. Feedback from the community indicated that those words needed to be in a smaller, less noticeable font. I created the style so that the font's size is about half of what it was and I also changed the color to match the other headings. (From yocto-docs rev: f54c6274e1972c52ba17d7ebd2ba84bf6d59c105) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation/adt-manual: Converted manual to use the poky.ent fileScott Rifenbark
Conversion of hard links to use the variables set up in the file documentation/poky.ent. (From yocto-docs rev: edbacc1b57f02c31ff6eaee666245be83fb17543) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation: Updated copyright notices to 2012.Scott Rifenbark
(From yocto-docs rev: a270fe40606ccbef5c453bb77f009306a7bdfb93) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation: Edits to all style.css filesScott Rifenbark
Updated all the CSS style sheets so that the Note, Warning, Tips, Caution, etc. boxes are not so prominant. (From yocto-docs rev: 451568553e9620c1e247c2f67b0665b184c3300b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation/adt-manual/adt-command.xml: Corrected wording for setupScott Rifenbark
Bad wording fixed to describe the changes to PATH when the setup script is run. (From yocto-docs rev: 0f2ae72edfab2a96cb5f82fac641f3b6fa364f36) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>