Commit Graph

27 Commits

Author SHA1 Message Date
Scott Rifenbark cc06786545 adt-manual: Reword for how user-space tools are provided.
The "User-Space Tools" section incorrectly stated that user-space
tools are provided as part of the distribution.  The Yocto
Project is not a distribution.  So I changed to say that they
are provided as part of the Yocto Project.

(From yocto-docs rev: 03dd97b68a1900959aa51ad6a17547822e8392fc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:54 +00:00
Scott Rifenbark b0639bc8ae adt-manual: Added cross-reference to OE build system term
First occurrence cross-reference added.

(From yocto-docs rev: 91db235e935e799c2d4cc301ef799cb581704020)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:54 +00:00
Scott Rifenbark 720cdabe9b adt-manual: Edited the "Perf" bullet item.
The link to the wiki had some extra instruction in there that
was bogus.  I removed that.

(From yocto-docs rev: 9dab5c3c8d0ee2b3ff84a4b94bda8f0420c438f7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 12:29:39 +00:00
Scott Rifenbark 2f0f79c41e adt-manual: Added cloning poky as a way to have QEMU available.
(From yocto-docs rev: ca0a4cf869e94a382c2414fcad46c5e1f0268305)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 12:29:39 +00:00
Scott Rifenbark 2edf033741 adt-manual: Restructured opening organization.
The start of this manual was odd.  I created a new "Introduction"
chapter and inserted it into the build file (adt-manual.xml).
This new chapter introduces the manual.  That left the remainder
of the original first chapter to be able to focus on what it
really needed to talk about and that is the ADT.  It is a better
organization.

(From yocto-docs rev: 9d489abad9ccd4c0893d7496282f0843d4154942)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 12:29:39 +00:00
Scott Rifenbark 43469cd8ad adt-manual, dev-manual: Removed the LatencyTop website link.
This site has disappeared and I don't think there is a
replacement.

(From yocto-docs rev: 711488b664e1da7f3a4c64af3fbd4012bfb44d56)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01 17:09:56 +00:00
Scott Rifenbark c29c155b7f adt-manual: minor updates.
1. Made "Metadata" the term instead of "metadata".
2. Created a link to "Metadata" term for first use.
3. Fixed a broken link to the LatencyTop site.

(From yocto-docs rev: 7b53ddd0c9c846c558796d8ae6a46c476ab3b68d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:22 +01:00
Scott Rifenbark 6b4e25afc4 adt-manual: Added note to indicate ADT is distribution neutral.
Cleared up some old wording that was confusing the build
system with "Poky".  Also, added a note at the front of the
manual to be clear that the ADT is distribution-neutral.

(From yocto-docs rev: 52d090ab931e5cbeffc612b91c11dbb55db15297)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22 17:08:42 +00:00
Scott Rifenbark 7681523408 adt-manual: Added cross-reference link for Cross-dev toolchain.
I placed a link on the term "Cross-Development Toolchain" in the
section of the same name.  This is to help the user see the
recipes related to the toolchain.  The link resolves back into
the "Terms" section of the dev-manual.

(From yocto-docs rev: c77ec0212bcf3b1c5f8079ccf08129ecbefea0aa)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:24:04 +00:00
Scott Rifenbark 9713fdcebe adt-manual: Added cross-references to profile-manual.
I added some cross-references to the section that overviews
the user-space tools.  Three tools (perf, oprofile, and
systemtap) are in the list.  I added appropriate cross
references to the respective tool sections in the YP
Profiling and Tracing Manual.

(From yocto-docs rev: 9b1ee95fa9dd4110f5b4f9e7aeaba63c6ef8b148)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:05 +00:00
Scott Rifenbark 3bcdba62b1 documentation: adt-manual - Removed all trailing whitespace.
(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-11 16:15:24 +00:00
Scott Rifenbark c26d20e7be documentation: adt-manual - final edits before 1.3 lockdown.
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-23 00:03:13 +01:00
Scott Rifenbark c4a923bcb0 documentation: Toolchain corrections from tarball to .sh file
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-14 09:50:52 +01:00
Scott Rifenbark 24b14e3f57 documentation: tag change adt and kernel manuals
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-09-04 12:54:55 +01:00
Scott Rifenbark 41c7020d7a documentation: Moved the Eclipse chapter to the YP Dev Manual.
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-24 10:35:34 +01:00
Scott Rifenbark bf1cc56bec documentation/adt-manual/adt-intro.xml: Edits to introduction chapter
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-18 12:43:51 +01:00
Scott Rifenbark 347424e558 documentation/adt-manual: Adjustments to Yocto Project term
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-29 13:31:02 +01:00
Scott Rifenbark 2ede6c8c44 documentation/adt-manual: Converted manual to use the poky.ent file
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-08 12:08:09 -08:00
Scott Rifenbark aa2df47f00 documentation/adt-manual/adt-intro.xml: Fixed broken perf link
(From yocto-docs rev: 8e507098eb88cf318d439d3109f0a9c63cf4b974)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:40 -08:00
Scott Rifenbark 77d1ba446c documentation/adt-manual: General edits.
I made a pass through the manual and made some general formatting changes,
updated some links in anticipation for the 1.1 release.

(From yocto-docs rev: f2d3a012fbe4e8db3cf07e5497acfdf732e55d97)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-02 23:38:51 +01:00
Scott Rifenbark bb07dfe662 documentation/adt-manual/adt-intro.xml: Updated description of toolchain (From yocto-docs rev: 1ea4683eb41e4be334b053c622ed5bf08041d617)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-24 11:27:30 +01:00
Scott Rifenbark 21a4939006 documentation/adt-manual/adt-intro.xml: updated QEMU overview
I provided more detail in the section that introduces QEMU and tells
how it is made available to the user.

(From yocto-docs rev: 9145fee2d550af57669120b1b413585b69ab14bc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-24 11:27:30 +01:00
Scott Rifenbark 75f4b8caae documentation/adt-manual/adt-intro.xml: Grammar correction (From yocto-docs rev: 738c4f25ba6bcc408789dda118b127d716c2f4c6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-24 11:27:30 +01:00
Scott Rifenbark 982397c813 documentation/adt-manual/adt-intro.xml: changed definition of ADT
The manual previously defined the "ADT" as the toolchain, the sysroot,
QEMU, and user-space tools.  This definition was creating some confusion
when it came to installing the "ADT".  Namely, some of the items you
don't even install, such as the user-space tools.  So I recast the
definition of ADT to mean the cross-toolchain and sysroot.  I cast the
other items as part of the overall development environment.

(From yocto-docs rev: 6ee891660d3b6bf6e2a3f4b5a872ade7a007ce02)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-24 11:27:30 +01:00
Scott Rifenbark b9217b5a32 documentation/adt-manual/adt-intro.xml: Initial text
This commit is the initial text for the introduction chapter.

(From OE-Core rev: 7c0899aa6d712e373bd1a2df1fb52dcf3a87b2fe)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-16 13:54:25 +00:00
Scott Rifenbark 4a8b398d4c documentation/adt-manual: cleaned up labels in chapter files
The initial chapters were failing to make due to duplicate section
identifiers that were created when I copied in the original files.
I gave each of the five chapter files (adt-command.xml, adt-eclipse.xml,
adt-intro.xml, adt-package.xml, and adt-prepare.xml) unique identifier
tags.

(From OE-Core rev: d30460c835c51dcc9301bcd848ceda29ba9ceeb6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-16 13:54:24 +00:00
Scott Rifenbark 3258234181 documentation/adt-manual: New file structure for ADT Manual
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.

(From OE-Core rev: ac2c8848bbefcf7d24192573904baaef87c67382)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-16 13:54:22 +00:00