Commit Graph

44 Commits

Author SHA1 Message Date
Scott Rifenbark 09d260e3e5 profile-manual: Fixed a transposed title.
I had the actual title of the manual as displayed in the section
heading for Chapter One wrong.

(From yocto-docs rev: e61b251da0d8225f7497b2b7a0a8c8d1510a429b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 10:30:31 +01:00
Scott Rifenbark 3a980abd28 documentation: Updated manual history tables.
Added a new entry to support the 1.5.3 release.  Using July 2014
as the release month and year.

(From yocto-docs rev: fcd6046b8b2a5606e77d14cffa0bd2eebbe1748a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 10:30:31 +01:00
Scott Rifenbark 3decaf2620 documentation: Updated the manual revision history tables for 1.5.2
(From yocto-docs rev: c3674816afea52cc37ae842577f8eebf34d20d69)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-12 20:31:59 +01:00
Scott Rifenbark ed0353828e poky.ent, documentation: Updated manual release dates.
Updated poky.ent to use 2014 as the top-end copyright year.
Updated all the Manual Revision History tables to use January
2014 as the 1.5.1 release date.

(From yocto-docs rev: 885a89231c664ccbd9032c45584aa19dce7c0b38)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-08 13:01:44 +00:00
Robert P. J. Day a70b2f2a9c profile-manual: Edits from Robert P. J. Day
If someone wants to check this over, make sure I didn't make
any silly changes.

(From yocto-docs rev: d1dd154740ffb9c858a66cab80486a4d684131da)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:58 +00:00
Robert P. J. Day ac3f5a3e78 profile-manual: Review edits from Robert P. J. Day
Given the length of the tools sections in the profiling manual,
I'm doing each tool separately so that patches come in
manageable chunks.

(From yocto-docs rev: 9e06ea7c09ca397f7ade7404f9d3fd2dc17da095)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:58 +00:00
Robert P. J. Day ea8dcadbe5 profile-manual: Small typo fixed.
(From yocto-docs rev: af33c6c26a56aff1e0e220583c5d66d3f89cefd5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:57 +00:00
Scott Rifenbark 29d095ff71 documentation: Changed Note for most recent manual
Fixes [YOCTO #5368]

Changes partially address this issue, which is the removal of
tarball installations for poky.  The notes at the beginning of
the YP manuals suggested that the tarball version of a manual
might lag the version found on the website.  Because we are
discouraging installing poky/documentation from a tarball now,
I have re-written the note to be generic and suggest simply that
for the most recent version of the manual associated with the
release, see the manual on the website.

(From yocto-docs rev: d47ff8285a6ba01d721509724641a51aab8da73d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01 17:46:42 +00:00
Scott Rifenbark d72b558cd9 poky.ent, documentation: Updates for building 1.5.1 release.
Changed variables in poky.ent to support building 1.5.1.

Added Manual revision entry to all manuals with that table for
the 1.5.1 release.

(From yocto-docs rev: a1c3196199437c3a7cfdf86e4f78b806c66b6385)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01 17:46:41 +00:00
Scott Rifenbark c8b6934009 profile-manual: Added note about SystemTap ssh connectivity
Fixes [YOCTO #4409]

Added a note into the Setup section for SystemTap that tells
how ssh connection is assumed.  Also provided a link to the
wiki page that basically replicates all the same information that
is in the section.

(From yocto-docs rev: b57429bb8ceccb51648cc797467d8bf8778f2da2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01 17:46:40 +00:00
Scott Rifenbark 6b9cff42a8 documentation: Updated Manual Revision History Tables
Placed the release month of October in for the 1.5 release.

(From yocto-docs rev: c0431b2b3115d9687dcb5d3ba37adf6bf4695867)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-10-01 22:52:55 +01:00
Scott Rifenbark 9fbaa9b9ec dev-manual, profile-manual: changed "plugin" to "plug-in"
Changed all these occurrances throughout the manual set so
they are consistent.  The only ones left are now in pathnames
or UI things where they need to stay that way.

(From yocto-docs rev: 1b77f34b7b6983f7d7e680cd9fd6a714c00ba8f8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-22 12:20:48 +01:00
Scott Rifenbark 91ec8a8988 documentation: Updates to properly build the 1.5 manuals
1. Changed the variables in poky.ent to contain the "1.5"
   string and the "tbd" string for the unknowns.

2. Updated the manual revision history tables so to replace
   the 1.4.1 release entry, which should not be there, to the
   1.5 entry.

(From yocto-docs rev: d03a09875b1fe0d244b7a7c1bde718319d95a8ab)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22 17:23:38 +01:00
Scott Rifenbark 98d2211872 documentation: Set up the 1.4.1 manual set.
1. Edited poky.ent to have 1.4.1 and 9.0.1 for release stuff.
2. Updated the manual revision tables to have a new entry
   for 1.4.1 release.

(From yocto-docs rev: bd4058b98f93ea5fd5d878f24018ce78b8ce1a53)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22 17:23:38 +01:00
Scott Rifenbark 15699d331c documentation: Updated the release month to April in manual history tables.
(From yocto-docs rev: 3dc4e3db0a76a29c9726d38e3f862940437317c9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-10 16:20:54 +01:00
Scott Rifenbark 9114dfcbe8 profile-manual: Updated sysprof basic usage section
There was a danny-specific note here that did not apply to the
section any longer.  I have removed it per Tom Zanussi's
suggestion.

(From yocto-docs rev: 2a3ccab263cfaa779a5182e6a4a7e534db253700)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22 17:08:43 +00:00
Scott Rifenbark d6cd06216e profile-manual: updated the Oprofile section
Removed the danny-specific note at the end of the
"OProfileUI - A GUI for OProfile" section per Tom Zanussi.

(From yocto-docs rev: b665be9ad906cdc3ac644e67151da3a2cc1acfd3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22 17:08:43 +00:00
Scott Rifenbark e5087d586f profile-manual: Updates to LTTng section setup
With dylan, the two patches are no longer required.  However,
the information to view traces still holds true regarding
using Eclipse's Juno.  Updated appropriately.

(From yocto-docs rev: 90845677a37562b465bbd2bc849f773a2f54d92e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22 17:08:43 +00:00
Timo Mueller 5d5800ef6f documentation: Part 2 of 2 for YP doc integration into Eclipse.
This commit adds the three *.customization.xsl files.  I
(Scott Rifenbark).  Split the commit because after applying the
18 patches, the list of stuff to stage was huge and I did not
want to add them one-by-one.  So I staged them using git add -u.

Here is the general cover letter information from Timo included
with the 18 patches:

-----------------

Hi,

the generation of eclipse help files has been merged from the timo
branch to the master. Since the creation of the timo branch there have
been some changes to the master branch (e.g. new documentation,
renamed documentation).

This patch set does some cleanup for the renamed documentation and
adds eclipse help generation support to the new documentation.

01: Removes the 'the' from the document titles
02..04: Cleanup obsolete artifacts resulting from the merge
05..08: Add eclipse help generation for ref-manual
09..13: Add eclipse help generation for kernel-dev
14..18: Add eclipse help generation for profile-manual

Best regards,
Timo

(From yocto-docs rev: eff391a17d0a2403634adfb2f4cd2ff50ad0b771)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:25:43 +00:00
Timo Mueller a41a805500 documentation: Part 1 of 2 updates to integrating docs to Eclipse help.
Hi,

the generation of eclipse help files has been merged from the timo
branch to the master. Since the creation of the timo branch there have
been some changes to the master branch (e.g. new documentation,
renamed documentation).

This patch set does some cleanup for the renamed documentation and
adds eclipse help generation support to the new documentation.

01: Removes the 'the' from the document titles
02..04: Cleanup obsolete artifacts resulting from the merge
05..08: Add eclipse help generation for ref-manual
09..13: Add eclipse help generation for kernel-dev
14..18: Add eclipse help generation for profile-manual

Best regards,
Timo

This patch set originally contained 18 patches. I (Scott Rifenbark)
had to push these changes as two parts.  This is the first part.
It does not include creation of the three cusomization files.

(From yocto-docs rev: 9b1889f6e31ee70dae704fa08763fb9196616dad)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:25:35 +00:00
Scott Rifenbark b4b1dc1dd6 profile-manual: Fixed the "Tying it Together" side-lights.
Took them out of the colored Note format and replaced with
a simple line box to set them apart.

(From yocto-docs rev: 5efb84d3860d87f64371b718967ab33f47a3a4db)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:04 +00:00
Scott Rifenbark f3cb977699 profile-manual: Fixed typo in last section
Changed "Line" to "Live" in the section heading.

(From yocto-docs rev: 73ea1f5a01891aa51c872363a60d2e0eefdf2f64)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:04 +00:00
Scott Rifenbark 7e091de56b profile-manual: Fixed "short" figures to remove space.
(From yocto-docs rev: 5f4cfbef0689b5c84d8fa14c413f8a4c5a9521c3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:04 +00:00
Scott Rifenbark 5cd5cb2b26 profile-manual: Added links for literall http:// strings.
(From yocto-docs rev: a30bc0c5e1c752ea3c6f73acd203e80a398d5368)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:04 +00:00
Scott Rifenbark 842e3b83c2 profile-manual: Added blktrace section.
No re-writing at all.

(From yocto-docs rev: c18bd94ac0e6fc3a23139ec8d1ef7b04518746de)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:03 +00:00
Scott Rifenbark e4746a55e4 profile-manual: Added LTTng section to usage chapter.
No re-writing at all.

(From yocto-docs rev: 6ed32ad5daa1f16c414da665a2fea498baefbe4a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:03 +00:00
Scott Rifenbark 697b9ec4f7 profile-manual: Added Sysprof section to usage chapter.
No re-writing.

(From yocto-docs rev: e3fd833c4bf7cdc50138ac940af8a2b35c37c52b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:03 +00:00
Scott Rifenbark acb86de34e profile-manual: Added oprofile usage section.
No re-writing at all.

(From yocto-docs rev: f42230e3665903a7603212696949241244555f8b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:03 +00:00
Scott Rifenbark fcf615546f profile-manual: Systemtap section added.
No re-writing at all.

(From yocto-docs rev: 4ca472f8200f9d927a8d37c88c1ff75b017fcfc1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:03 +00:00
Scott Rifenbark 44e838c612 profile-manual: Substituted real title image in.
(From yocto-docs rev: 7492d719e59fdc023da06554b7b65af63d76a6df)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:02 +00:00
Scott Rifenbark 82928e228b profile-manual: Added ftrace section to the manual.
No re-writing, no clean up what-so-ever.  It is simply in the
DocBook form.

(From yocto-docs rev: 3d2c17c076b67c3e2ab094d0562038e422b63d44)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:02 +00:00
Scott Rifenbark 41fe45977c profile-manual: Corrected bad literallayout statement.
(From yocto-docs rev: fc3aa3815bfdfac11e93167dda8e52457b42c4c6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:02 +00:00
Scott Rifenbark 803ccdb93a profile-manual: Added profile-title.png to stylesheet
(From yocto-docs rev: ad0222226cf4e29673e859cc95496c53875202cf)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:02 +00:00
Scott Rifenbark 86478ff948 profile-manual: Updated indentation and sectioning
Had the sectioning off and it was preventing the manual from
making.  I also added more indentation as needed throughout
most of the manual up to the error.

(From yocto-docs rev: 5de3544593a63e96b349babc177970d8605e0098)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:02 +00:00
Scott Rifenbark 487a76f7c7 profile-manual: Correctly named "figures" folder.
This adds in the figures under the correct spelling for the
"figures" folder.

(From yocto-docs rev: 83d7896623a9a88538dd1da45429f47777123338)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:02 +00:00
Scott Rifenbark 1fbdf5035d profile-manual: Rename of figures folder.
Initially the 'figures' folder was mis-named as 'Figures'.
this is not in line with the other manuals.  I had to rename
the folder and thus delete all these files from the Git repo
since they had been committed.

(From yocto-docs rev: 4452e790e8ddb8c80a5f0c6faf4a1f86fd3fb8d7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:02 +00:00
Scott Rifenbark 33b7996446 profile-manual: Converted root XML file for profile-manual
Edits to change this file to work for the profile-manual.

(From yocto-docs rev: 60a52fb31f2d15709afa29e83aa5d50bf8d90c58)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:54:09 +00:00
Scott Rifenbark 7f64ad2423 profile-manual: Second half of perf raw text entered.
Finished entering the rest of the "perf" section.

(From yocto-docs rev: 3df34a299ef9656362bf5b851b575528c646c02b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:54:09 +00:00
Scott Rifenbark 89dbdec992 profile-manual: Adding raw text.
Started to put in the usage chapter.  Adding text and
sectioning off by paragraph and formatting for literal
sections.

(From yocto-docs rev: c2d328d19023cd6fac6dcaeb8449e2203b5a17b7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:54:09 +00:00
Scott Rifenbark cdacd8764b profile-manual: Copied in raw "Examples" chapter.
I put the raw text is for chapter 4.  No editing.

(From yocto-docs rev: e4a017624595394f86f469e15c1c8ad13e82206d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:54:09 +00:00
Scott Rifenbark 982637f27a profile-manual: Copied in this raw text.
This is the raw text from Tom for the architecture chapter.
No editing at all.

(From yocto-docs rev: f402cc14ac7fef30460e130cc5bdfca731886aa3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:54:08 +00:00
Scott Rifenbark 0ac8eba578 profile-manual: Raw text for introduction chapter.
this text is straight from Tom's wiki.  no formatting
no nuthin'

(From yocto-docs rev: 95f5341169c3e8d3bd7a97740320d0d27cbee020)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:54:08 +00:00
Scott Rifenbark 6b7ae32946 profile-manual: Added basic XML files and updated the .gitignore
Added four chapters to the directory.  I based these chapters off
of an existing YP manual.  I also updated the .gitignore file
so that it will support ingnoring profile-manual make operations.

(From yocto-docs rev: f9658f627fe9d8d6868ce74e9550ea16d23c4156)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:54:08 +00:00
Scott Rifenbark bc8c416585 profile-manual: Created directory structure and loaded figures.
(From yocto-docs rev: c9966f4fe0174489941ab728d6b840f565b906c5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:54:08 +00:00