Fixes [YOCTO #11630]
Moved the section on BSP Development workflow from the dev-manual
into the bsp-guide. This procedure needs to live in the BSP
guide.
Many links had to be fixed.
(From yocto-docs rev: fbf06240f83221929aea237660146e0076207f6a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
I moved the "Workflows" section to the ref-manual. This section is
primarily concepts and needs to be out of the dev-manual, which
is being reconstituted into a "how-to" manual.
(From yocto-docs rev: 2f8bfaac3da9e2d7042ea381a3e8957f96b5bf5a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The "Yocto Project Source Repositories" section is purely conceptual
and thus does not belong in the reconstituted dev-manual, which is
converting to a "how-to" manual. I have moved this section to the
ref-manual under "The Yocto Project Development Environment" section.
Moving the section affected several things. Three figures that where
in the dev-manual were copied and moved to the figures folder of the
ref-manual. This required deleting them from the dev-manual and
adding them to the ref-manual.
The makefile had to be edited to move those figures into the ref-manual
and delete them from the latest version of the dev-manual in order for
the tarball of files to be correct when the manuals are made.
Links to anchors within the moved section had to be fixed in various
manuals. Links to the main section "id" had to be fixed to point
to the ref-manual manual.
(From yocto-docs rev: c619ae2bbc6be93cb0324ca44e936eefec12b28c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This figure was a bit out of date. I updated a few of the file
names. Figure needs to reside in the Figures folder of both the
dev-manual and the mega-manual.
(From yocto-docs rev: 1e76477810b6be095f9ca190c9a8f0276ee4b8f9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Did the following:
* Added the devtool upgrade flow to the SDK manual.
* Removed the devtool Quick Reference from the dev-manual and
added it as a new chapter to the ref-manual.
* Made sure all the links and cross-references work now with the
moved material.
* Updated the Make file so that the manual set builds correctly
regarding the new chapter in the ref-manual.
* Created cross-referencing notes in both the sdk-manual and the
dev-manual to the newly located devtool Quick Reference chapter.
(From yocto-docs rev: fda0bf68b3654b1b96407d552c5254657465b5fc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the figure to use the new devtool finish command. Also
updated the text to provide an approprite description.
(From yocto-docs rev: b26ee800e457a84fe45ecf031cb94f65c38d05f5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the devtool add and devtool modify flow diagrams and
supporting text to exactly match those from the SDK manual.
Also, updated the help output generated from the devtool --help
and devtool add --help commands.
(From yocto-docs rev: 002297a8ed3979f012fe228b7edb77514e7528a2)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Created a new figure for the devtool upgrade flow. Put the figure
in the "figures" folder of the dev-manual and the mega-manual.
Updated the Makefile to include the new figure when creating
Tarball of the dev-manual and the mega-manual.
(From yocto-docs rev: 4b504f6f179ca7c7e9a69f23fc25b1f33ced8e44)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made some review changes to the workflow structure, devtool
add flow, and devtool modify flow diagrams.
(From yocto-docs rev: f432d9b0270615974e67a0cc243560fdbfa44724)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
dev-manual: I did not have the checksum figure there or the sources
directory.
mega-manual: Per normal, had to copy the updated figure into the
figures directory of the mega-manual.
(From yocto-docs rev: d6fb3373b2f3c1e89da87d3e8b9877e643f73c8e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Created a new figure for devtool add flow. Added support
for it in the Makefile. The figure, as usual, needs to
reside in the figures directory in both the dev-manual and
the mega-manual.
(From yocto-docs rev: 2040a31b806fdade060f7a4182a09673b76db7b3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Completed draft of the new devtool material. This commit affects
some linking and figures across the YP doc set.
* Added the build-workspace-directory.png file to both the
dev-manual and the mega-manual.
* Updated the Makefile to include the new figure in the TARFILE
for dev-manual and mega-manual.
* Re-did the section organization to pull the quilt and finding
source file out of the "Modifying Source Files" section.
(From yocto-docs rev: 4585b9fbb1636ae3c65e2e3ad2d1d6baca636e59)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was a sample string in this tree that ended in "ro" when it
should have been "r0" (as in release 0). Anytime you update a figure,
the modified file must go in both the "figures" directory of both
the manual (dev-manual in this case) and in the mega-manual.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 8e75cc23fbf03f355fade416a12b7c8fe1e656a5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The figure had a wrong box label in the right-bottom box.
I changed it to be like a local Git repository area as it should
be.
(From yocto-docs rev: 2963152decb2d3983180a0af9896e822c865f5cd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the recipe creation figure. I had to re-order the flow
and also generalize the supporting services installation part of the
diagram.
Fleshed out the "Fecthing" section with SRC_URI examples and much
more detail.
(From yocto-docs rev: 6a23ab2beb90376c11c426ac8bf5618994585a9d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: c031c014bae6d6e4a239a4bcd1e8b9d5d272f851)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Created a new figure for the flow. This involved putting the figure
into the "Figures" directory of both the dev-manual and the mega-manual
and then updating Makefile to include the figure in the TARBALL
variable.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Partial fix for [YOCTO #5368]
Updated the figure to not have the tarball method in there
for setting up poky repo locally. Also, added specific references
to the environment setup scripts.
(From yocto-docs rev: 7c6ececaf8eb987206567077f42213dbe4cdc4f2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Partial fix to [YOCTO #5368]
I updated the workflow so that it does not have the tarball
extraction option to set up local copies of poky and meta-intel.
The figure is housed in dev-manual and mega-manual.
(From yocto-docs rev: d70214d7d348d38b574561339987bd3371167a48)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Figure changed do to how they store images now. Figure needed
a new level in it.
(From yocto-docs rev: a7d9484cc1cbba37231e5238c92cb22099345ec9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Found a couple broken links. Also, noticed the yp-download figure
was out of date. Especially in the Figures folder of the mega-manual.
(From yocto-docs rev: 2e55faca221186d157dd5f77d048f1b2b90d5d91)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
