Updated two instances of "sysroot-components" to
"sysroots-components".
(From yocto-docs rev: 035be964e6f345c058c1dacbb58b09745e8f827d)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
WIP at this point.
(From yocto-docs rev: 12e44f6ee7f9437d85c33d0789dbafe937af5664)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the step to include proper links and verbiage for
setting up the system for YP development.
(From yocto-docs rev: d5d908847d66178a995d2be985c605e6a5c48d76)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The dev-manual had a place-holder section for getting the
build host ready for using YP and then doing kernel
development. This stuff is better suited for the actual
kernel development manual. I moved the section. Moving
created several broken links in the manual set that had to
be fixed.
In the dev-manual, I updated the introductory list to include
the newly moved kernel stuff.
(From yocto-docs rev: 2e21260bb5f84e9e30eb353ec841d5962e8a7642)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The figure "figures/kernel-overview-2-generic.png" was missing
the ".png" suffix in the TARFILES statment. This was throwing
an error during the make process for the manual. Probably an
error for quite some time and not noticed. I added the suffix
to remove the make early exit error.
(From yocto-docs rev: 00ad7874f8da149f193caeab8fd89bbf6d8132d7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I moved the section on preparing a build host to use the
Eclipse IDE and placed it as introductory text for the
section that talks about getting the system ready for either
native Linux or CROPS use to use YP.
I also created as part of that list, links to the BSP manual
where I now talk about getting the system ready for BSP
development.
(From yocto-docs rev: f5b5d27ea5036792a96c0a42a3d7513a2a57a4b0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The YP Development Manual had some build host preparation steps
as part of the chapter that talks about getting a host ready
for using YP. These steps are better suited in the BSP Guide.
I moved them there and filled out the steps to be more complete.
(From yocto-docs rev: 2277812d0dd411a103a4a4252d4cb90c471901c9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Moved the "Patching the Kernel" section, which was in the
dev-manual to the kernel-dev manual. During the move,
renamed the section to "Using devtool to Patch the Kernel".
This move bothered a lot of links so I had to fix them in
various manuals.
(From yocto-docs rev: a000be1eddf33e4d7de8f350e076d48e27ca4b98)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The steps needed updated to reflect the introduction of CROPS
as a way to prepare a build host.
(From yocto-docs rev: 8f52372afad4c32d0b895a88c2298625e7f53da3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These references now go to the ref-manual and not the
dev-manual.
(From yocto-docs rev: e58681488c307ba1daf2e10423e56b7d3ec486b8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
With the introduction of CROPS as a way to set up the build
system, I had to alter the first bullet of the BSP workflow
list and the figure.
(From yocto-docs rev: f1db3db4053142619c62629d4b05023f0b148e6c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Now that we have CROPS as an option, the step for preparing
your build host is condenced to include cloning poky. This
resulted in removal of step 2 and updating of the figure.
(From yocto-docs rev: 903d1f98b736a744de1d9c973f7a96b6a92049b5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section failed to mention the "yocto-layer create" script,
which is a simple way to create a layer. I have added this info
into the section by way of a "Tip" box.
(From yocto-docs rev: cf204f2b72b1da0104315f54cfe55c3f1eaf0f96)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Replaced "recipe_work_directory" with "${WORKDIR}"
throughout the section.
(From yocto-docs rev: a961cf07cd18d06e0c6399a10dc40c0d4143c23f)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated text for sysroot terminology, and clarity.
Fixed a capitalization error.
(From yocto-docs rev: 4eea6497663efc937cddf4700298f5824ade7b47)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section on recipe syntax that was buried in the creating a
new recipe section was really a reference on syntax. I have moved
it to the ref-manual.
(From yocto-docs rev: cb55d1b5832cca6faa6e2a5b26f3add3032cade2)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section about following best practices was more of a reference
section the way it was written. I recast the section and the
sub-sections such that it is a list of items to consider.
Also renamed the section to be more of an action section rather
than passive.
(From yocto-docs rev: 8b050a46c67a3d3e89d905cf028eec6ae370388a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I did some rewriting for clarity in the "Using .bbappend Files
in Your Layer" section. The section needed to be retitled so
focus on the layer aspect of .bbappend files. Also, while I
was in there, I did more work on the prose in general.
Also had to fix some links in the bsp, kernel, and ref manuals
that linked into the section whose name I changes.
(From yocto-docs rev: a82bcc9fe0f909135434ee1bd36b4414f6c046c9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the wording to note that the steps are how to create
a layer without the aid of steps (i.e. by hand).
(From yocto-docs rev: 81800fa9ba0dd9ff439a43b286981eea51d4c87f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This style allows a writer to use the <para role='writernotes'>
tag to have text in the paragraph render in red.
(From yocto-docs rev: 65bb4edcd0a58ea8e17f28f9f5c13e2898c22745)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Because the YP development introductory information was moved to
the ref-manual, and the QS will get a CROPS section inserted,
the introductory section of the QS needed to be updated a bit.
(From yocto-docs rev: e173b762a74678cd660850e4f5bc28712c3d83ac)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The introductory stuff in the QS is really conceptual information and
needs to be in the ref-manual where YP is introduced. Regarding the
QS, all we really need to do is point to places where the reader can
go to find that stuff out.
Part of this move involved getting the diagram of the YP flow for
the environment from the QS to the ref-manual. That figure was
named "YP-flow-diagram.png". It was named "yocto-environment.png"
in the QS but I renamed it when moving it to the ref-manual. This
caused some edits to the "Makefile" to clean up the figure lists
for tarballs.
(From yocto-docs rev: ab108c0959e3a9f36d25080245482f8a790c8c87)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Replaced "python34-pip" package with "python3-pip"
in the list of required packages for CentOS' variable.
(From yocto-docs rev: 5d48ea7953169b4392d6caf0fb8f2f952479f033)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed duplicated package, "which" in list of
required packages for Fedora's variable.
(From yocto-docs rev: e016735fe7ef0d866d44df1100597ab3f3af7d5f)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The minimum version of tar is now 1.27. This was changed in both
the yocto-project-qs and ref-manual.
(From yocto-docs rev: b0fe513e08de860e94a3617fd62382430e321c77)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
At the end of the section that describes how to set up the
development machine for CROPS, I added some user links for more
information based on the type of container the use is interested
in.
(From yocto-docs rev: 6888d8454839bbb2ecdf96ce421c7d8723931d65)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Added content for steps to set up a native Linux host for using
the Yocto Project.
(From yocto-docs rev: d8a18d382c584dbdfa7f5f190a92cc7cde0f9601)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
I took the section that described how to use a pre-built kernel
and run it through QEMU out. This is basically a QEMU usage
section and is not in that area. There were some QEMU speed
up items suitable for the QEMU concepts section in the ref-manual.
I put those in that area.
(From yocto-docs rev: b081013aa10b42e4eb88ed54940112c5ae106911)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
I converted the QEMU section to a procedure. Also took the
tips section and created individual sections from that.
Cleaned up some areas in the QEMU conceptual section in the
ref-manual
(From yocto-docs rev: dfd3466be605fdd7438653bf54fd0df3594a5c50)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The dev-manual had a section on QEMU that combined a lot of
reference information and usage information. I took the reference
information out and moved it to the ref-manual into a new section
in the second chapter, "Using YP".
(From yocto-docs rev: 188596c576e357925383d0cc3bd2b0cdf41926ec)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section needed to be a step-by-step procedure.
(From yocto-docs rev: de4868c97c1199b39b3c3e68b4ff159f6546cd9e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section "Locating Pre-Built SDK Installers" was turned into
a procedure. I also added some information on the actual names
of the *.sh files.
(From yocto-docs rev: 548886d5a392164783596c0c04779aaffd6ac930)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated manual descriptions to fit current
manual structures.
(From yocto-docs rev: 81d8add49fd09deef432d9a0cc08c9f380c671ed)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11715]
Replaced all instances of MinnowBoard MAX with
MinnowBoard Turbot.
Updated Welcome section to include links to key
sections of quick start.
(From yocto-docs rev: ed55dcd80ef5edddacb2d288e0a6cbe85dccf964)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I did a rewrite of the section to get it into a procedural form.
Missing some technical information and needs a review but it is
the best that can be done at this time. The code for initrd is
not settled.
(From yocto-docs rev: 0fdef8c5fed6ac510d1604a677e6546494b4c96b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The description suggested the reader see the
meta/poky/conf/local.conf.sample.extended file for more understanding
on INITRAMFS_IMAGE. The actual file is
meta-poky/conf/local.conf.sample.extended.
(From yocto-docs rev: 80b474d3417e88a47d1317b2af6552698e907b80)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a figure for this simple build workflow that uses
BitBake from a Linux host. Also did a bit of re-writing.
A new figure was introduced so the Makefile had to be adjusted
to include that figure. The figure resides in the figures
directory of both the dev-manual and the mega-manual.
(From yocto-docs rev: c3b0b1d53f551c02202cef80a8a48dd24576b975)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The author of the book was still Intel Corporation. This
needs removed. I replaced it with "Scotty's Documentation
Services, Inc.".
(From yocto-docs rev: 14f1df18210a3dcb4b7174ddcad551aa9141696d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The section on the devtool workflow in the dev-manual was 99%
identical to what was in the sdk-manual. I have moved the
workflow procedure from the old "Model" chapter of the dev-manual
to be merged with what was in the sdk-manual. In truth, the
only things added were a note about devtool not being exclusive
to SDK development.
The result of moving (deleting) this section was that the "model"
chapter of the dev-manual went away. The devtool stuff, Quilt,
devshell, and python shell are all out now and there is no
chapter left. So, mega-manual had to be adjusted to not pull that
chapter in when building the dev-manual. I had to delete three
figures that were used in the flow. The figures were already
replicated in the sdk-manual. The figures were deleted from the
figures folder of both the dev-manual and the mega-manual.
I had to make sure all references to the old devtool stuf in the
YP doc set were adjusted.
(From yocto-docs rev: 5dbd643d31ab502df53a22229e457a03da7772b7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
These two sections can stand alone as tasks. I moved them to the
"Common Tasks" chapter.
(From yocto-docs rev: 60c810a9682f8a110fe7c7e4d0d40583a7d72735)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The section on useing Quilt can be a stand-alone task. I moved
it to the "Common Tasks" chapter.
(From yocto-docs rev: bb84b88fc8fc7f82e7bbe580d408ae7880f38d8b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
This section can stand as a separate task. I have moved it to the
Common Tasks chapter.
(From yocto-docs rev: e4fb1ce8b160528aae0f192add614a595b2560a3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some general cleanup and formatting.
(From yocto-docs rev: 8d4458f8fbe02cb8bfa78cbf18726cdd8126850a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The overview section of modifying the kernel needed to be in the
kernel-dev manual and not in the dev-manual. I moved it and took
care of all the links and external references throughout the YP
doc set. One figure was involved that had to be moved to the figures
folder in kernel-dev from dev-manual. That is why the Makefile had
to be edited.
(From yocto-docs rev: 3a704b64544678785b883f82d6e82aedac6790c5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11731]
Updated examples to so they checkout by tag rather
than by branch name.
(From yocto-docs rev: 9dca9fdc315998612f4cd5c9c69e2b3e045562ad)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New variable: METAINTELVERSION and META_INTEL_REL_TAG
and DISTRO_REL_TAG
(From yocto-docs rev: f8be6ea137df9b5964e2cc3fed43cda39a3d27ec)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The section that presented the Yocto Linux kernel file structure
resulting from a build using BitBake needed to be in the kernel-dev
manual. I moved it over. This required transferring over a
figure as well.
(From yocto-docs rev: 0abc6c7d87a6aa10dac28fefbb280eb51fea61a7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section in Appepndix A was full of redundancies used to
explain how the Yocto Project kernel development team has set
up branching and kernel architecture. I consolidated a couple
sub-sections into just the necessary single section.
(From yocto-docs rev: e42efe28aec6bad3779c4b9ea58941272fb01651)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Appendix A of the kernel-dev had a subsection dedicated to just
saying Git was the SCM used by the YP team for development. Having
this information in a dedicated section was overkill. The information
is better as an "aside". I put the stuff in a note.
(From yocto-docs rev: 7e28686f946188daaf0480d4cd68e0e8ff854d37)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The information in the dev-manual kernel overview area really neeeds
to be in the Appendix on kernel structure in the kernel-dev manual.
I moved that informtaion to the appendix. Removal of one redundant
image was necessary from the dev-manual. The figure was literally
repeated in the kernel manual already under a different file name.
(From yocto-docs rev: 00ca68e760e41448c225fb1ca4a77f5201434b93)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
I took the Yocto Linux kernel overview list of kernels out of the
dev-manual and moved them to the "Yocto Project Kernel Development
and Maintenance" section in Appendix A of the kernel-dev manual.
This is a much more logical area to introduce this type of Yocto
Linux kernel information.
(From yocto-docs rev: 0a5154cb4c23697f2b8e2341c8e1dc07362443d2)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Took the small reference section out for developing an image
using toaster. This was just a pointer to the toaster manual.
(From yocto-docs rev: 8dcce4411aaa5d1d8fe2c809166a947d0e38a97b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
This section simply pointed to the SDK manual. Does not
need to be in the new "how-to" form of the dev-manual.
(From yocto-docs rev: 1cd842a323ba09ef69e14f56dca1c2a5576252ee)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I put in some edits to be very clear on the state of the files
for the user when they check out by tag.
(From yocto-docs rev: 622d324e7f167f55a5de86ec7af65d7554f2aec8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Re-wordings to be clear about what the user is getting when
they check out a development branch of an upstream repository.
(From yocto-docs rev: deb6ecfd35a76760bc2270bbbc69aa232b0c8cc7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Clarified wording so reader understands they are checking
out the master branch by default.
(From yocto-docs rev: d1e77fff752d9960120340601bc2520c51c4f073)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Manual style dictates use of bold lead-ins for a numbered list.
(From yocto-docs rev: 32469dc0d61d755d0119a0374070221b0bd4bdfb)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Manual list style requires steps to have bold lead-ins.
(From yocto-docs rev: 2d226cf6710853f7be8f0c3bd8b1eea72cb4eb7f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Formatting style need bold lead-ins for steps.
(From yocto-docs rev: b75337188e2346dd40004e22b45a2975f1d4cff3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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]
Moved this section from the "Getting Started with the Yocto
Project" section. The topic is not really a getting started
topic. It is better suited in the "Common Tasks" chapter.
(From yocto-docs rev: d6cdade9066bdbce0596672978c178d2ec82c9a4)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
I re-wrote the "Building Images" section into a "Performing
a Simple Build" section. A single link in the common tasks
chapter was affected by the section name change.
(From yocto-docs rev: de5a4cfa4f63538fe0a5ec0c2aacfb9222b70c4b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Was referencing the "Building Images" section when should have
been referencing the "Images" section in the ref-manual.
(From yocto-docs rev: 7340b358d57c110240e75c1164226144065120b7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The chapter on setting up YP has been completely re-written to
move towards a "how-to" manual. This involved touching every
aspect of the chapter. All subsections now have procedures
surrounding set up stuff. There are some development sections that
still need fleshed out.
Many, many links and references in other chapters were affected.
These have been fixed.
A couple style-sheet (*.css) files were also updated to support the
"writernotes" style, which renders paragraph text in red.
(From yocto-docs rev: c4c2a6cf575ce5c783b1cc84d9f7e961aebef49c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Added a new procedure section for using the Downloads page from
the YP website.
(From yocto-docs rev: 7efb29dfa7a0960710ca7cf3983048f166c6a13f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This addition allows an author to use the following form to
highlight a paragraph in red.
<para role="writernotes">
Blah Blah Blah
</para>
(From yocto-docs rev: 40d646229e5ec9fa905a372be795120449f9f9dd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
I have added a new procedure on using the Index of Releases area
to get snapshots of various tarballs. I recommend that is not
the way you usually want to get files as using Git is recommended.
The section exists for completeness.
In the ref-manual, I cross-reference the procedures from the
associated conceptual areas.
(From yocto-docs rev: 812f344966966591d883fbebb4ae1f72c11dd483)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
I created a new procedure for locating and viewing YP source
repositories using the GUI-based method. Created an anchor in the
ref-manual so I could reference the 'git clone' command.
(From yocto-docs rev: 2ae28682407039420f4fcca71a298e1dd34c81f0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
To move toward a "how-to" dev-manual, I am consolidating procedures
for locating and establishing local copies of YP source files into
a single heading. I set up a "Working With Yocto Project Source
Files" section. This will contain sub-sections to find the various
areas of YP files and how to clone and check out stuff.
(From yocto-docs rev: 87ff4ee41a50e8aed6b9c5402c51bb47f5a252a3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This material was being replicated across the Quick Start,
dev-manual, and ref-manual. I have created a single point in the
ref-manual that collects the disparate information that existed.
I deleted the entire section in the dev-manual since that book
is converting to a procedure manual and the very front of the manual
adequately mentions YP and provides pointers to where the user can
get more information.
The QS provides a more complete introduction of YP since it is a
QS.
(From yocto-docs rev: bd8093417af2d93556410d5482dad32c11a0a964)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11699]
Configuration example didn't work with "" around
baseurl. Removed "".
(From yocto-docs rev: c40d818fb92904b74e677749ee16c52716dd02a9)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added detail to the procedure about pushing a change to a
contrib directory and then requesting a pull using the scripts.
More detailed with examples.
Also, clarified some wording in the section about submitting a
patch through email.
(From yocto-docs rev: 76a358ba588b0f36d14aef0a68efe30c4e16746a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Example was incorrect. Fixed it.
(From yocto-docs rev: 7ae1c636e7a8c0448515f339476327bcaf21e63c)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
I updated both the introductory sections of the ref-manual and the
dev-manual. These need to work more tightly with the projected
YP documentation set.
(From yocto-docs rev: 6a28537d03fad8a53198edc7f9a6229f4e58e551)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I want this first section to be titled "Welcome" rahter than
"Introduction." It is more in line with the YP QS and the YP
ref manual.
(From yocto-docs rev: 113b82c589c93a33a2a956790668e8c0a28894ec)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I moved the bit about using a VM if you don't have a Linux
machine to a note as it broke the natural flow of this section.
Also, inserted a link to the comprehensive list of links and
other documentation references to the existing list of
other information.
(From yocto-docs rev: 73750063580ef7bc20bd445adc3e2b0b01e2257f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I changed from "Pah-key" to "Pah-kee", which is more universal
and also matched what is used in the dev-manual terms section.
(From yocto-docs rev: 843e832f2416b0e3b0e9d941bf7755f206517603)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
I changed the section heading for the section that describes how
to make a change to the YP. It was passive. I need it to be
active and in line with the "how-to" dev-manual.
(From yocto-docs rev: 340e1b6ab9806ec11ec894d4472bc2c937c2b058)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Extensively updated the development environment section by
creating a task-oriented section.
(From yocto-docs rev: d440f0b5ceb1aca57a73d8bced515ae0bd3188f7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The section on how to submit a change was pretty much a procedure
section. I did some rewriting to make it more that way.
(From yocto-docs rev: d7edce9268ee5cae96c09c79fe34d5d2dbb701e0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I discovered a mis-placed block of DocBook text that was
causing the string "bug-id" to appear in a random spot in the
"Patch Submission Details" section. Re-ording this block
fixed the problem.
(From yocto-docs rev: 6cf0e8ff0d2b176c1faf492c7bdd7d38e23e4c98)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
OE native script now requires a native tool as part
of the command line. I added that to the example.
Removed a bad help command at the end of the section.
(From yocto-docs rev: 5eb965ea51d669ee3bac01050b42bee984572199)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The list of supported kernels was out of date.
Edited with updated information.
(From yocto-docs rev: b287f76905637834ec6342285b99abd2c5594597)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
This new section has three new procedures for now: 1)
cloning the poky repository, 2) checking out a branch
based on an upstream repository branch name, and 3)
checking out a branch based on an upstream tag name.
More to be added for other key repositories.
(From yocto-docs rev: 4cbcd952ba395b19be5374470a95630a4bc6ffa7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied some formatting and some links
(From yocto-docs rev: a0881588fcf2314b6d7bcbfb7ee9b9d4d7a2ef2c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The "Git" section in the dev-manual is really about concepts.
There are a couple of examples that might or not might be
allowed to ultimately stay. I have moved the section to the
ref-manual. If those examples get replicated in the new
dev-manual, I will update the "Git" section further. For now,
however, these remain in this moved section.
(From yocto-docs rev: 2e4b87fdab29c13ce0d2314e50c93e37404b6f7e)
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>
For development purposes, static libraries need to be
present only in the SDK. We do not need those static
libraries in the image for most scenarios. So, replace
IMAGE_INSTALL with TOOLCHAIN_TARGET_TASK in the documentation.
I updated the note to reflect this.
Suggested-by: Maxin B. John <maxin.john@intel.com>
(From yocto-docs rev: c05458c6614c38961d23db8f894d542bf93dbf09)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Moved the "Licenses" section from the dev-manual to the ref-manual.
The information in the section is purely reference material and
does not belong in the dev-manual, which is being reconstructed
as a "how-to" manual.
(From yocto-docs rev: a89cb18f6cab6702a2bf2a0f77d46e64f82b1729)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11579]
I removed the sentence about throwing an error or warning.
(From yocto-docs rev: cfa3b1559122ec9e927ccd34afa0e26e877486f9)
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>
Fixes [YOCTO #11630]
The "Open Source Philosophy" section that was in the dev-manual is
really conceptual reference information and has no place in the
dev-manual, which is being re-written to be a "how-to" manual. I
moved the section into the new "ref-development-environment.xml"
chapter.
No links were affected by this.
(From yocto-docs rev: 0a3e65bf7a23eec6e36a3cda3c2011b70aef325b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The ref-manual needs expansion for the old "closer-look" chapter.
This chapter previously held a detailed look at what happens when
a user uses the YP to develop something. Now, the chapter needs
to also contain YP development environment concepts (e.g. open-
source philosophy, etc.), which are coming from the dev-manual.
Because of this, I renamed the "closer-look.xml" chapter to be
"ref-development-environment.xml". I also renamed the larger
section that was formerly the entire chapter into its own section
named "Development Concepts".
Both these changes caused a few links to break. I fixed all the
links from within the various manuals so they would find appropriate
targets.
I did some re-writing for introductory material to introduce the new
chapter and the section on "Development Concepts".
A new file ("ref-development-environment.xml") was added by basically
renaming the "closer-look.xml" chapter. And, the tracking for
"closer-look.xml" was deleted.
(From yocto-docs rev: e37806474578b4f0ed137f64d68a39a17ab60644)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I made some changes to better introduce this reference manual.
Clarified the best scenario for using the manual. Removed the
long list of manual descriptions as that can be referenced further
down in the manual.
(From yocto-docs rev: 8f4555aa387ab3bd3f90f5fcda1d343811ecc168)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Moving the "Yocto Project Terms" section from dev-manual to
ref-manual broke all the links to the "Source Directory" term.
I fixed them.
(From yocto-docs rev: d3a206b141e0b0c623362622ec73bbf44118071a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Moving the "Yocto Project Terms" section from the dev-manual to
the ref-manual broke a single link to the "build-system-term"
id. I fixed it.
(From yocto-docs rev: 51bbfbb6030a5298fde1dc0e6f67332cfa59fae2)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Moving the "Yocto Project Terms" section from the dev-manual
to the ref-manual broke the links to the "Metadata" term.
I fixed these.
(From yocto-docs rev: 190da4b4d44952d141db26ca72b5bc1a52d77023)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Moving the "Yocto Project Terms" section from the dev-manual to the
ref-manual broke links for the "cross-development-toolchain" term.
I have fixed these.
(From yocto-docs rev: f2d2b5936bd339d691ab859cbe3df86e3da58f0c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Moving the "Yocto Project Terms" section from the dev-manual to the
ref-manual broke several links to the id "build-directory". I fixed
these to reference into the ref-manual now.
(From yocto-docs rev: debe2ae8ce203ebe0f1cee0de54124c15df8bb7e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Moving the "Yocto Project Terms" section from the dev-manual to
the ref-manual caused many links local to that section to be
incorrect. I scrubbed the section and fixed all the links.
(From yocto-docs rev: 4b795159aa80184f26ff1181a564516840c373b2)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Moving the "Yocto Project Terms" section from the dev-manual to
the ref-manual. Doing so caused all the links to the id
"bitbake-term" to break. These had to be individually fixed.
Discovered two unresolved references that were a consequence of
moving that section to the ref-manual. These were fixed as well.
(From yocto-docs rev: 829ca6b64562f00a69f3956e9636c7edaa90ce16)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The exhaustive list of useful links and references to other
YP documentation existed in the dev-manual. This is not the correct
place for this type of reference information. I have moved that
list to the ref-manual where it should be. The dev-manual now
simply provides a link into that section.
(From yocto-docs rev: eeceb597988134ced85aab4b9ddaeed923f17b03)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Reorganized the way the information about entering bugs using
Bugzilla is arranged in the documentation set. The dev-manual now
has a section that is purely procedural and steps the user through
the process of logging a new bug in the Bugzilla system. The
ref-manual has a conceptual section that introduces the YP
implementation of Bugzilla by simply telling the user what it is
and what what its purpose is.
(From yocto-docs rev: 4bfba345010be7bc2866b819b9754bb06f93c91f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The introductory paragraph for this figure was a cut/paste
problem from previous devtool figures.
(From yocto-docs rev: c02a2a57889bbdcd7e83ab9e2458397189bbb980)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Warning in step 5 indicated the wrong location for config file.
Updated with new location and referenced an illustration to
show an example.
(From yocto-docs rev: e853e5b89f1dbd7399909064b50bc59e06302560)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This paragraph had some links to old stuff. Removed the whole
paragraph.
(From yocto-docs rev: 95c1f348ed018c697cc996bc962787ede056b94b)
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>
I changed the git config file to ~/.gitconfig
(From yocto-docs rev: 0d4f43944b911ee23dd03b5f503173478d6c396d)
Signed-off-by: Scott Rifenbark <scottrif@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section that describes how to create a patch and send it via
email is really an ordered procedure. I recast the list of steps
using numbers instead of bullets.
(From yocto-docs rev: c2d2256ca6d8c8b837bae87a5bd8a3118553935c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11600]
Removed the example. It was not needed.
(From yocto-docs rev: 402bb173b00a665fb55a8f740a4dbe60ead57f25)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11411]
Added a naming convention warning to the native.bbclass description
that is similar to the existing warning used in the description for
the nativesdk.bbclass.
(From yocto-docs rev: 2ceeb5416d439197e94640229e3685ab8b87e0fb)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11600]
"configure" and "cmake" are not do_* tasks of BitBake. I updated
the formatting of these programs and removed links that were to
the tasks in the reference manual.
(From yocto-docs rev: 2605c7378f6b4b49c2e2baaf159fd2c289d83a1a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The figure that Scott Garman used for an old video cast is
much more appealing to the eye than the giant, square beast
the current manual was using. I have replaced the image.
The image is technically the same.
Because the mega-manual has to use a duplicate figure, I
put the new PNG files in the Figures directory for both the
yocto-project-qs and mega-manual books.
(From yocto-docs rev: ed64810e59110418d49fb6d3e61967fa62ab28c8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The YP doc set was using a link to an out-dated video that
showed how to configure and run Eclipse. The video was very
old and Jessica suggested just removing it. So, I replaced
all occurrences of the link to the up-to-date appendix in the
SDK manual that provides information on the latest supported
version of the Eclipse IDE.
(From yocto-docs rev: b4af1a79078352df5558e20c0b9cfa97fa141abc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The link to the section on how to set up Eclipse had been broken
for a while. I fixed the link so that it goes to the appropriate
section (appendix) in the SDK manual.
(From yocto-docs rev: 873c2c53f661b18936595068d75b954e07774621)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated poky.ent to use 2.4 variables and numbering
Updated mega-manual.sed to use "2.4" string for links
Updated all manual revision tables to use "2.4" and
"Usually October, 2017" string.
(From yocto-docs rev: 17ec7da6ab3fd450c2010812f7ad689288b12dcc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11600]
Made some technical corrections to the PACKAGECONFIG_CONFARGS
variable description in the glossary.
(From yocto-docs rev: c422783984748f170943eab418bfa7d0111fa352)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11579]
Added a new description for the LAYERRECOMMENDS variable.
(From yocto-docs rev: 3004a5724c4ea7165e4f749f9c9237ee1fbd89f5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11579]
The syntax for specifying a layer version was incorrect. I
have added an explanation for the correct syntax and provided
an example.
(From yocto-docs rev: 5703fb2f8b9d3df408c596603b8b8416597fc67a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9001]
Updated the image-live class description to specifically mention
creating *.iso and *.hddimg images as "live" images. Provided more
explanation about usage through the NOISO and NOHDD variables.
Also, provided a cross-referencing link back to the updated
image-live class from the EFI_PROVIDERS variable.
(From yocto-docs rev: 788061b2911339c8396b798a0ab5635ab5bb89e1)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11498]
I enhanced the description of the INHERIT variable's glossary
description to provide more detail. I also included a link into the
section of the BB manual where INHERIT is described.
(From yocto-docs rev: 663cde3cf05ebf564ff3a28cd37b696be2f91ad8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This scheme has changed due to recipe-specific sysroots making it
obsolete. Removed the entire section.
(From yocto-docs rev: c52a896829212863402e5532dd8fb7fe4c247fca)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The BB_SETSCENE_VERIFY_FUNCTION2 variable no longer exists. I removed
a link to the BB manual to this variable description, which no
longer exists. Also, removed a paragraph in the discussion around
setscene that talked about the variable.
(From yocto-docs rev: 1f8e3d53ee72c369cb1211332e074976737fd76b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This should be "gdbserver" when referred to generically.
(From yocto-docs rev: 83b2be50e34b0c07cce1f27b55e595752b80b3ea)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These depend on context. In general, "DNF" is the preferred
terminology unless directly referring to an application or such.
(From yocto-docs rev: 29012a8f8e21b964e1ea6d32841dffa8dae7df9f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Needed to add cross-links into the glossary for various variables.
(From yocto-docs rev: 45acf78a2f99e8fda91042c2bee30094255e5a10)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Entry added for HOSTTOOLS and HOSTTOOLS_NONFATAL.
(From yocto-docs rev: c766920a13071c1bb46a195ea07be38962d2e12d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11411]
To help clear up the importance of the naming convention a user
must follow when creating a nativesdk-myrecipe.bb recipe that
inherits the nativesdk class, I placed a warning note at the end
of the section for the "nativesdk.bbclass" section.
(From yocto-docs rev: e6dc512aaeb0267c2c15c17a599c6950728b4547)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11310]
Added the "iputils-ping" package to the list of essential host
packages.
(From yocto-docs rev: c6478419940405091d59312d22c45e3f32f9c94d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11310]
Added this package to Ubuntu/Debina, Fedora, and OpenSUSE.
(From yocto-docs rev: e010d1abc083ed064c5340146bcac213286d973c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10995]
I implemented various wording changes based on feedback from the
review. One section title changes so some links in the ref-manual
and the dev-manual needed updating as well.
(From yocto-docs rev: 43a35a311a006d47db50602822e44ab431ca3e43)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11310]
After a bit of deliberation.. it was decided that
"python3-expect" is not needed in the Debian, Fedora,
and OpenSUSE distros as an essential package. They are
gone.
(From yocto-docs rev: 07fcb23a03122e5f4f9bb2a32e585d9cba7d5d93)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changes covered several areas. Version 2.3 of the YP now supports
recipe-specific sysroots and is not limited to machine-specific
as was prior releases. Manual changes were as follows:
dev-manual: "Sharing Files Between Recipes" - Wordings were changed
to support the new functionality.
ref-manual: do_prepare_recipe_sysroot task added to the list of
tasks described in "Configuration and Compilation".
ref-manual: Extensive re-write of the "staging.bbclass" section.
ref-manual: Added a section to the build structure for
build/tmp/work/tunearch/recipename/version/. This section breaks
down the recipe-specific subdirectories used to create (stage)
the sysroot.
ref-manual: New section (entry) for the do_prepare_recipe_sysroot
task in the task chapter.
ref-manual: Added a variable glossary description for the
SSTATE_SCAN_FILES variable.
In addition to these changes, I sprinkled in a liberal amount
of cross-referencing for the readers pleasure.
(From yocto-docs rev: 3a8ca96861f4c5d3badb91d0cdc5a3df513d4e59)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10995]
I applied some revisions to the related sections for incrementing
a binary package version and revision sections. Mainly clarified
terminology and pulled the sections into one single section head.
I also cleaned up referencing to all these sections throughout the
YP manual set (i.e. the ref-manual).
(From yocto-docs rev: 7deda18dd496cc383c5de71a10f2b11b1ca0688f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10995]
For the dev-manual, I added a new section on incrementing package
revision numbers that explains how the build system uses various
variables to create linearly numbered revisions for packages.
For the ref-manual, I cross-referenced into the new section from the
AUTOSRC and SRCREV variables.
(From yocto-docs rev: 53c3092e0f0293f4db0a88659abb4cf1c93f208c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #8596]
Added a new section to describe the right way to use headers to
interface to a device or custom Linux kernel API. Too often a
user wants to modify the libc header file, which absolutely wrong.
This new section provides some guidance.
(From yocto-docs rev: 960c49bf6446398a9efb2d018d09d63b49e97196)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11274]
When a post-installation or pre-installation script uses tools that
have dependencies, you need to specify the tools using the new
PACKAGE_WRITE_DEPS variable. I added this information at the end
of the "Post Installtion Scripts" section in the dev-manual.
I also added a new variable entry for the PACKAGE_WRITE_DEPS variable
in the glossary.
(From yocto-docs rev: 4d130b63cba5ebabd4af52b62421d387a4b54353)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10887]
I placed a small paragraph at the end of the introduction to the
"Performing Automated Runtime Testing" section that points into the
new section on QA and testing infrastructure in the ref-manual.
(From yocto-docs rev: 493051e1770e07b89c19a1f235f1dd226610c77a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10887]
There needed to be an overview of the test and QA infrastructure
used by the YP development team for releases and that is visible
to the developer. I added a new section for this information into
the existing section on YP release processes.
(From yocto-docs rev: 17b3d6898b37bdbfbd23a333a4d659a9746696d0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10596]
No information existed for the version 1.0 YP Compatibility Program
for layers. Additionally, the version 2.0 flavor is adding a script
as part of the application process. I put in a new section on the
whole topic. Also, integrated the information into relevant sections
with some cross-referencing.
(From yocto-docs rev: 6341705d4c08901b2657c489f4e995968db00d85)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10854]
Feedback from the review indicated that CentOS python3-pip and
python3-expect should be python34-pip. Did this change.
(From yocto-docs rev: ae307a183328b3c572e3f63c0274806af244c618)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9675]
I missed one occurrence of changing "smart" to "dnf" in the
Enabling Tests section. Corrected.
(From yocto-docs rev: b5106c7a38f51dbfea6d200072039f624be7ed3a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10350]
Based on Henry's assesment that the wording was unclear in some
spots, I did a little smithing to try and help.
(From yocto-docs rev: b52bb8d73071ad6b7a0956dec2f84a84ae1c7045)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10946]
Based on feedback, I made some minor rewrites to a sentence describing
when you need to use a different form to get BitBake to pick up
hierarchical data as kernel data.
(From yocto-docs rev: 65fcd23826e9a69152933f84cb3f8bac650cd4e5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9675]
Various fixes to replace the "smart" package manager references
with "dnf".
(From yocto-docs rev: 721dc7fb637c4c03534eb19f61b0b08a7303826d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10898]
I altered the verbiage used to describe the inclusive nature of
the beginline and endline note to be clear to non-native English
speaker based on feedback.
(From yocto-docs rev: 5edf417cd044ded30d1f8366ac0cde336d0da016)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10854]
I added extra "yum" commands and a make command to deal with
some essential packages needed for CentOS distribution. These
packages were missing.
(From yocto-docs rev: 38ac6cf0165f7dd7bbfd583e218b6948dafae29c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10946]
There was insufficient information in the combination of the
BSP Guide and the Kernel Development Manual on just how to locate
and use kernel metadata.
* bsp-guide - Removed the detailed append file example for the
kernel recipe. This is moved now to the chapter in the kernel
manual that describes append files.
* kernel-dev - Placed the example from the BSP Guide into the
section that describes kernel append files. Cleaned up some
terminology issues throughout chapter 3. Added information
about how BitBake picks up kernel metadata when the metadata
is in a hierarchical directory and not just a simple *.scc
file.
(From yocto-docs rev: 1048acb7127e77ca9c1f524a208fe25344fcb57c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
It seems that the two sections "Kernel Metadata Location" and
"Kernel Metadata Syntax" were flipped regarding their order of
apperance in the kernel-dev manual. I belive that syntax should
be first and then followed by a discussion on the location. I
have swapped these section's ordering in the manual.
(From yocto-docs rev: 167b088f459c7128bdc1abddd0b948be8f3bf5fe)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Convention is to avoid using hyperlinks for variables that appear
in <literallayout>/</literallalyout> coded blocks. I removed the
links for the KERNEL_FEATURES and LINUX_KERNEL_TYPE variables,
which appeared in a literal block and put the links into the
context of the description.
(From yocto-docs rev: 3384f67e4b9f15e8f96297ceb2aafc63a5994d22)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section in the dev-manual that introduces BSP Layers for the
first time was missing a general link to reference into the BSP
Guide to help the user understand BSP Layer structure. I added
a note.
(From yocto-docs rev: c515e30a551e96e11091c3850f7eed1b034abdad)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
poky.ent - changed the "tbd" and "TBD" strings to "pyro" and
"Pyro", respectively.
Manual Head Files - Updated the manual history table with the
May release month.
(From yocto-docs rev: 076226d2986d0cf69685121e4342f50c1603fc7b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10898]
It is hard to get the exact start and end for included license text
during a LIC_FILES_CHKSUM operation. I updated the notes indicating
that the QA message returned upon failure includes the attempted
license text. The user can better adjust his LIC_FILES_CHKSUM
statement to then dig out the proper text.
(From yocto-docs rev: 1db04334703f35f1cab933c345fb1db43fd0af79)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11017]
There is no current way to specify or list plug-in dependencies
when building a Wic image. The variable WKS_FILE_DEPENDS was introduced
to allow the user to use this in the recipe building the image.
I added a description and example of the variable to the ref-manual
variable glossary. I also cross-referenced the variable in the
"Plug-ins" section of the dev-manual to point to the variable for
more information.
(From yocto-docs rev: 5a1072499ab80f74ffec6af2cc0b2f1987843a25)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10350]
A situation exists where a user deploys a new application using
devtool target-deploy and the new application has runtime dependencies
that are not already on the target. When this situation exists, the
application misbehaves if it calls a missing function. I added the
explanation of this situation to the section that describes the
devtool deploy-target command. Also, put a pointer in the section
on devtool add for cross-reference purposes.
(From yocto-docs rev: 694151e397ff40871b3ec8700c39d32a15814535)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11048]
No documentation existed for telling the user how to create signed
RPM packages or for how to use signed package feeds. I have created
a new section on the topic to describe both scenarios.
(From yocto-docs rev: cbdde75f06b1fc190b8e4f7f93f302dc238e3e7f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10888]
The YP documentation was missing information on how the major
and minor (point) release process works. I added a new chapter
in front of the "Maintenance" chapter that details the naming
schemes, cadence, and maintenance for YP releases.
(From yocto-docs rev: b486f871e1fb8a6f763510ed385f459fe215fa27)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10854]
The distros for Fedora, OpenSUSE and CentOS needed these.
(From yocto-docs rev: a83dcca50681d589fbcc924de4845e62de053810)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10855]
In order for BitBake to run, we needed to add two more packages to
the essential host packages: "xz" and "which". I have added these
to the poky.ent file variables for each host and did the formatting
so that the manuals render properly.
(From yocto-docs rev: 1bfbdcb58e31ca6e978d6dcccd6d58fbd68dbf2b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11021]
The "Maintaining Open Source License Compliance During Your
Product's Lifecycle" section in the dev manual covers use of
archiver.bbclass, but is missing mention of the filtering
options (e.g COPYLEFT_LICENSE_INCLUDE, COPYLEFT_LICENSE_EXCLUDE
and COPYLEFT_RECIPE_TYPES). I added descriptions for these
three. During the write-up, Paul noticed a couple other variables
missing: COPYLEFT_PN_INCLUDE and COPYLEFT_PN_EXCLUDE. I also
added descriptions for these two variables.
(From yocto-docs rev: 450311037ea3048d30057c0b9d294efd33db2d3c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9376]
Expanded many of the brief descriptions for the kernel-related
tasks.
(From yocto-docs rev: ee9e54aa9f148e5438cd9bdf7e55d7fa43cc3ec5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section "Maintaining Open Source License Compliance During
Your Product's Lifecycle" had a vew minor typo things (e.g. duplicated
word and some formatting issues). I fixed these.
(From yocto-docs rev: 67beb658445e79129d8aae1739bb33c000367107)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11010]
The second example was incorrect in the glossary entry. Instead
of "1" an image name place holder was in the example. I put "1"
in there.
(From yocto-docs rev: 00ab787d0d90da5c6d384c3669e804c9b2baca53)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10076]
The note on the title page for each manual was brief regarding
where to find the latest version of the manual. I updated the
note to have more detailed information on finding current,
alternate, and latest versions of the manual based on YP
releases.
(From yocto-docs rev: 0ec81465296a7a78309d3039af4d00caa52d2285)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
core-image-directfb was removed from oe-core with this commit:
remove core-image-directfb.bb as part of moving directfb
from oe-core
(From OE-Core rev: 8871fe1189776d78e5848b08edb9c990b9aebf2d)
I made the similar change to the ref-manual by removing it
from the "Images" chapter.
(From yocto-docs rev: bee62aea8469cfca77e6f5e97a9ef2f52f16c9cb)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The generated package-depends.dot and pn-depends.dot stuff
contains partial data about the taskgraph and tends to
confuse users. Richard Purdie suggested removing these from
bitbake/lib/bb/cooker.py. I have removed the references to
them in the "Viewing Dependencies Between Recipes and Tasks"
section of the ref-manual.
(From yocto-docs rev: 3dc9b124532b52369cec2de8209f33aebce2b648)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10889]
Missing this package. Speculation is that this package was
part of the Python 2.7 stuff but not Python 3. So, adding it
clears the issue up.
(From yocto-docs rev: c61672267f872ed0f57ecf83d86b0d96080aac51)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Apparently, this package dropped out when migrating to Python3.
So, I have added it to all the supported distributions as an
essential package.
Fixes [YOCTO #10909]
(From yocto-docs rev: e5f915fb80fc36db515ad5a56bc31228a7f875d3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed [YOCTO #10854]
BitBake fails on a new Ubuntu/Debian installation unless the
"cpio", "Python", and "python3" packages are installed. I added
these to the essentials list variable for the distro. Affects
both the YP Quick Start and YP ref-manual.
(From yocto-docs rev: 7a0ef9a85404ef4478bae103d1ea47c3e1c675f0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10855]
On Fedora version 24, missing packages were preventing
BitBake from running. These essential packages included
"python", "cpio", and "file". Also, missing for openSUSE
were "python3", "python3-curses", and "tar".
I added these sets of packages to the essentials variable
for each of the hosts involved. They resolve to both the
YP Quick Start and YP Reference Manual, appropriately.
(From yocto-docs rev: 5150bb932536dc17d99f94a96245655144ae5137)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10905]
I updated the section with suggested improvements for completeness.
The section has been broken into more subsections and provides the
reader with more direction on mailing lists based on components
changed.
(From yocto-docs rev: f7c9010c14d96c64d00ca32e2e217d2dd1343919)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10898]
No information indicated the use of "endline" and "beginline"
in the examples setting LIC_FILES_CHKSUM. I added a note
indicating that line numbering starts with one and the "endline"
value is inclusive.
(From yocto-docs rev: 21114f09efa423033da67af1f27c99eb3cb9695d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10076]
Added a new note for where the reader can find the most recent
version of the manual dictated by release or in-progress work.
(From yocto-docs rev: 8c2bd2a72ba89354027fa87872395d5b727c8b90)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10818]
There is a weird and intermittant error that can occur on any given
distribution that has a 4.3+ Linux kernel and a version 228+ systemd.
The error happens during an initial build of an image and indicates
that resources are unavailable. Investigation determines that
resources are available. The combination of the kernel and the
systemd in a distro is causing issues when a distro is upgraded.
yocto-project-qs:
I added a note in the two areas where the user is stepped through
the bitbake process to build an image. The note mentions the
possibility of the error, the host configuration situation, and a
couple work-arounds, which are to reboot the machine or to set the
"DefaultTaskMax" systemd parameter to "infinity".
ref-manual:
Added the same note in the "Building an Image" section.
(From yocto-docs rev: 3516803f9e6b5a29e4f95d31742c6e03ff63ef41)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10621]
bmaptool is integrated into the OpenEmbedded build system but is
not documented. I added a new section describing how to flash an
image to media using the tool. Also, updated a small section in the
Wic part of the manual that used "dd" to flash an example. I added
a bmaptool counterpart here and referenced the reader back to the
main new section.
(From yocto-docs rev: 98ebe9acccceea2b833c1372a3e664befd1b6aef)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10621]
bmaptool is integrated into the OpenEmbedded build system but is
not documented. I added a new section describing how to flash an
image to media using the tool. Also, updated a small section in the
Wic part of the manual that used "dd" to flash an example. I added
a bmaptool counterpart here and referenced the reader back to the
main new section.
(From yocto-docs rev: 83a9a3aa5f20c7f389306eea9213eabea997aba1)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7096]
Applied a couple review comments to the section to clarify where
to set key variables. Also fixed an incorrect variable name used
to specify the *.cpio file.
(From yocto-docs rev: 24861b36804cbd636aafc36b1918bcfe33ca3811)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6132]
No mention of how to make the target directory /var/log
persistent. I added a note to the "post-install-logging"
image feature that points to the new VOLATILE_LOG_DIR
variable description, which I added to the glossary.
(From yocto-docs rev: 5d2bdf49e569e44d02602501d72418f04dbe6e4a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10763]
The final example in the section describing how to create
the base recipe using receipetool create was wrong. I updated
it to use the -d option in addition to the -o opetion. I also
changed the description to match appropriately.
(From yocto-docs rev: 8cc6d5e21532eeaac0e6d9ace3e0b58803a9804e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7096]
We did not document how to create an initramfs image to be included
with a kernel build. Various variables sort of inferred the
knowledge. I created a new section in the "Common Tasks" section
of the dev-manual that describes how to create an initramfs image.
Also, I updated the kernel.bbclass reference section to point back
to the new "how-to" section.
Finally, I also created a bunch of cross-reference links from various
related variables back to the new "how-to" section.
(From yocto-docs rev: 289dfbd5d24241e42446a043104eecd6dca76f13)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This term was incorrect and I have replaced it with the
term "partitioned."
(From yocto-docs rev: 50dd5c6994a2f799fdaf1ccbf7138b0074e981ee)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
new information on how wic works
(From yocto-docs rev: 7b6a54a593a678442541b1fa6847498a792183c7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This new variable points to the location of the wics kickstart
file.
(From yocto-docs rev: 80d18224140f95fdca0b4efad8f6a6e545ee4d56)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10714]
Apparently there is some issues with GTK3 libraries for the Mars
Eclipse version. The note provides a workaround that requires
editing the eclipse.ini file.
(From yocto-docs rev: f940d5d3f7bf446af8f3c7cec5958c8395425a69)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The fact that the OpenEmbedded build system can now build
multiple image types caused the KERNEL_IMAGE_BASE_NAME variable
to have the KERNEL_IMAGETYPE portion removed. This could cause
existing recipes that use the KERNEL_IMAGE_BASE_NAME variable
directly issues. I added a section indicating that the user
should address those recipes to avoid problems.
(From yocto-docs rev: c433fca3840440c14bb364a51afc5c3c2bfc7c88)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10717]
Now that multiple images can be built, the KERNEL_IMAGE_BASE_NAME
no longer requires "${KERNEL_IMAGETYPE}" as part of its default
value. I have removed this portion of the default definition
described in the glossary.
(From yocto-docs rev: 713b3c141dfb66fc3852b5a997a7fc19d494e97b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10351]
I added a note to the "Post Installation Scripts" section of the
"Writing a New Recipe" section to call out the fact that the
RPM package manager will not install packages on the target when
any RPM post-install script returns a non-zero exit code when
the script is run on the target.
(From yocto-docs rev: 8565b0ba874f3357500a91640c0f77077c83b8d6)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10692]
I updated the STAGING_DIR variable description to have a reference
to the SYSROOT_DIRS variable as well as the "Sharing Files
Between Recipes" section of the dev-manual.
I also updated the "Sharing Files Between Recipes" section so
that the role of SYSROOT_DIRS is explained and actually used
in an example to add another directory.
(From yocto-docs rev: 6539fcf632cfa3f076f874535ee9fc7ac291fbce)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #8584]
Made some edits to tighten this down and make it more efficient.
(From yocto-docs rev: d5a37b77fa5c8df766248849601ca229502bb4ab)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changes to the following:
* All manual revision tables to indicate a 2.3 release proposed
for April of 2017.
* Updated the poky.ent file so that all variables needed reflect
2.3 values.
* Updated the mega-manual.sed file so that processing of links in
the mega-manual work for a 2.3 release.
(From yocto-docs rev: 926e282c17b67c79b94a0b62a0b18bfbe0b26c40)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #8584]
This fix essentially had to document how to add the API
documentation to the standard SDK. The fix required adding a
new appendix to the SDK manual on how to customize that
standard SDK. I could not put just one topic in a new appendix
so I also added a sub-section on how to add indidual packages
to the standard SDK.
Other changes here were the introduction of a new file for the new
appendix, updated the mega-manual.xml file so that it would include
the new chapter when the MM was built. Finally, I added some
cross-referencing to the new appendix from the TOOLCHAIN_HOST_TASK
and TOOLCHAIN_TARGET_TASK variables. And a cross reference from the
distro features section on the api-documentation bullet.
(From yocto-docs rev: 1fb4321ae42253d1fc9602496b5e9e8b495197dd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #8584]
Updated the "Distro Features" section to include the
"api-documentation" feature.
(From yocto-docs rev: 5b4e8fc58b84aea9a940f67f8d7585912fadc676)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The string appeared in the text as "$(INC_PR).0". So, fixed
it to be proper with the curly braces.
(From yocto-docs rev: 0e4ca6cd3d0eae847243fc624c5f119d004cf40c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The way I had this string was incorrect. I changed it to "openSUSE".
(From yocto-docs rev: 221f5032ad3589b96a004d38e2b250e38f971007)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed [YOCTO #10588]
This section was confusing due to the fact that it used an actual
set of IP addresses and image name where they should be clearly
called out as examples. Fixed it.
(From yocto-docs rev: 4682899c7b70c730256412bf08f469c457af1c2e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10451]
Added a missing closing parentheses to a sentence.
(From yocto-docs rev: e181c2e48ecc45cb194df02c9019ddada9707b41)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The "runqemu Ported to Python" section was using past tense
for a note about previous usage patterns being supported. I
changed this to present tense.
(From yocto-docs rev: d8956022c7eb6046e67766fd6e9121579d6b323b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These requirements were in place for the ADT, which is gone now.
I have removed the four supported host lists for packages to
support the SDK.
(From yocto-docs rev: 9c7c20074e455c24c3fa4cf7114495af47d9881c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Moved a couple notes around and changed some wordings...
nothing major.
(From yocto-docs rev: 75be6c30ca646ee81b955fae7a3e0183ead9ca08)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10462]
The section that shows how to build images had two examples all
within the same section. It was suggested to place these examples
in their own sub-sections. Good suggestion. I broke them out into
sub-sections titled appropriately.
(From yocto-docs rev: 280f304b9823553754c86a5fa6d0c4065d729e7b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10451]
The example that writes the image to bootable media did not seem
to work when using 'mkefidisk.sh'. It does work using 'dd'. I changed
the procedure to use 'dd'.
(From yocto-docs rev: 27a70c88f987cee731584618d76c40a878f35a75)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a new section in the "Common Tasks" chapter to support
the fact that BB can now build for multi-configurations.
(From yocto-docs rev: aa21aeb2f3d2f9d5a3a6e7175b7c6f13da5f608e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10445]
Pointed out that the EXTENDPKGV variable is hard to locate in the
BB manual. Firstly, we don't document that variable in the
BB manual.... maybe we should. For the ref-manual, however, it is
barely referenced in a side example from the dev-manual. So, I
updated the RDEPENDS variable to have a "Tip" box in the area where
it is shown how to use the package version as part of the RDEPENDs
variable.
(From yocto-docs rev: 7aff5df538c27cf3c2700538e46e723cdb5d9986)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Indicated that the configuration file is not mandatory. Also,
documented the supported qemu* machines should you run the
script without a configuration file.
(From yocto-docs rev: aeb2c28d7476f67302a1b51da51fb57027e9d02c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable is now redundant due to the way these image
files are staged now. The variable does not need to be
in the glossary. Removing the images is now the default
behavior.
Author: Joshua Lock <joshua.g.lock@intel.com>
(From yocto-docs rev: 049c371b44d3ef68def4ead7d1db8bf982d23c57)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided more detail on what the user can do with configuration files
to use the changed runqemu.
(From yocto-docs rev: 5dee8ceca290fdc8f3b41e0eba6565494190ce4f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I did not put in the links for a couple commits for some of the
2.2 bitbake changes. Put in the links.
(From yocto-docs rev: a806463a07ab07ce9da23d6bb73cb981b85b668e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The way these old image files are staged now makes removing them
the default behavior. Thus, this variable has become redundant.
I added a note indicating such.
(From yocto-docs rev: e1db620fdf741b46e54cf1a3715597f81a811818)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The BB_SETSCENE_VERIFY_FUNCTION variable has effectively changed
names to be BB_SETSCENE_VERIFY_FUNCTION2. I made the one instance
of it correct here.
(From yocto-docs rev: c2864dace370d7a43234f4728b33f25082e628e3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed [YOCTO #9481]
Complete re-write based on Mark Hatle's steps. I converted
from sub-sections to an ordered list.
(From yocto-docs rev: f83bfe5d3dc012b924b6870672d7260a9c0bc3ee)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10392]
Moved the last bullet item from the list that was about
DEPENDS to a note form above the list. This was done because
the stuff for DEPENDS is more general.
(From yocto-docs rev: 2879d97b14322f1f9495288fc7f2298a186c5f68)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9667]
The actual command in the example to build the image for
Minnow MAX should be for 'core-image-base'. I changed it to
be that.
(From yocto-docs rev: 9aca9cceee543eea278390059ccff0761758b55e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The value for USERADD_ERROR_DYNAMIC changed from "1" to "error"
to activate this variable. Also, the value "warn" is used
to cause a warning to be issued. I updated the variable
description to reflect this.
For the USERADDEXTENSION variable, I updated the [doc] string
to use proper quote marks. I was not nesting these properly.
(From yocto-docs rev: f21277b3887134611fc567da05e8a590ecb0d7af)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10392]
People often needlessly put [noexec] on tasks, making the recipes
more complicated than they need to be. I updated the first bullet
item in this section to more clearly explain how to do this.
Also, added a new bullet item to the end to point into the DEPENDS
variable for more clarification.
(From yocto-docs rev: c61e61c1a5f9524c50bfc26335ea6c2027cafd19)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10385]
The output was incorrect for the default kernel type. In the
Krogoth branch, the output uses 4.1 and the text indicates 4.4.
In the master branch it was the same as well. This commit fixes the
master branch to use the default 4.8 kernel in both the example output
and the text.
(From yocto-docs rev: a76d1cc91883dcd58743f2cd2626917e51419cb1)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10377]
Linkified the STAGING_DIR_NATIVE item in the the
SYSROOT_DIRS_NATIVE glossary entry.
(From yocto-docs rev: e02ecfac949b92ec32a621fccb0d1663bb7816ad)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10377]
Some minor wordsmithing. Also added a new note to the
SYSROOT_DIRS_NATIVE variable.
(From yocto-docs rev: 459666b01b8d6d8212a59c877ea6c324511a5883)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10377]
Provided links back into the do_populate_sysroot task and other
key variables. I updated the SYSROOT_DIRS, SYSROOT_DIRS_BLACKLIST,
and SYSROOT_DIRS_NATIVE variables.
(From yocto-docs rev: 23ed80e4884b00e303a15d0d191bd0dca385b064)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10377]
Added more detail and linked it to key variables.
(From yocto-docs rev: d82c1d4e8cc95bee718388cfeced1566ce8569a0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added wording to the "installed-vs-shipped" error message
in the QA chapter.
(From yocto-docs rev: cc9d22fb6dd8e45ef6b53608f0ebccf29721cc3f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10363]
Added a small note to the bullet item about bb.fatal(). Noted
that the function raises an exception so the user does not
have to put a "return" statement after the function call.
(From yocto-docs rev: c27bae87192b7e109d995679c8c91fb3388d8d4c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added string "October 2016" as the release date.
(From yocto-docs rev: db40986677746afbbb138d9cbe3885111550b7c5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I basically moved the note from the bottome to a position
within the bulleted list.
Fixes [YOCTO #10348]
(From yocto-docs rev: a55dc7e0f8465abf8398f51d90bbe2df7e639b3f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Put a closing reference in the "Stamp Files and the Rerunning of Tasks"
section to point the user to the area that tells them how to
view information about a task's signature.
(From yocto-docs rev: 3f395ef1999a2aff1447da4d257fd5d53124aaa7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9667]
The example that built the image out for the MinnowBoard MAX was
buiding a core-image-minimal. This was not ideal. I have fixed
it so that several types of images are suggested as examples with
a reference to the Images chapter in the ref-manual. The actual
command now builds out core-image-base.
(From yocto-docs rev: 588f9c06bf5dbad253826825dd2a9a67c89f3219)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Due to new chapters in the SDK manual and the movement of the devtool
Quick Reference from the dev-manual to the ref-manual, I had to xinclude
these various chapters in the mega-manual.xml file that builds out the
manual.
(From yocto-docs rev: 8d6fb3d97e6a64b53cfdf66d94d7306babb48378)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Using Morty for the name, 17.0.0 for the poky version, etc.
(From yocto-docs rev: b396626ca05820b51e78407a6c7cd6a0e113aad5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10360]
Added a new section to reference into the OpenEmbedded Styleguide.
This will help people writing new recipes to conform to known
styles.
(From yocto-docs rev: 40c12742c78f5aba5bb4e43f759e8c478470fd83)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10356]
Expanded the general description of this directory.
(From yocto-docs rev: df71fe472f9d5cb5f809706ec4218952a49d31d3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10267]
Changed the example to use a single long line.
(From yocto-docs rev: c80d8bb8773b7bbe9c85c48880f42ffb273729b7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10348]
Added a note clarifying that -native recipes are not installed
into host paths.
(From yocto-docs rev: c0b4265350b558eec296c93f0829c3d687950c52)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10345]
There was no mention of the -C option in the "Running Specific
Tasks" section. I added information to cover this command-line
option.
(From yocto-docs rev: 7b05c5dd3816414c1d3ca898fbd41ce588425057)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9554]
In the examples, I changes "IMAGE_FEATURE" to "IMAGE_FEATURES_append"
(From yocto-docs rev: 3fc2cc217a0a67b3e0739c6a235ab8e350c4b7c3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO 10323]
Made a code change to the example script that helps a user
locate GPL files.
(From yocto-docs rev: bd02012de75f0c30887d3a5bb4aa219703a3ee1c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10298]
Applied a small grammar fix to the description.
(From yocto-docs rev: d022a01af3f68e6e6311c47aef451e25bc8add5e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10323]
In the Providing the Source Code section, I replaced the 3-line
code example that returns GPL files. The bits I put in are a
script that does the trick. The 3-line example was not working.
(From yocto-docs rev: a07873d46b5135555961499c6ce8f0b6b8bf2c8f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9166]
I applied some review comments to the section. Pulled some stuff
out that did not apply.pdated the devpyshell section
(From yocto-docs rev: 7300358570de4da94ff5f22afd30128ef8dd0f13)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9554]
I applied some review comments for the section on using GDB
on the target for debugging. Included a new note on optimizations
considerations.
(From yocto-docs rev: 23f0dd82f682ea39849de0f589ee1ebfb16be749)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Small grammatical changes.
(From yocto-docs rev: efa1e9c3948f7dd240372a1a1c773286072fbccd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9166]
In the dev-manual, I added a new section titled "Using a
Development Python Shell." This section is similar to the
section that talks about using devshell. The section is
tied to a reference section on the do_devpyshell task.
In the ref-manual, I entered a new task reference for the
do_devpyshell task. It is brief and references into the
new section in the dev-manual.
(From yocto-docs rev: 637128809e298c3d5e660f6da2366f8e9e307218)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9554]
I added a new section titled "Debugging with the GNU Project
Debugger (GDB) on the Target" that provides requirements for
this type of debugging.
(From yocto-docs rev: 5d15c6c5f2030395f9faea8a5ef3ead1b98042d8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9285]
Altered the wording to more accurately reflect the issue.
(From yocto-docs rev: 66cda9997a6c17752903a0b5600fb8cae98566e9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #8631]
These fixes cover the following:
* New glossary entry for SYSROOT_DIRS
* New glossary entry for SYSROOT_DIRS_NATIVE
* New glossary entry for SYSROOT_DIRS_BLACKLIST
* New section titled "Sharing Files Between Recipes" in the
dev-manual's "Writing a New Recipe" section.
(From yocto-docs rev: e541a3c8967f51b903d9dd7978009f4fa7c2f014)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9679]
I added a new section titled "Dependencies" inside the section
that talks about writing a new recipe. This section details
both build-time and runtime dependency behavior and conditions.
(From yocto-docs rev: 37305ea09473dcaee2db4f9cc37c7ce0fc33c52a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10298]
Added a better front part description to the variable.
(From yocto-docs rev: ce8a093235aa78761fde66f345f993ab7cfac6c6)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied various edits to the "Writing a New Recipe" section.
Several nits.
(From yocto-docs rev: 17818ff89805e0df3a0445f64a4f9133550fa7d0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I applied several nits across the manuals based on reviewer
comments. All these corrections relate to the task of shuffling
topics around that have to do with the extensible SDK and the
devtool.
(From yocto-docs rev: 9f8079adc7fa2897fd885aff8e64f9721212e9c7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10297]
Updated the "Other Tips" section to include a couple new tips.
* Remove the /tmp directory as a way to work-around temporary
build issues.
* Create a little method to help you search the massive
amounts of bits for whatever. Also, suggested filing bugs
against the docs if a feature is too hard to find or figure out.
(From yocto-docs rev: d9829dd096f7cc56f8e55fba3190be2a59b80fe5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10295]
Added a third item to the list of mechanisms in the
"Automatically Added Runtime Dependencies" section. The new
mechanism is depchains.
(From yocto-docs rev: 304fe159bfbd426b8b42e1245db83ee57b9e5588)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10294]
Provided text noting that if packages in the PACKAGES list are
empty are not generated, unless generation is forced through
the ALLOW_EMPTY variable.
(From yocto-docs rev: 1c89e0edf7e038f733b9b95bb884648d953b9574)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10292]
I added an additional paragraph at the end of the section that
provided more detail on what the bitbake -e and bitbake -e recipe
commands provide in the way output.
(From yocto-docs rev: 1dcdb6781105f046328271e2b4ba7d875b222dcf)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Removed the note box formatting for the cross-reference
from the sdk-manual and dev-manual sections that
talk about devtool. The reference is now non-note
form and goes to the ref-manual devtool quick ref.
* Added devtool upgrade as a third item in the list that
introduces methods to use devtool.
* Fixed the working on the devtool finish step 5 for both
the dev-manual and sdk-manual.
* Renamed the new chapter that describes different projects
you can use devtool on. The focus is on using the SDK
toolchain directly.
* Scrubbed the entire sdk-manual for the term "toolchain
installer" and replaced with "SDK installer".
(From yocto-docs rev: 6d4daef49cc6d54a700a8c3965c9e8814f75d20a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I put in some introductory material for the new devtool
quick reference chapter.
(From yocto-docs rev: dc46f47692a533ac2450bf459c098435c57e6c07)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made several improvements to this section.
* fixed a typo where a YP release was referred to as 7.1
instead of 1.7
* Added a note box to the "Using Variables" list item
elaborating on the expansion behavior.
* Removed the detail around the WORKDIR discussion.
* In the "Loccate or Automatically Create a Base Recipe",
I added the devtool add method to the list of ways to
create a base recipe.
(From yocto-docs rev: 79c86fc3653c747ae42f08528063a8984cdd3b4d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I extracted the sections on Makefile, Autotools, and Eclipse into
their own new chapter. Seemed to make sense as they are projet
types for both standard and extensible SDK types. Also, swapped
the order of appearance from standard first to extensible first.
This swapping caused a bit of rewriting.
(From yocto-docs rev: 138a4d5576123da800a8fd8d99462a138ceeb743)
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 needed a new figure and a new section.
(From yocto-docs rev: d413ca7b9b946450af7c2c15ab0e68e9181517e9)
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>
These notes can't be in the final version of the manual.
Now is the time to get them out.
(From yocto-docs rev: 600b4f2c7360b30d12fdc7ed0f5ba41bc09fc778)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10032]
The fix to remove the BitBake Commander from the tools to install
when dealing with the Eclipse Yocto Plug-in has happened.
Consequently, I removed the developer notes in the manual stating
that the Commander was still showing up there. The manual set
is now clean of this stuff.
(From yocto-docs rev: fbe169b086faac571de8a2ebd9d32682162cfd31)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10267]
The example works better using OECORE_TARGET_SYSROOT for the
aclocal line. I changed it to that.
(From yocto-docs rev: 362b786e7bf2083c5809e961f61c0ad81b778d71)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10248]
Provided more accurate descriptions for this variable and task.
(From yocto-docs rev: 422fa705165748230470fffc4fcc543ee38b1f2e)
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>
Fixes [YOCTO #10248]
Applied some review changes. Minor wording tweaks and typo
fixes.
(From yocto-docs rev: a9e99c8b44c48c74448487187cebfe8df331e9e1)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A new command devtool finish has superceded the final commands
in the SDK workflow. I updated the two figures (add and modify)
to reflect this new flow. I also updated the ordered number list
to match reality.
(From yocto-docs rev: 0ba31e730cd748d06eab8d46b38764cda5c4e3bd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a new variable description for SDK_INCLUDE_TOOLCHAIN.
Along with the new glossary entry, I updated a couple places
where it would be relevant to cross-reference the new variable.
(From yocto-docs rev: df99b097595e7488a93354082b8d9f33acd9c229)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
fixes [YOCTO #10252]
Added a note to help avoid confusion regarding the version
specification used in PREFERRED_VERSION.
(From yocto-docs rev: 38edc25b04c1a6d673ceb25f5548898d5b63b120)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
fixes [YOCTO #10248]
The bulk of this change is a new section called "Automatically
Added Runtime Dependencies". Additionally, changes were made
to the RDEPENDS and DEPENDS variables. Some cross-referencing
to the new material was also added in the do_package task entry,
the do_packagedata task entry, the PKGDATA_DIR glossary entry,
and the PRIVATE_LIBS glossary entry.
(From yocto-docs rev: 16504cd0eb23e102322c6c6096c5b52500a04640)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed the description to match that what is in the code.
(From yocto-docs rev: c099dd0b7c8d205b56009606e61ae359017f5783)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided clearer instruction on how to set up a new SSH
connection when deploying an application to QEMU.
(From yocto-docs rev: 93adc542a40e86377380684e1ce294edd0fd7268)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10216]
Creted a new section titled "Viewing Package Information with
oe-pkgdata-util". This section describes how to view information
for already build packages through the use of the
oi-pkgdata-util command.
(From yocto-docs rev: 8d9465f320f973ecaeecb3eae594b29c0d7f4960)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10183]
Added a new variable entry for the PACKAGECONFIG_CONFARGS variable.
With the introduction of the new PACKAGECONFIG_CONFARGS variable,
many places in the mainstream YP documentation that referenced
how to pass configure arguments using EXTRA_OECONF needed to also
make mention of this new variable. I added many cross-references
to the new variable.
(From yocto-docs rev: 00f02d45319bab90b72eab89fcb69cbe8bd05bb5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7546]
Applied changes throughout this section to move it from Luna to
the Neon version (latest) of Eclipse. We now provide a single
thread for Eclipse, which is based on the latest version (Neon).
Information for Mars, which is also supported) is in a new Appendix
C.
(From yocto-docs rev: 82995d9c49e4c55707591a1375c5d86874c589b0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10208]
Apparently, this should be "python3" and not "python" now.
(From yocto-docs rev: d9547b426d9ab8a2d79fac95405a7a371a4a35ac)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10208]
The example command was wrong. Had the wrong package name since
we moved upward with Python. Using "sudo dnf install python3-GitPython"
now.
(From yocto-docs rev: d94469ac4860841c3955161ce1b67a962c4f3f8d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This is the minimum requirement for YP 2.2 release.
(From yocto-docs rev: 0aebdd8556a6e5a52c0caf28dc97c1872b40e950)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9899]
This variable does not need documented in the glossary.
(From yocto-docs rev: 4082b752239025c8696bb248a20ac1fb5380c7af)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10197]
Provided better examples and a bit of a historical note.
(From yocto-docs rev: 5845aadcc4e6932abde4ce7c74834c0f2a9fb806)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9285]
Applied some rewording to the last bullet of the "Known
Issues" section in the "Enabling GObject Introspection
Support" section.
(From yocto-docs rev: 6cc0c7925984a29a115819195b800e2ecd8b4757)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9899]
I put this new variable description in.
(From yocto-docs rev: 32040277a921d0013256bed5aa7e32e14d1220ba)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10178]
Previously, YP did not support Python 3.0. We mentioned that
in the manual in several places as a requirement for running YP.
I removed this exclusion in the following areas:
* yocto-project-qs - the section that tells what version of
Python you need.
* ref-manual - the section that tells what version of Python
you need.
* ref-manual - the FAQ entry about not having the right version
of Python.
(From yocto-docs rev: 5a0d3ac1c2a4154b93dc925b8074bc9243a86faf)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10176]
Provided a more complete description of this variable.
(From yocto-docs rev: 164bf11250c965aadd1ee1573267aa31daa8a4e8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
