Commit Graph

1593 Commits

Author SHA1 Message Date
Scott Rifenbark 5174240361 kernel-dev: Added "-dirty String" section.
The "-dirty" String section from the old YP Kernel Architecture
and Use Manual was moved to section 2.3 of the manual.  It needs
to find the right area to be put in (AR for Darren).  I added the
AR text to the top of the section so it would not fall through
the cracks.

(From yocto-docs rev: eaa5b86643572a6c74028dc3330625a0bfbca50e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:03 +00:00
Scott Rifenbark 46dcd9fd73 kernel-dev: Added "Inspecting Changes and Commits" section
A Section about seeing what has changed in a kernel tree
was moved from the old YP Kernel Architecture and Use Manual
to this new manual.  The section moved was "Change Inspection:
Changes/Commits".  In addition to moving the sections, I
shortened them up by removing verbose parts of the section.

(From yocto-docs rev: 2c620ea2bed0844b70b497dfa461c0b364312e39)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:03 +00:00
Scott Rifenbark d36e4792e7 kernel-dev: Added "Maintenance" appendix.
New appendix required adding the kernel-dev-maint-appx.xml
file.  The contents are sections 3.2 and 3.3 from the old
YP Kernel Architecture and Use Manual, which is "Tree
Construction" and "Build Strategy."  According to Darren Hart,
this information should be retained for the few people on
the planet that might ever need it.  In addition to adding
the new file, I had to add the bits to the kernel-dev.xml
manual to support including the appendix when making the
manual.

(From yocto-docs rev: b25e40308080c59c6700e1dce8ebf6a9a2dafbcc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:03 +00:00
Scott Rifenbark 805a36cd58 ref-manual: Fixed broken link to "Build Directory" term.
(From yocto-docs rev: 311edd13da00f6849094346aaa9509f27d60b2c4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:02 +00:00
Scott Rifenbark a24cb73f39 kernel-dev: Added "Kernel Architecture" section.
Moved the "Kernel Architecture" section from the YP Kernel
Architecture and Use Manual to this manual.  The section
included the kernel-architecture-overview.png figure.  So,
I added that PNG file to the "figures" folder.  Finally, I
had to also add the PNG file to the Makefile tarfile list
for kernel-dev.  Note that because the figure was part of
the old YP Kernel Architecture and Use Manual, I did not have
to add the figure to the mega-manual tarfile list.

(From yocto-docs rev: fbc5508ce162ea7915fd5dce74338b6a5bfd7ce1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:02 +00:00
Scott Rifenbark 36b5f97e26 kernel-dev: Changed the FAQ to be an appendix.
(From yocto-docs rev: 0439024c603fbc190741ea0cc807923bb41028a8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:02 +00:00
Scott Rifenbark 9ba5e61b7a kernel-dev: Updates to support new concepts appendix
Added bits to support building the new kernel concepts
appendix.

(From yocto-docs rev: 6d372bd12288142b09c729f877c1e894f11c7c27)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:02 +00:00
Scott Rifenbark d029e786b5 kernel-dev: Added new appendix for kernel concepts.
(From yocto-docs rev: e25465c6d177a27d3dee742ebc958ae30f968ffa)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:02 +00:00
Scott Rifenbark b80e983620 kernel-dev: Added an AR to the beginning for Darren
The concepts in three bulleted items in the old kernel manual
need to be present in this new manual.  I put in a bit of text
right at the beginning of the manual in the form of an AR for
Darren.  This will eventually be removed, but for now it is there
so that it won't slip through the cracks.

(From yocto-docs rev: 85b7300df30837f72d936f8ec1af0b2a4a9c1a88)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:01 +00:00
Scott Rifenbark b2869b6810 ref-manual: Added a general reference and link to kernel-dev
Put in a cross-link to the new YP Linux Kernel Development
Manual up in the introduction.

(From yocto-docs rev: ba00acb1a0db9494b0d0ff1335f2532b5e2a7994)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:06 +00:00
Scott Rifenbark 347e99427f dev-manual: Scrub for correct YP manual cross-references.
I went through and got rid of all references to the old
YP Kernel Architecture and Use Manual and replaced with
appropriate references to the new YP Linux Kernel
Development Manual.

I also laced in appropriate references into various sections
of the new YP Profiling and Tracing Manual.

Also, updated the list of resource manuals to reflect the
new manual set (addition of kernel-dev and profile-dev and
removal of kernel-manual).

(From yocto-docs rev: ef531ad65c9b749dad5e8e39b060bf1641e4fa38)

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 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 79d192fb2c ref-manual: Added new KFEATURE_DESCRIPTION glossary entry.
(From yocto-docs rev: 34060ca253a4434cd61c61fbefd0fe58ecd5fb36)

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 5053b65416 kernel-dev: General edits and links added.
Many links added to the glossary variables that were introduced
in the manual.

Also provided general edits as I found them.

(From yocto-docs rev: 1c004144669306e87ad783df766b5245e474f549)

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 dd46994f45 ref-manual: Added new variable KBRANCH_DEFAULT.
(From yocto-docs rev: d97c04fd6e818e7b78971f8c459a9778fb4e69f4)

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 eb576addf5 kernel-dev: Links and edits to the Common Tasks chapter.
(From yocto-docs rev: 46cd5eabe2343897eb9b4822064735bf335beb47)

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 64933666a6 ref-manual: New KERNEL_PATH variable added to the glossary.
Also put in a cross-reference in the existing KERNEL_SRC
variable.

(From yocto-docs rev: 705074a16490155cd64469af3b2ea12a0780281c)

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 ce6ed21ee7 ref-manual: New KERNEL_SRC variable added to glossary.
(From yocto-docs rev: d8f7b32a9be1834f7835262f58c577b1f40a3edc)

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 e6310f6310 kernel-dev: Minor edits to the overview section.
(From yocto-docs rev: 42c9b33d38150672d1ea177f98a86c71806caa3a)

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 a24c555641 ref-manual: Set KARCH as the top "K" entry for the glossary.
(From yocto-docs rev: 1fceec975f9e6b40c64d55050e257c2239340d65)

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 8c58a9cca2 dev-manual: Edits to "Metadata" term.
In the "Terms" section, I enhanced the "Metadata" term to include
a bit about Metadata in the context of the kernel.  This type of
metadata is discussed at length in the YP Linux Kernel Development
Manual.

(From yocto-docs rev: c6f48bc4c33850eaa1dbf5867759a19d373766ce)

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 4f3fdc33af ref-manual: New variable descriptions for KTYPE and KARCH.
(From yocto-docs rev: 35b7baa5653cffbb5e1dd1759643135c08b15bf7)

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 f37037f26f ref-manual: Edits to a couple variables in the glossary
1. LINUX_VERSION_EXTENSION: Added a link on the
   LINUX_KERNEL_TYPE variable.

2. Added a new variable description for the
   LINUX_KERNEL_TYPE variable.

(From yocto-docs rev: f4ace3c64838044e2eb700af4b024a96ab1e2315)

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 afb26ddaad ref-manual: Edits to the LINUX_VERSION_EXTENSION variable.
Applied Darren Hart's review comments.  Namely, use the
example from the linux-yocto recipes and not the custom
recipe.

(From yocto-docs rev: 4a537a02bbf6fca4ff1a3beddd03d8115099cddd)

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 4648e34300 ref-manual: Edits to the LINUX_VERSION variable.
Added a bit about the variable being used to define PV for the
recipe.

Also, fixed a couple indentation problems with some nearby
variables.

(From yocto-docs rev: bec65049218c9c549fe8cd4d5c16e9d917e87866)

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 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 34f0fc3728 mega-manual: Added support to build profile-manual.
(From yocto-docs rev: fe59bccc799daf03d4dc8ccbbb842529dc41d3ea)

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 37b290f0a8 Makefile: Updated to support mega-manual build with profile-manual
Added the list of 32 profile-manual figures to the tarfile
variable for mega-manual.

(From yocto-docs rev: ffe0586990c7659c28001038d6ba55cd42f5ecd0)

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 0c43dbbe4f mega-manual: Added the profile-manual figures
The figures from the profile-manual/figures folder must be
added to the mega-manual/figures folder in order for the
mega-manual to make correctly.

(From yocto-docs rev: f64459330b472dbade936f9d964b4792fb6364bc)

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 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 43f565aa4e poky.ent: Added new YOCTO_DOCS_PROF_URL variable.
(From yocto-docs rev: cc6082ee1fb33fa7a91c1a6e8aa92b568e1c8fee)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:55:58 +00:00
Scott Rifenbark 9bd5435f6f Makefile: Added support for the new profile-manual.
(From yocto-docs rev: 09183423d3049b954b0f0a5d882bf85218b5aff9)

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 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