summaryrefslogtreecommitdiffstats
path: root/documentation/mega-manual
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual, mega-manual: Updated figure for conf/compile detailsScott Rifenbark2013-08-261-0/+0
| | | | | | | | | | | | Fixes [YOCTO #2808] Updated the figure per Paul Eggleton's feedback to be clearer. The figure resides in both the ref-manual and the mega-manual. (From yocto-docs rev: 8a0f391c9404582b3b7f62d740d5c0488a6220be) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, mega-manual: New section on package creationScott Rifenbark2013-08-261-0/+0
| | | | | | | | | | | | | | Fixes [YOCTO #2808] Added a new section to the expanded discussion on how builds are done. This section is on package creation. A new figure was added to both the ref-manual and mega-manual figures directories. (From yocto-docs rev: e31e5aeb7d93f3cfa4fc9c12e324f03a27b5f8ed) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, mega-manual: new section on config/compile for expanded buildScott Rifenbark2013-08-261-0/+0
| | | | | | | | | | | | | | Fixes [YOCTO #2808] Added a new section on configuration and compilation for the expanded discussion for the build process. This involved a new figure that had to be added to both the ref-manual and mega-manual figures directories. (From yocto-docs rev: 9ba90c79990b79226d6e95e4a01ddedeccb94b35) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, mega-manual: Updated figuresScott Rifenbark2013-08-261-0/+0
| | | | | | | | | | | | Fixes [YOCTO #2808] Updated a couple figures to be consistent for how directories and their contents are displayed. (From yocto-docs rev: 5a3d08b2543c5ea1f76d65d67bf8a5615f6b5a0e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New section on patching for expanded build processScott Rifenbark2013-08-261-0/+0
| | | | | | | | | | | | | | Fixes [YOCTO #2808] Added a new sub-section to the BitBake section that takes a closer look at the build process. Part of the requirements was a new figure that had to be added to both the ref-manual and the mega-manual figures directories. (From yocto-docs rev: c40476b079cf5765b8228502f0ef33072f8b2b85) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, Makefile: New section on BitBake for expanded buildScott Rifenbark2013-08-261-0/+0
| | | | | | | | | | | | | | | | | | Fixes [YOCTO #2808] Created a new section called "BitBake" that will provide an expanded discussion of the basic YP build process. The "BitBake" section has a new sub-section called "Source Fetching." Part of the new section is a new figure named source-fetching.png. The figure must reside in the "figures" directory in both the ref-manual and the mega-manual. It must also be listed for each of these manuals in the TARBALL statement in the Makefile. (From yocto-docs rev: 41eff3e755a98ff31cadccfb1cd7dfcf569b4d9e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, mega-manual, Makefile: Updates to expanded dev sectionScott Rifenbark2013-08-133-0/+0
| | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #2808] Applied review comments to the "Images" and SDK sections that are part of the "A Closer Look at the Yocto Project Development Environment" section. Comments from Paul. They resulted in a single figure being removed and split into two new figures - one for the image part and one for the sdk part. Some terminology issues were cleaned up in the main sections as well as the documented variables sections. Makefile changes involved adding the two new figures and removing the old combined one. (From yocto-docs rev: a32908fa68b9786e295097c16f70a5a9c3cc4c1e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, mega-manual: New section for images/SDKScott Rifenbark2013-08-131-0/+0
| | | | | | | | | | | | | Fixes [YOCTO #2808] Added a new section for the closer look at how BitBake creates images and the SDK installer files. This included the section itself, a new .PNG figure that had to be added to the figures directory of both the ref-manual and the mega-manual. Finally, the Makefile needed to be edited so that the tarballs for the ref-manual and mega-manual also included the new figure. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* mega-manual: Added five new figures to the figures folderScott Rifenbark2013-08-135-0/+0
| | | | | | | | | New figures for the expanded build section. (From yocto-docs rev: d22d4978a4c0a95744651f97afa0b5c148f0d873) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New section on cross-development toolchains added.Scott Rifenbark2013-06-211-0/+0
| | | | | | | | | | | | | | | First draft of this new section. It included a figure so the figure had to be added to the "figures" folder of the mega-manual. New section introduces concepts behind the types of cross-toolchains YP develops through user commands that build images and build the relocatable SDK. (From yocto-docs rev: b3c9a2e3f90892a2175110393a962fd152316ca6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* mega-manual: Removed support for old kernel-manual.Scott Rifenbark2013-01-301-5/+0
| | | | | | | | | | | No longer including the Yocto Project Kernel Architecture and Use Manual. I removed the lines that included this manual as part of the mega-manual. (From yocto-docs rev: 69fa3cc4a07fc471fc869a81ff2545d62b63286e) 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>
* 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>
* mega-manual: Updated the top-level XML file.Scott Rifenbark2013-01-161-0/+5
| | | | | | | | | | 1. Changed "poky-ref-manual" to "ref-manual" 2. Inserted new lines to support "kernel-dev" manual. (From yocto-docs rev: a134992633572c0b006ae73d47512be89d13ba8e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* mega-manual: Added the title figure for the new kernel-dev book.Scott Rifenbark2013-01-161-0/+0
| | | | | | | (From yocto-docs rev: 7f1fc6b50be882bd73f394f1ebe5f6dc0e3b0c28) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* mega-manual: Fixed to include ref-manual.Scott Rifenbark2013-01-071-10/+10
| | | | | | | | | | this still had the "poky-ref-manual" string in it. It needed the "ref-manual" string. (From yocto-docs rev: f771aaa09bf439e506dc5d8573a34283a1a905fb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: poky-ref-manual, mega-manual, Makefile - new variablesScott Rifenbark2012-12-032-0/+0
| | | | | | | | | | | | | | | | | | | | | | Added variable descriptions for BB_DISKMON_DIRS and BB_DISKMON_WARNINTERVAL. These went in the reference manual in the glossary section. First draft for both descriptions. Also, updated the Makefile to include two new figures used in the Build History section. The figures needed to be added to the TARFILE variable so that the .PNG files are included when publishing both the poky-ref-manual and the mega-manual. Added two figures to the figures directories of the poky-ref-manual and the mega-manual. These figures are part of the new Build History section. Anytime you add a figure to any manual you also have to store it in the figures directory of the mega-manual. (From yocto-docs rev: bbf68ed28ba8660af34d4cae146fb172ca4e681e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - removed the wip.png figureScott Rifenbark2012-10-221-0/+0
| | | | | | | | | | | this figure used to be at the end of the development manual. I have removed it from both figures directories and taken it out of the TARFILE list in the Makefile. (From yocto-docs rev: ad8fcfc4bddb6bcee0e1a4ece78cd87ab0d51b6c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual, mega-manual - removed figureScott Rifenbark2012-10-101-0/+0
| | | | | | | | | | | Removed the "kernel-example-repos-generic.png" file as it describes the bare clone method for kernel modification. We are removing that from this manual. (From yocto-docs rev: c25c4f662c2f8a83fd9b09583646be9dbe01424c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: mega-manual - copied in new kernel flow diagram.Scott Rifenbark2012-10-101-0/+0
| | | | | | | | | | Moved the simpler version of the kernel workflow diagram to the figures folder. (From yocto-docs rev: c856fe320a0e70701f14312439fec6ccb707f9bd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Removed figures no longer needed.Scott Rifenbark2012-10-101-0/+0
| | | | | | | | | | | | | | The figure that shows the bare clone and the copy of the bare clone are no longer needed. The description for the kernel workflow has been reduced to discussing only modification of the temporary source files. We are no longer talking about creating a bare clone and copying it as a way to modify the kernel in this manual. That topic will be described elsewhere. (From yocto-docs rev: f6a25e5e3763ea7a1f8a81ce377e3b520143b852) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Created generic figuresScott Rifenbark2012-10-076-0/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | Each time the kernel revision is bumped (e.g. 3.2 to 3.4) Some of the figures would be out of date. The reason is they had pathnames that included the release of the kernel. For previous YP releases I was adding logic to the Makefile to be sure to catch the right files dependent on the branch from which the documents were being built. This scheme is not scalable so I decided to make the figures generic by adding a note within the figures explaining the place-holder "<x.x>" as part of a pathname. Thus, three new figures were added to the folders directories of the dev-manual and the mega-manual. Correspondingly, the 'denzil' version of the figures were deleted. I modified the Makefile so that if the BRANCH is not edison or denzil then the generic figure set is used. I have to retain the logic for both edison and denzil to cover the case where a user clones or sets up an edison or denzil repo and then builds out the manuals. Basically, it had to be backwards compatible for releases prior to danny. (From yocto-docs rev: 8283eed4b0b9ec164b87db99c35231f8731ac443) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Makefile, dev-manual - Updated kernel example repo figureScott Rifenbark2012-10-072-0/+0
| | | | | | | | | | | | | | | | | | | | Danny, the "kernel-example-repo-<release>.png" file changed to "kernel-example-repo-danny.png". To correctly make the dev-manual and the mega-manual some things needed to change: 1. New figure created and added to both the dev-manual and the mega-manuals figures directory. 2. The "kernel-example-repo-denzil.png" files from the dev-manual and mega-manual figures directory was removed. 3. The Makefile was adjusted so a new BRANCH=danny area now exists to set TARFILES for both dev-manual and mega-manual. (From yocto-docs rev: 8b2ff6b657a1486559799e219baaec9fde2e5c6c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-docs/.gitignore: Final fix to ignore mega-manual.Scott Rifenbark2012-09-042-12646/+0
| | | | | | | | | | I think I got it right this time... sheesh. Had the wrong file suffix in there for the .tgz file. (From yocto-docs rev: d5931252ede475846dcb61fc0e0f03eb7fe4015e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/mega-manual: New mega-manual directoryScott Rifenbark2012-09-0427-0/+13681
This new directory contains the files for the mega-manual HTML document. Mega-manual is a compilation of all the existing YP manuals and guides. It is a single HTML file that simply lists each individual HTML document for the existing YP manuals and guides. The figures directory contains all the figures (duplicated) from the individual manuals and guides. (From yocto-docs rev: 5620c20ea4c7c69c96601b7480471e6166fd9409) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>