Commit Graph

34 Commits

Author SHA1 Message Date
Scott Rifenbark c218ec6883 dev-manual: Edits to "Yocto Project Source Repositories" section.
Some minor text editing.  Also, updated two figures to be
more recent.  One for the Index of Releases and one for the
YP Downloads page from the website.  They were very dated.

(From yocto-docs rev: 59255d7c0175a5280239d070ce902079229cf909)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-10 16:20:56 +01:00
Scott Rifenbark 7090cbe2c9 documentation: dev-manual - removed the wip.png figure
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>
2012-10-22 09:49:08 +01:00
Scott Rifenbark 3108942c6d documentation: dev-manual, mega-manual - removed figure
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>
2012-10-10 15:18:13 +01:00
Scott Rifenbark 0bd73012ee documentation: dev-manual, bsp-guide, kernel-manual - kernel workflow
The kernel workflow section was re-written to reflect that the
kernel appendix has been removed.  Also, changes to the flow in
general no longer make reference to the bare clone and the copy
of the bare clone as a method used to modify the kernel.

Many links were modified in other manuals as well.

(From yocto-docs rev: 38adbcb00d4305029cfa94e5ef047da41823f021)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-10 15:18:12 +01:00
Scott Rifenbark 8461d4ad85 documentation: dev-manual - Removed figures no longer needed.
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>
2012-10-10 15:18:12 +01:00
Scott Rifenbark 6d5e8360ca documentation: dev-manual - Created generic figures
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>
2012-10-07 13:15:36 +01:00
Scott Rifenbark 4364f11ae3 documentation: Makefile, dev-manual - Updated kernel example repo figure
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>
2012-10-07 13:15:35 +01:00
Scott Rifenbark 48d3b058d9 documentation: dev-manual - Updated BSP flow overview.
This section now points into the BSP Guide where it talks
about using the yocto-bsp script to create a BSP.  The prior
method was by hand and described in an appendix (A) of the
YP Development Manual.

FYI - this results in the removal of Appendex A in a future
commit.

(From yocto-docs rev: 5e1c44b1768b79dd1447ea47461b84248bd2111f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-04 14:08:19 +01:00
Scott Rifenbark 2685ff4fbd documentation: dev-manual - Updated the Application Dev figure.
Added information in the #4 box to include the cross-dev
toolchain.

(From yocto-docs rev: 198ab4326369d8c74225d9de51bf536621ab2251)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-02 17:41:33 +01:00
Scott Rifenbark fc50139a1a documentation: dev-manual - updated kernel flow figure.
I made this more accurate by including notes to edit the
source and use of menuconfig within the diagram.

(From yocto-docs rev: 91d3d2e935aab24c4bd96c5921a605cbbb7e3231)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-02 17:41:31 +01:00
Scott Rifenbark d4a65ef1df documentation: Title changes
Removed "The" from all the titles of the books.  This makes it easier
to reference to them and easier for the automated processing of the
mega-manual.

(From yocto-docs rev: af566d6d007cff642648698ea487a6eeaa8cc930)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:54:59 +01:00
Scott Rifenbark db3de06a01 documentation/dev-manual: New figure just for denzil
New image needed for Denzil.  I created a new file named
"kernel-example-repos-denzil.png" and copied it to the
Figures folder.  I also deleted the
"kernel-example-repos.png" image.

(From yocto-docs rev: 97105187735c15e452580a0174897517c1860f2c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-05-01 20:50:52 +01:00
Scott Rifenbark 065d5e3ee9 documentation/dev-manual/figures/kernel-overview-3.png: Removed file
This file was replaced by a release-specific file named
"kernel-overview-3-denzil.

(From yocto-docs rev: 85220f16ce10086372f9d81c61cb4e3eb40d52e4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-05-01 20:50:48 +01:00
Scott Rifenbark ab62371795 documentation: release-specific figure needed for denzil in dev-manual
dev-manual/dev-manual-model.xml:  The Bare Clone and Copy of the Bare
Clone figures are out of date for denzil.  These needed to be
re-done so they use "linux-yocto-3.2.git" and "my-linux-yocto-3.0-work"
as the root names.  This presents a Makefile issue when making the
denzil and pre-denzil versions of the manuals.  Whenever you use a
different figure for a different release, you need to involve the
BRANCH variable in the Makefile.  This is necessary because you are
using different figures in the generated tarballs.  The set of figures
could be unique to the release.  The outdated figure is
"kernel-overview-3.png" and will eventually be removed (later commit).
I created a new figure named "kernel-overview-3-denzil.png" and used
that in the dev-manual-model.xml file.

documentation/Makefile:  I updated the Makefile to test for a
"denzil" release build and if so include the new file in the
generated tarball.  This commit adds the new .PNG file as well.
Fixed the Makefile so that if you don't supply a BRANCH value, it
uses the latest figures (denzil).

(From yocto-docs rev: b3550d7640343cd5459efb04c591b81a1e41bc1b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-05-01 20:50:48 +01:00
Scott Rifenbark 01f046780f documentation/dev-manual/figures/kernel-example-repos.png: update figure
The figure that shows the kernel repos needed the git push
command fixed.  There was no ":" character in it.

(From yocto-docs rev: 4add1c83a8e3f4fec9ec6b678e31e259c700c077)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:39 -08:00
Scott Rifenbark e26a00d262 documentation/dev-manual: Updates to index of releases
Had to update the figure again and I updated the surrounding
text.

(From yocto-docs rev: ed0aea8ad3670aace1eb51ca7a72e75a4c129fba)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:39 -08:00
Scott Rifenbark 4f913c67ba documentation/dev-manual/figures/index-downloads.png: updated picture
Updated the picture that shows the index of releases.  they renamed
this from index of downloads.

(From yocto-docs rev: 38ffbb3138fa43fcb44456e6b6f46dc78cc87a14)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:39 -08:00
Scott Rifenbark a5f400cd93 documentation/dev-manual/figures/git-workflow.png: Updated figure flow
The Git Workflow was missing a pull line from the second (bottom) contrib
box into the project's master Git repository.  I added the line.

(From yocto-docs rev: e7e2f92a92cec3798395470595ba1a2beaf36575)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:37 -08:00
Scott Rifenbark 57e780f915 documentation/dev-manual: Bruce Ashfield's dev-manual comments added.
I was not able to get to Bruce's comments he submitted to me for the
"Model" chapter of the development manual.  His comments consisted of
various tweaks to terminology I used and the inclusion of some additional
technical information.  This commit addresses all his comments for
the review.

(From yocto-docs rev: 206a22e1ccf077360974f18295b6df455cd50545)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-31 22:37:08 +00:00
Scott Rifenbark 05f67cebfa documentation/dev-manual/figures/kernel-example-repos.png: updated figure
Changed the pathnames for kernel 3.0 from 2.37

(From yocto-docs rev: 220ce5fbb3663940b5940445190d30d98f58a438)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-06 18:46:55 +01:00
Scott Rifenbark 68b9f1677c documentation/dev-manual/figures/wip.png: new figure added.
(From yocto-docs rev: f373d2b9f3530e31dc84b9333cfef93cdfd2c5e2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 23:12:07 +01:00
Scott Rifenbark 44963bdddd documentation/dev-manual/figures/app-dev-flow.png: Updated app flow image
(From yocto-docs rev: 5c0c04ccc2d1fdac89dc1394805e4b8c4cc2c082)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-25 17:59:59 +01:00
Scott Rifenbark 42c80283e2 documentation/dev-manual: model changes and updated figure
Edits to the dev-manual-model.xml chapter for general improvements.
Also had to update the figure that shows the kernel development flow.

(From yocto-docs rev: 2aacccb03d167eac74a1b45c39a9edac160efc7f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-25 17:59:59 +01:00
Scott Rifenbark f3cb36b751 documentation/dev-manual/figures: Three figures for kernel added.
these are new figures to support the "Modifying the Kernel" conceptual
section.

(From yocto-docs rev: 1a0ecc104479b54a8122e3de2b30694fac8d7e73)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-02 23:38:49 +01:00
Scott Rifenbark 8165eefb1f documentation/dev-manual/figures: Figure updates
Not sure if I need to commit these again.  They are showing up in the
git status command so I might have updated them and forgot to commit
them.  Doing so to be sure.

(From yocto-docs rev: 75c87592c10647ec09f42a1363a8ae123cd6e33d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:46:38 -07:00
Scott Rifenbark d328082279 documentation/dev-manual/figures/kernel-example-repos.png: new figure
This figure provides a conceptual look at the repos and file structures
needed to run the example.  Or, for that matter, to get set up to
modify the kernel.

(From yocto-docs rev: d469449f1d416a6a96bdde297daae68a9f3094e5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-15 15:27:00 +01:00
Scott Rifenbark 12afc63888 documentation/dev-manual/figures/bsp-dev-flow.png: Updated BSP flow diagram.
(From yocto-docs rev: 4dc246fa368f35efa93ff88f323ca433abe096da)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-15 15:26:56 +01:00
Scott Rifenbark 9e5890d900 documentation/dev-manual/figures/bsp-dev-flow.png: Updated picture
New flow suggested by Dave Stewart.

(From yocto-docs rev: 101a464f0f17f3816bfb32f6e3a5da714cc32a06)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:07:52 +01:00
Scott Rifenbark e3687ca853 documentation/dev-manual/figures: Added three figures for sources
(From yocto-docs rev: 956f3d8a35a89caff40531690cdd51fd33b534d2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:07:52 +01:00
Scott Rifenbark ce9a0c1513 documentation/dev-manual/figures/bsp-dev-flow.png: Updated figure
(From yocto-docs rev: 8bf534dc43433032998f6e59bd35c923f1c7bd47)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:07:50 +01:00
Scott Rifenbark fe51c0d7ce documentation/dev-manual/figures/bsp-dev-flow.png: Updated the figure.
(From yocto-docs rev: 48718ed82ea5b7aac57c9f566caef5abcf67db20)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:06:49 +01:00
Scott Rifenbark 0fbbadb56c documentation/dev-manual/figures/bsp-dev-flow.png: New illustration
This is the BSP flow illustration.

(From yocto-docs rev: 82ec8528c058d702402767ffa471695eb82e259c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:06:49 +01:00
Scott Rifenbark 6efaa95758 documentation/dev-manual/figures/dev-title.png: Initial file created. (From yocto-docs rev: dd336b3d12586661d30f6d22d709031266cf7ed2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:21 +01:00
Scott Rifenbark 3b76aa4b49 documentation/dev-manual: Added top-level directory for Dev Manual. (From yocto-docs rev: d85283b6c1d939909c46f94750e4ff36ee42cadb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:21 +01:00