summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
...
* Makefile: Removed bits that support kernel-manualScott Rifenbark2013-01-301-16/+2
| | | | | | | | | | | I took out the logic that built the old YP Kernel Architecture and Use Manual. This manual can no longer be build. It is being retired. (From yocto-docs rev: 8d5b179995e561deb94572150e904da5cd4dec19) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Added "-dirty String" section.Scott Rifenbark2013-01-301-0/+43
| | | | | | | | | | | | | 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>
* kernel-dev: Added "Inspecting Changes and Commits" sectionScott Rifenbark2013-01-301-0/+108
| | | | | | | | | | | | | 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>
* kernel-dev: Added "Maintenance" appendix.Scott Rifenbark2013-01-302-0/+220
| | | | | | | | | | | | | | | | | 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>
* ref-manual: Fixed broken link to "Build Directory" term.Scott Rifenbark2013-01-301-1/+2
| | | | | | | (From yocto-docs rev: 311edd13da00f6849094346aaa9509f27d60b2c4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Added "Kernel Architecture" section.Scott Rifenbark2013-01-303-1/+166
| | | | | | | | | | | | | | | | 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>
* kernel-dev: Changed the FAQ to be an appendix.Scott Rifenbark2013-01-301-2/+2
| | | | | | | (From yocto-docs rev: 0439024c603fbc190741ea0cc807923bb41028a8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updates to support new concepts appendixScott Rifenbark2013-01-301-0/+2
| | | | | | | | | | 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>
* kernel-dev: Added new appendix for kernel concepts.Scott Rifenbark2013-01-301-0/+89
| | | | | | | (From yocto-docs rev: e25465c6d177a27d3dee742ebc958ae30f968ffa) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Added an AR to the beginning for DarrenScott Rifenbark2013-01-301-0/+21
| | | | | | | | | | | | | 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>
* ref-manual: Added a general reference and link to kernel-devScott Rifenbark2013-01-271-1/+2
| | | | | | | | | | 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>
* dev-manual: Scrub for correct YP manual cross-references.Scott Rifenbark2013-01-273-13/+42
| | | | | | | | | | | | | | | | | | | 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>
* adt-manual: Added cross-references to profile-manual.Scott Rifenbark2013-01-271-3/+14
| | | | | | | | | | | | | 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>
* ref-manual: Added new KFEATURE_DESCRIPTION glossary entry.Scott Rifenbark2013-01-271-0/+16
| | | | | | | (From yocto-docs rev: 34060ca253a4434cd61c61fbefd0fe58ecd5fb36) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: General edits and links added.Scott Rifenbark2013-01-271-21/+27
| | | | | | | | | | | | 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>
* ref-manual: Added new variable KBRANCH_DEFAULT.Scott Rifenbark2013-01-271-0/+15
| | | | | | | (From yocto-docs rev: d97c04fd6e818e7b78971f8c459a9778fb4e69f4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Links and edits to the Common Tasks chapter.Scott Rifenbark2013-01-271-11/+17
| | | | | | | (From yocto-docs rev: 46cd5eabe2343897eb9b4822064735bf335beb47) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New KERNEL_PATH variable added to the glossary.Scott Rifenbark2013-01-271-1/+27
| | | | | | | | | | 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>
* ref-manual: New KERNEL_SRC variable added to glossary.Scott Rifenbark2013-01-271-0/+14
| | | | | | | (From yocto-docs rev: d8f7b32a9be1834f7835262f58c577b1f40a3edc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Minor edits to the overview section.Scott Rifenbark2013-01-271-2/+2
| | | | | | | (From yocto-docs rev: 42c9b33d38150672d1ea177f98a86c71806caa3a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Set KARCH as the top "K" entry for the glossary.Scott Rifenbark2013-01-271-1/+1
| | | | | | | (From yocto-docs rev: 1fceec975f9e6b40c64d55050e257c2239340d65) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Metadata" term.Scott Rifenbark2013-01-271-3/+8
| | | | | | | | | | | | 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>
* ref-manual: New variable descriptions for KTYPE and KARCH.Scott Rifenbark2013-01-271-0/+45
| | | | | | | (From yocto-docs rev: 35b7baa5653cffbb5e1dd1759643135c08b15bf7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to a couple variables in the glossaryScott Rifenbark2013-01-271-1/+29
| | | | | | | | | | | | | 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>
* ref-manual: Edits to the LINUX_VERSION_EXTENSION variable.Scott Rifenbark2013-01-271-7/+6
| | | | | | | | | | | 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>
* ref-manual: Edits to the LINUX_VERSION variable.Scott Rifenbark2013-01-271-2/+8
| | | | | | | | | | | | | 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>
* profile-manual: Fixed the "Tying it Together" side-lights.Scott Rifenbark2013-01-272-39/+39
| | | | | | | | | | 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>
* profile-manual: Fixed typo in last sectionScott Rifenbark2013-01-271-1/+1
| | | | | | | | | 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>
* profile-manual: Fixed "short" figures to remove space.Scott Rifenbark2013-01-271-8/+8
| | | | | | | (From yocto-docs rev: 5f4cfbef0689b5c84d8fa14c413f8a4c5a9521c3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* profile-manual: Added links for literall http:// strings.Scott Rifenbark2013-01-271-11/+11
| | | | | | | (From yocto-docs rev: a30bc0c5e1c752ea3c6f73acd203e80a398d5368) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* mega-manual: Added support to build profile-manual.Scott Rifenbark2013-01-271-0/+5
| | | | | | | (From yocto-docs rev: fe59bccc799daf03d4dc8ccbbb842529dc41d3ea) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Makefile: Updated to support mega-manual build with profile-manualScott Rifenbark2013-01-271-1/+17
| | | | | | | | | | 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>
* mega-manual: Added the profile-manual figuresScott Rifenbark2013-01-2732-0/+0
| | | | | | | | | | | 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>
* profile-manual: Added blktrace section.Scott Rifenbark2013-01-271-0/+404
| | | | | | | | | 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>
* profile-manual: Added LTTng section to usage chapter.Scott Rifenbark2013-01-271-0/+386
| | | | | | | | | 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>
* profile-manual: Added Sysprof section to usage chapter.Scott Rifenbark2013-01-271-0/+123
| | | | | | | | | 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>
* profile-manual: Added oprofile usage section.Scott Rifenbark2013-01-271-0/+552
| | | | | | | | | 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>
* profile-manual: Systemtap section added.Scott Rifenbark2013-01-271-0/+217
| | | | | | | | | 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>
* profile-manual: Substituted real title image in.Scott Rifenbark2013-01-271-0/+0
| | | | | | | (From yocto-docs rev: 7492d719e59fdc023da06554b7b65af63d76a6df) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* profile-manual: Added ftrace section to the manual.Scott Rifenbark2013-01-271-0/+664
| | | | | | | | | | 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>
* profile-manual: Corrected bad literallayout statement.Scott Rifenbark2013-01-271-1/+1
| | | | | | | (From yocto-docs rev: fc3aa3815bfdfac11e93167dda8e52457b42c4c6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* profile-manual: Added profile-title.png to stylesheetScott Rifenbark2013-01-271-19/+18
| | | | | | | (From yocto-docs rev: ad0222226cf4e29673e859cc95496c53875202cf) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* profile-manual: Updated indentation and sectioningScott Rifenbark2013-01-271-628/+629
| | | | | | | | | | | 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>
* profile-manual: Correctly named "figures" folder.Scott Rifenbark2013-01-2732-0/+0
| | | | | | | | | | 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>
* profile-manual: Rename of figures folder.Scott Rifenbark2013-01-2731-0/+0
| | | | | | | | | | | | 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>
* poky.ent: Added new YOCTO_DOCS_PROF_URL variable.Scott Rifenbark2013-01-271-0/+1
| | | | | | | (From yocto-docs rev: cc6082ee1fb33fa7a91c1a6e8aa92b568e1c8fee) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Makefile: Added support for the new profile-manual.Scott Rifenbark2013-01-271-0/+30
| | | | | | | (From yocto-docs rev: 09183423d3049b954b0f0a5d882bf85218b5aff9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* profile-manual: Converted root XML file for profile-manualScott Rifenbark2013-01-271-26/+9
| | | | | | | | | 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>
* profile-manual: Second half of perf raw text entered.Scott Rifenbark2013-01-271-0/+353
| | | | | | | | | 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>
* profile-manual: Adding raw text.Scott Rifenbark2013-01-271-1088/+862
| | | | | | | | | | | 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>