Commit Graph

1749 Commits

Author SHA1 Message Date
Scott Rifenbark
e99b83f4b0 Documenation: Updated "Usually October" to "October 2017" string
The string in the manual revision table needed updated across the
set except for the kernel-dev manual.

(From yocto-docs rev: e087a707e02ff913baba2ac8bc6594206f53f70c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:34 +01:00
Scott Rifenbark
fae276ea09 kernel-dev: Eliminated "Generating Configuration Files" section.
This section was largely redundant now.  The small things that did
add value I placed in other areas of the chapter 2.  One was a new
section on expanding variables using bitbake -e.  Another was a bit
about the defconfig file.  And a small procedure on how to create
config fragments using the "diffconfig" command was retained.

Links from the dev-manual and the ref-manual were adjusted as well.

(From yocto-docs rev: 7059d3eac1fec20089cabf197503f1bec747686d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:33 +01:00
Scott Rifenbark
0e7af54763 dev-manual: Updated compatible log program section.
Script name changed to "yocto-check-layer".

(From yocto-docs rev: 545a90dd2816c4e97dc70efc76c7cca49684c2d8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-26 11:18:59 +01:00
Scott Rifenbark
de671802c8 dev-manual: Compatibility program and moving kernel configuration
Should have been two commits but I forgot to do them separately.

1. I updated the YP Compatible Program section.

2. I moved the "Configuring the Kernel" section from the dev-manual
   to the kernel-dev manual.

(From yocto-docs rev: cdb5bbc917db55a2ca987ce9b9ed371f9fca6524)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-26 11:18:59 +01:00
Scott Rifenbark
f94f6e655f dev-manual, ref-manual: Image format implementation changes
Recently a number of changes have happened on the implementation
side of some image formats, and a few have been renamed.
The u-boot image signing code is now always available and no
longer in a stand-alone file.  The vmdk/mdi/qcow2 images have
been removed and are now just a conversion type that is applied
to wic images.

Reported-by: Tom Rini <trini@konsulko.com>
(From yocto-docs rev: ce86da3d48507cee12208e0138c285b4be83d8cd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-22 17:53:44 +01:00
Scott Rifenbark
b673c3b990 dev-manual: Replaced release names and numbers with variables
In several examples, hardcoded versions of release names and
versions were being used.  I updated to use variables from
poky.ent so that examples would use most recent release.

(From yocto-docs rev: 53f8e92075cc34538f36d7fba392ea1ac9a6dd1f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-22 17:53:44 +01:00
Scott Rifenbark
b103ff6ba7 documentation: Purged "oe-init-build-env-memres" from docs
Fixes [YOCTO #11968]

Purged all occurrences of the "oe-init-build-env-memres" script
from the YP documentation set.  Occurrences in a lot of places.
The BBSERVER variable was also impacted and had to have the
definition updated.

(From yocto-docs rev: 274b05108d1bc53df20c11ab2efa15363bce23da)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-22 17:53:44 +01:00
Scott Rifenbark
26975ed662 dev-manual: Added links to branch and tag checkout from overview.
(From yocto-docs rev: 122948411e1121be862caa43d216126c3a01f1fc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13 18:00:19 +01:00
Scott Rifenbark
db3c4c8557 dev-manual: Updated the reader pointers after poky clone
Added in a sentence to point to the kernel-dev manual should
the user be interested in kernel development.

(From yocto-docs rev: cc47606af5b7eb2fdc669aa2c0c4dfbd930b8247)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13 18:00:19 +01:00
Scott Rifenbark
ea256df2a8 dev-manual, kernel-dev: Working kernel flow process using devtool
A work-in-progress of an example that modifies the kernel
using the devtool.  The procedure is not complete yet as it
does not run properly.

(From yocto-docs rev: 462ba2e46f237c294f05805ad5044291a085975d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:49 +01:00
Kristi Rifenbark
f76e038674 dev-manual: Added support for signed RPM package feeds
Fixed [YOCTO #11209]

Rewrote so text indicates signed RPM package feeds work.

(From yocto-docs rev: 41c1e3d786f4436de59697431b2494cbabdebb8d)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:49 +01:00
Scott Rifenbark
7254c5086b dev-manual: removed note indicating signed RPM packages unsupported.
(From yocto-docs rev: 00c312e7515d82661fb16cd51f8fe9d03b4ea394)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:48 +01:00
Scott Rifenbark
a64831cad7 kernel-dev, dev-manual: Moved Kernel prep steps
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>
2017-09-02 00:52:48 +01:00
Scott Rifenbark
a037f60768 dev-manual: Pulled Eclipse preparation section
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>
2017-09-02 00:52:48 +01:00
Scott Rifenbark
2b93720cfc bsp-guide, dev-manual: Moved BSP Layer prep steps to bsp-guide
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>
2017-09-02 00:52:48 +01:00
Scott Rifenbark
a99c2c5581 dev-manual, kernel-dev, sdk-manual: Moved patching kernel section
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>
2017-09-02 00:52:48 +01:00
Scott Rifenbark
c35f87a7ea dev-manual: Updated simple build flow, text and diagram
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>
2017-09-02 00:52:47 +01:00
Kristi Rifenbark
203a8393e4 dev-manual: Updated "Sharing Files Between Recipes"
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>
2017-09-02 00:52:47 +01:00
Scott Rifenbark
d369f33383 dev-manual, ref-manual: Moved recipe syntax section to ref-manual
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>
2017-09-02 00:52:47 +01:00
Scott Rifenbark
07514c9003 dev-manual: Converted sections for following best layer practices
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>
2017-08-09 09:25:24 +01:00
Scott Rifenbark
7d7eb04b9c dev-manual: Updates to "Using .bbappend Files in Your Layer"
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>
2017-08-09 09:25:24 +01:00
Scott Rifenbark
2155745fff dev-manual: Changed wording that intros layer creation steps
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>
2017-08-09 09:25:24 +01:00
Scott Rifenbark
6d7b42f650 dev-manual: Added Links for specific container use
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>
2017-07-27 23:00:23 +01:00
Scott Rifenbark
a2dfac68b5 dev-manua: Added Crops setup section.
(From yocto-docs rev: e2ba131b98705f98463030dde043d858b500690d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-27 23:00:23 +01:00
Scott Rifenbark
38ee8ae876 dev-manual: Added steps to set up native linux host
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>
2017-07-27 23:00:23 +01:00
Scott Rifenbark
15901164ee dev-manual, ref-manual: Eliminated pre-built section
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>
2017-07-22 09:19:25 +01:00
Scott Rifenbark
2217d97ba9 dev-manual, ref-manual: Re-wrote QEMU section.
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>
2017-07-22 09:19:25 +01:00
Scott Rifenbark
da066d8cdf dev-manual: Scrubbed machine type for runqemu command.
(From yocto-docs rev: 9d7042661ab106055e4c09e4bbb41a8592c715c4)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-22 09:19:25 +01:00
Kristi Rifenbark
088f55a535 dev-manual: Fixed Flash the Device example
Fixes [YOCTO #11774]

Updated bmaptool instructions in Flashing
Images Using bmaptool section by changing
the sudo command.

Fixed the oe-run-native line.

(From yocto-docs rev: c3a1e2882abbb7b682ce101a8b038f89c4e2261c)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:16 +01:00
Scott Rifenbark
f49fa46e19 dev-manual: Updated the section on initramfs
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>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
e4f288d519 dev-manual: Updated "Performing a Simple Build" section.
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>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
6031f8cfb1 dev-manual: Updated cover information to remove Intel
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>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
293b53674c documentation: Moved devtool workflow to sdk manual
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>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
b15a65b8ea dev-manual: Moved devshell and python shell workflow sections.
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>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
81add6e460 dev-manual: Moved "Using Quilt in Your Workflow" to tasks
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>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
b171aea836 dev-manual: Moved "Finding Temporary Source Code"
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>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
431ceaea6c kernel-dev, dev-manual: Moved Kernel workflow section to kernel-dev
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>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
b643938bde dev-manual, kernel-dev: Moved the kernel build hierarchy section
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>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
64f0f60b3f dev-manual, kernel-dev: Moved kernel branch concepts to kernel-dev
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>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
bdeb6db2fb kernel-dev, dev-manual: Moved Yocto Linux kernel overview
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>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
7d2d54683c dev-manual: Removed Toaster development flow
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>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
fbdb36a568 dev-manual: Removed SDK workflow section
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>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
b9430113c6 dev-manual: Clarifications for files in checkout out by tag
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>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
1b2d89737f dev-manual: Added branch clarification to checking out poky
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>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
95547dab77 dev-manual: Wording updates "Cloning the poky Repository"
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>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
f384aa0c70 dev-manual: Lead-ins for "Using the Downloads Page" procedure
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>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
057adefbf0 dev-manual: Bold lead-ins for "Accessing Index of Releases"
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>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
e3fd3ca235 dev-manual: Added bold lead-ins for "Accessing Source Repositories"
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>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
a8c8680f84 dev-manual, bsp-guide: Moved BSP development workflow section
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>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
d552379be3 dev-manual: Moved the "Flashing Images using bmaptool" section.
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>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
15a41d25e9 dev-manual: Updated "Building Images" section
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>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
b7356ec7f9 dev-manual: Fixed poor cross-reference
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>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
ba6887404a documentation: Re-write of dev-manual setup chapter
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>
2017-07-12 00:28:13 +01:00
Scott Rifenbark
ed25d7df9c dev-manual, ref-manual: Added procedure for Downloads page
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>
2017-07-12 00:28:13 +01:00
Scott Rifenbark
576af718e6 dev-manual, ref-manual: Added section on index of releases procedure
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>
2017-07-12 00:28:13 +01:00
Scott Rifenbark
8ee16983cb dev-manual, ref-manual: New section on viewing GUI YP repositories
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>
2017-07-12 00:28:13 +01:00
Scott Rifenbark
d3a0e0abc1 dev-manual, ref-manual: Established section on YP source files
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>
2017-07-12 00:28:13 +01:00
Scott Rifenbark
0f00914578 documentation: Reorganized YP introduction material.
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>
2017-07-12 00:28:13 +01:00
Kristi Rifenbark
d6c3c579d0 dev-manual: Updated Using RPM example
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>
2017-07-12 00:28:13 +01:00
Scott Rifenbark
1b36eebc23 dev-manual: Updates to the section on submitting changes to YP
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>
2017-06-22 09:16:45 +01:00
Kristi Rifenbark
33b507e995 dev-manual: Updated checkout by branch
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>
2017-06-22 09:16:45 +01:00
Scott Rifenbark
cf2169b351 dev-manual, ref-manual: Re-wrote the intros
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>
2017-06-22 09:16:45 +01:00
Scott Rifenbark
1e90dd09ff dev-manual: Updated first section title to "Welcome"
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>
2017-06-22 09:16:44 +01:00
Scott Rifenbark
eed50a14fe documentation: Changes section head for sumbitting change to YP
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>
2017-06-22 09:16:44 +01:00
Scott Rifenbark
cd9279ab5c dev-manual: Updated the section on the YP development environment
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>
2017-06-22 09:16:44 +01:00
Scott Rifenbark
e928b5251c dev-manual: Updated "How to submit a change" section.
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>
2017-06-22 09:16:44 +01:00
Scott Rifenbark
652d8cb583 dev-manual: Fixed a DocBook issue with formatting "bug-id"
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>
2017-06-22 09:16:44 +01:00
Kristi Rifenbark
1e1bb0dd42 dev-manual: Updated syntax for oe-run-native script
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>
2017-06-22 09:16:44 +01:00
Kristi Rifenbark
a331904ab2 dev-manual: Fixed two grammar errors
(From yocto-docs rev: 4e68646edf078c23e414a300b37cb30774b28be7)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:44 +01:00
Kristi Rifenbark
b2ad7c74d1 dev-manual: Updated "Kernel Overview" section
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>
2017-06-22 09:16:44 +01:00
Scott Rifenbark
98ba0cd476 dev-manual: Created "Working With Git Repositories" section
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>
2017-06-22 09:16:44 +01:00
Scott Rifenbark
fcb53beee4 documentation: Moved "Git" section to the ref-manual
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>
2017-06-22 09:16:44 +01:00
Scott Rifenbark
c7969c64bb dev-manual, ref-manual: Moved "Workflows" section to ref-manual
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>
2017-06-22 09:16:43 +01:00
Scott Rifenbark
912d73d42b dev-manual, ref-manual: Moved "Licenses" section to ref-manual
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>
2017-06-22 09:16:43 +01:00
Scott Rifenbark
216ee69227 documentation: Moved "Yocto Project Source Repositories" section
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>
2017-06-22 09:16:43 +01:00
Scott Rifenbark
12cc5f7ab2 ref-manual, dev-manual: Moved "Open Source Philosophy" to ref-manual.
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>
2017-06-22 09:16:43 +01:00
Scott Rifenbark
de6d45fefc documentation: Re-org for "closer-look" chapter
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>
2017-06-22 09:16:43 +01:00
Scott Rifenbark
800ee0167a dev-manual: Fixed broken links to "Source Directory" term.
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>
2017-06-22 09:16:43 +01:00
Scott Rifenbark
2ff49eaea0 dev-manual: Fixed broken links to "build-system-term" term
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>
2017-06-22 09:16:43 +01:00
Scott Rifenbark
f42d8f4cf0 documentation: Fixed links for "metadata" term.
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>
2017-06-22 09:16:43 +01:00
Scott Rifenbark
74bf586c94 documentation: Fixed links for "build-directory" term.
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>
2017-06-22 09:16:42 +01:00
Scott Rifenbark
45b16e35b6 documentation: Fixed links to "bitbake-term"
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>
2017-06-22 09:16:42 +01:00
Scott Rifenbark
ed0ecc7b76 dev-manual, ref-manual: Reorganized "Other Information"
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>
2017-06-14 10:19:25 +01:00
Scott Rifenbark
741dddf11a dev-manual, ref-manual: Reorganized Bugzilla information
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>
2017-06-14 10:19:25 +01:00
Kristi Rifenbark
0dae0865ba dev-manual: Corrected grammar error
(From yocto-docs rev: 0d432a6890316207f93c149b865d4a9fc020bfa0)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:25 +01:00
Kristi Rifenbark
6b32207239 dev-manual: Edited grammar error
(From yocto-docs rev: d02aedcd3cf9e30d5d1633ee234af3fcb4a570e3)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:25 +01:00
Kristi Rifenbark
6a54099d1d dev-manual: Edited intro para to devtool upgrade figure
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>
2017-06-14 10:19:25 +01:00
Kristi Rifenbark
aadfed276c dev-manual, sdk-manual: Corrected grammar error
(From yocto-docs rev: ca0843e7651d25e37295094770ca3a97f9150bbc)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:24 +01:00
Kristi Rifenbark
0050fc51d0 dev-manual: Updated "Kernel Modification Workflow" config file location
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>
2017-06-14 10:19:24 +01:00
Scott Rifenbark
7d231fb681 dev-manual: Removed last paragraph of BSP workflow section.
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>
2017-06-14 10:19:24 +01:00
Scott Rifenbark
3cf074a195 dev-manual, mega-manual: Updated kernel overview tree structure figure
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>
2017-06-14 10:19:24 +01:00
Scott Rifenbark
635c5c60dc dev-manual: Slight wording change to be clear.
(From yocto-docs rev: f8b0f3e01249ab94520137ecc60dcc08620a2a96)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:24 +01:00
Scott Rifenbark
8cff6961a9 dev-manual: changed git configuration file name
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>
2017-06-14 10:19:24 +01:00
Scott Rifenbark
f29a05dd85 dev-manual: Formed ordered list for email patch procedure
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>
2017-06-14 10:19:24 +01:00
Scott Rifenbark
3edf5dc104 dev-manual, sdk-manual: Fixed link to Eclipse section
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>
2017-06-14 10:19:24 +01:00
Scott Rifenbark
22bcc7623c dev-manual: Fixed broken link into the setting up Eclipse section
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>
2017-06-14 10:19:24 +01:00
Scott Rifenbark
374f3d6be2 Documentation: Created YP 2.4 "latest" docs
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>
2017-06-04 08:47:14 +01:00
Scott Rifenbark
0241215d3e ref-manual, dev-manual: replaced "depexp" with "taskexp"
(From yocto-docs rev: 3d7a13357a12b70d0c46b8aafdaf2ace20dcb970)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10 12:13:32 +01:00
Scott Rifenbark
d815dfbea3 dev-manual: Cleaned up "Gdbserver" term
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>
2017-05-10 12:13:32 +01:00
Scott Rifenbark
cbea3d8b6b dev-manual: Updated a few occurrences of "dnf" to "DNF"
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>
2017-05-10 12:13:32 +01:00
Scott Rifenbark
bcf22c0bb6 dev-manual: Changed "Dnf" to "DNF" for consistency
(From yocto-docs rev: 22ca6c591fd28995a5444635dc787c67f8af822a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10 12:13:32 +01:00
Scott Rifenbark
b1dc0ee121 ref-manual, dev-manual: Completed first draft of 2.3 migration section.
(From yocto-docs rev: 42ab9e34da640b46d39741c9c83648dc65518ec1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10 12:13:32 +01:00
Scott Rifenbark
c0dc8d492e dev-manual, ref-manual: Updated various wordings and links
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>
2017-04-20 08:16:38 +01:00
Scott Rifenbark
3db3344859 ref-manual, dev-manual: Updates to support recipe-specific sysroots
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>
2017-04-18 15:51:44 +01:00
Scott Rifenbark
94467d5087 dev-manual, ref-manual: Edits to the "Incrementing Binary Package" section.
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>
2017-04-12 19:35:00 +01:00
Scott Rifenbark
f9e7fba02f dev-manual, ref-manual: Created new section on linear revision for packages
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>
2017-04-12 19:35:00 +01:00
Scott Rifenbark
beb301c03a dev-manual: Added section on using headers to interface with devices
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>
2017-04-12 19:35:00 +01:00
Scott Rifenbark
e2232e6813 dev-manual, ref-manual: Added PACKAGE_WRITE_DEPS and concept support
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>
2017-04-12 19:35:00 +01:00
Scott Rifenbark
e0a4972087 dev-manual: Added cross-reference to QA and Test Infrastructure section.
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>
2017-04-12 19:35:00 +01:00
Scott Rifenbark
c53ba427ef dev-manual: Added YP Compatibility feature
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>
2017-04-12 19:34:59 +01:00
Scott Rifenbark
c015fed613 dev-manuual: Replaced "smart" with "dnf"
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>
2017-03-31 12:14:18 +01:00
Scott Rifenbark
1a4c0bfafd dev-manual; ref-manual: Updates to replace "smart" with "dnf"
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>
2017-03-31 12:14:17 +01:00
Scott Rifenbark
17e46eff4a dev-manual: Added cross-reference note into the BSP Guide.
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>
2017-03-24 23:44:03 +00:00
Scott Rifenbark
b3e2ecaae2 documentation: Added support for "pyro" name and May release date.
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>
2017-03-24 23:44:03 +00:00
Scott Rifenbark
f574b9f074 dev-manual, ref-manual: Added support for WKS_FILE_DEPENDS variable.
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>
2017-03-24 23:44:02 +00:00
Scott Rifenbark
70872b9468 dev-manual: Fixed formatting error for arguments.
(From yocto-docs rev: 53153191b83007763d41d9aa8356d88bce88a3d0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-24 23:44:02 +00:00
Scott Rifenbark
6273f91c6a dev-manual: Fixed grammar error - article agreement.
(From yocto-docs rev: 39a7810c668936586455bf8a0331371a27d2dd7e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-24 23:44:02 +00:00
Scott Rifenbark
2ad42e587a dev-manual: Add explanation for signing RPM packages and using signed packages
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>
2017-03-24 23:44:02 +00:00
Scott Rifenbark
90399afd54 dev-manual: Minor corrections to maintaining Open Source lic. comp.
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>
2017-02-19 06:59:51 -08:00
Scott Rifenbark
77afd14e81 documentation: Updated "latest manual" note on title page
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>
2017-02-19 06:59:51 -08:00
Scott Rifenbark
faee9d8c37 dev-manual: Updated the "How to Submit a Change" section.
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>
2017-01-20 11:57:25 +00:00
Scott Rifenbark
3ecc502b8d dev-manual: Added section on bmap-tool to flash images
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>
2017-01-11 17:23:18 +00:00
Scott Rifenbark
a8e9faac40 dev-manual: Added section on bmap-tool to flash images
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>
2017-01-11 17:23:18 +00:00
Scott Rifenbark
50074dfafa dev-manual: Added cross-reference for tool-chain installation.
(From yocto-docs rev: f57728c63cc83c44682fb5a109808a17e1f18485)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-11 17:23:17 +00:00
Scott Rifenbark
4460bed6c2 dev-manual: Updated "Building an Initial RAM Filesystem (initramfs) Image" section
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>
2017-01-11 17:23:17 +00:00
Martin Vuille
5d64b8e076 dev-manual: Fixed "recipetool create" example
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>
2017-01-11 17:23:17 +00:00
Scott Rifenbark
ecaab75be6 dev-manual, ref-manual: Created new section on initramfs
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>
2017-01-11 17:23:17 +00:00
Scott Rifenbark
d229fded3e ref-manual, dev-manual: Removed term "wic-partitioned"
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>
2017-01-11 17:23:17 +00:00
Scott Rifenbark
27751642cd dev-manual: Updated to the "Creating Partitioned Images" section
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>
2017-01-11 17:23:17 +00:00
Scott Rifenbark
12a0ee049e dev-manual: Added note about RPM not dealing with post-install
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>
2016-11-23 11:10:35 +00:00
Scott Rifenbark
479fbee840 ref-manual, dev-manual: Added references to SYSROOT_DIRS
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>
2016-11-23 11:10:35 +00:00
Scott Rifenbark
6ce2cdcc93 documentation: Updates to support developing 2.3 YP docs
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>
2016-11-16 10:38:42 +00:00
Scott Rifenbark
a68b471de3 dev-manual: Fixed typo for "${INC_PR}.0"
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>
2016-11-16 10:38:42 +00:00
Scott Rifenbark
0f86c1d899 dev-manual: Updated "Exporting Tests" section
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>
2016-11-16 10:38:41 +00:00
Scott Rifenbark
0df906b779 dev-manual: Added section for multi-configuration support
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>
2016-10-25 17:55:37 +01:00
Scott Rifenbark
b2f1d21ff3 dev-manual: Re-wrote the remote GDB debugging section.
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>
2016-10-13 23:16:47 +01:00
Scott Rifenbark
551f7d87c9 dev-manual: Applied review comments to "Packaging Externally Produced Binaries"
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>
2016-10-13 23:16:46 +01:00
Scott Rifenbark
96b9007053 dev-manual: Updated "Packaging Externally Produced Binaries"
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>
2016-10-11 08:51:22 +01:00
Scott Rifenbark
b1e4d96e28 documentation: Updated Manual revision table for 2.2
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>
2016-10-11 08:51:22 +01:00
Scott Rifenbark
5f146e508b dev-manual: Added new section on recipe style guidelines
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>
2016-10-11 08:51:22 +01:00
Scott Rifenbark
81698ab05d dev-manual: Fixed missing quote in SRC_URI example.
Fixes [YOCTO #10360]

(From yocto-docs rev: 4a8fce4962ca77f6840294f7942fffd0c3479874)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11 08:51:21 +01:00
Scott Rifenbark
e2083c04c7 dev-manual: Fixed IMAGE_FEATURES examples in debug section.
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>
2016-10-11 08:51:21 +01:00
Scott Rifenbark
6ec45ef53d dev-manual: Update to GPL file finder script.
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>
2016-10-11 08:51:21 +01:00
Scott Rifenbark
5d8a968ecd dev-manual: Applied review changes to GNU debugging section.
Fixes [YOCTO #9554]

Fixed a grammar problem.  Also, provided correct syntax to
two examples.

(From yocto-docs rev: 10eeaf036542696a7037f667feda114dc63527f3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:33 +01:00
Scott Rifenbark
b064c34f12 dev-manual: Updated the example to identify GPL files.
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>
2016-09-28 15:02:33 +01:00
Scott Rifenbark
2199b68fc8 dev-manual: Updated the devpyshell section
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>
2016-09-28 15:02:33 +01:00
Scott Rifenbark
99b9efb993 dev-manual: Updates to the on-target debugging section.
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>
2016-09-28 15:02:33 +01:00
Scott Rifenbark
bbc7a646ec ref-manual, dev-manual: Add information on devpyshell
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>
2016-09-28 15:02:33 +01:00
Scott Rifenbark
9f2cf76e09 dev-manual: Added new GDB debug requirements section for target
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>
2016-09-28 15:02:33 +01:00
Scott Rifenbark
924966f634 dev-manual: Updated the Known issue for QEMU not working in usermode
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>
2016-09-28 15:02:33 +01:00
Scott Rifenbark
8a8349be29 ref-manual, dev-manual: Updates for "staging" discussion and variables.
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>
2016-09-28 15:02:33 +01:00
Scott Rifenbark
1c594557f7 dev-manual: Added new "Dependencies" section to writing new rec.
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>
2016-09-28 15:02:33 +01:00
Scott Rifenbark
b8ad433ff3 dev-manual: Applied review edits to the "writing new recipe"
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>
2016-09-28 15:02:32 +01:00
Scott Rifenbark
285931e0d4 dev-manual, sdk-manual: Applied review comments for SDK movement
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>
2016-09-28 15:02:32 +01:00
Scott Rifenbark
959a062096 sdk-manual, dev-manual: Applied SDK review edits.
* 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>
2016-09-28 15:02:32 +01:00
Scott Rifenbark
39639ad3ea dev-manual: Updates to the "Writing a New Recipe" section.
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>
2016-09-28 15:02:32 +01:00
Scott Rifenbark
ed6a5495a1 documentation: devtool upgrade and quick ref changes to mult manuals
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>
2016-09-28 15:02:32 +01:00
Scott Rifenbark
54a10ca4b2 dev-manual: Updated the devtool upgrade command flow
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>
2016-09-28 15:02:31 +01:00
Scott Rifenbark
5ec03cd359 dev-manual: Updated add and modify flows and text.
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>
2016-09-23 15:27:34 +01:00
Scott Rifenbark
72d1435f20 documentation: Added new description for the PACKAGECONFIG_CONFARGS variable.
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>
2016-09-23 15:27:33 +01:00
Scott Rifenbark
2c38cc69bb dev-manual: Updated QEMU known issues for user-mode
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>
2016-09-23 15:27:32 +01:00
Scott Rifenbark
9ba4fc087e dev-manual, ref-manual: Systemd-boot: Update documents for new EFI bootloader
Fixes [YOCTO #9707]

* Replaced gummiboot with systemd-boot in the dev-manual
* Replaced the gummiboot class with a new systemd-boot class
* Replaced the appropriate gummiboot variables in the glossary
  with new variables SYSTEMD_BOOT_CFG, SYSTEMD_BOOT_ENTRIES,
  and SYSTEMD_BOOT_TIMEOUT.

(From yocto-docs rev: 778b620e65cc68531b3c41aeb8f27f2a07eb0d00)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-25 23:09:29 +01:00
Scott Rifenbark
feda248d59 ref-manual: Various small corrections to package-related stuff
Fixes [YOCTO #10135]

Some small problems were fixed:

 * Added a cross-reference in the FILES glossary entry to the
   PACKAGES variable.  The two are tied and there was not a
   reference to it.

 * Removed a redundant "/" character in a pathname example in
   the dev-manual.

 * Removed a redundant "/" character in an example pathname
   in the FILES glossary description.

(From yocto-docs rev: 11a397c232696deece7ac5c6dafcadb87d7a5775)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-18 23:50:47 +01:00
Scott Rifenbark
813be27f8c dev-manual: Added a new "known issue" for running qemu.
Fixes [YOCTO #9285]

Added a new bullet item to note that Using QEMU in usermode
might not work properly when running 64-bit binaries under
32-bit host machines. In particular, "qemumips64" is known
to not work under i686.

(From yocto-docs rev: 896beb3fddd427f8327d4ddd35be253866c90377)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-18 23:50:47 +01:00
Scott Rifenbark
33e1c39361 dev-manual: Review edits to the package installation section
Fixes [YOCTO #9672]

A couple typos here needed fixed.  Also, a missing statement in
the JSON example.

(From yocto-docs rev: 8756cb363a70a8b77077a666c62c0f678ffb3d3e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19 15:04:48 +01:00
Scott Rifenbark
57acc32724 dev-manual: Edits to the package feed creation section.
Updated the introduction of the trio of variables used for package
feed naming in the "Build Considerations" section.

Fixes [YOCTO #1882]

(From yocto-docs rev: 4c7efd08f9f543dd3c4f2e6d68c72d16fd7b0b8c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19 15:04:48 +01:00
Scott Rifenbark
0689732930 dev-manual: Updated Runtime Testing for Package Installation
Fixes [YOCTO #9672]

Updated the "Exporting Tests" section to reflect the proper
local.conf settings.

Added a new section "Installing Packages in the DUT Without the
Package Manager" that describes how to use a JSON file to accomplish
package installation on a Device Under Test without a package
manager.

(From yocto-docs rev: 0275d2a8234a6418f32e802bcf46b7e68053e05a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-21 12:59:07 +01:00
Scott Rifenbark
26d2f28286 dev-manual: Updated the method to set SimpleHTTPServer for testing
Fixes [YOCTO #1882]

Re-did the steps to set this server up.

(From yocto-docs rev: 45e073a60ef7b1d540439b621266a9019a3d2947)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-21 12:59:07 +01:00
Scott Rifenbark
ca519a1ea5 dev-manual: Applied edits to the package feed section.
Fixes [YOCTO #1882]

(From yocto-docs rev: 12e6b9f21fc6067389ea7632b5991d45173ae2ff)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-21 12:59:07 +01:00
Scott Rifenbark
ac8173ef72 dev-manual: Updated Host Server Machine Setup for package feeds
Removed the extra server instructions and just left the ones
for SimpleHTTPServer.

Fixes [YOCTO #1882]

(From yocto-docs rev: fb502c608b015c37f361f4b54874ad199a67feb4)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-21 12:59:07 +01:00
Scott Rifenbark
508e8908c2 dev-manual: Review edits applied to the package feed build considerations.
(From yocto-docs rev: 0810f8272be51219d03b06d6771a35bbe6d6e552)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-21 12:59:07 +01:00
Scott Rifenbark
7ef4a6593e dev-manual: Updated Package Feed Creation sections
Fixes [YOCTO #1882]

Edited the sections in the "Working with Packages" section
beginning with the "Build Considerations" section with text
received from Daniela Placencia.

(From yocto-docs rev: 07a55662d6ac98875555f80f766de263b131185f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-21 12:59:06 +01:00
Scott Rifenbark
6c5fea2171 documentation: Prepared manuals for a 2.2 release.
* Updated poky.ent to have the appropriate 2.2 variables
* Updated all manual revision tables to have a new entry for
  2.2 - used "Sometime in 2016" for the date.
* Updated the mega-manual.sed file to process internal links
  for 2.2.

(From yocto-docs rev: 2acd49ee197e3e3e725f4cb8cc432437afd8646b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-06 22:53:35 +01:00
Scott Rifenbark
8aebd1cd0a dev-manual: Added Gobject Introspection section.
(From yocto-docs rev: be442bcb971c8685f8a2c6dde92b64479a211e2e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-29 07:48:22 +01:00
Scott Rifenbark
15a93e9a39 dev-manual: Updated the "varname" use to "VARNAME"
This makes the use of this replaceable consistent with the
migration chapter in the ref-manual.

(From yocto-docs rev: 5c2f13f505986d2efc7bfa72c79b933f5a5c5ec1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-29 07:48:22 +01:00
Scott Rifenbark
9f970b6bc1 dev-manual, profile-manual, ref-manual: Purging Oprofile stuff
Fixes [YOCTO #9264]

Several occurrences of tools-profile and the like had to be dealt
with.

(From yocto-docs rev: 62f45579970f47d22dabe921a51c663059a04576)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18 16:28:25 +01:00
Scott Rifenbark
4d5ff5e075 ref-manual, dev-manual: Scrubbed boot-directdisk and bootimg classes
These classes have been removed.  The bootimg class was sucked
into the image-live class.  I removed the reference sections to
both classes and fixed the references throughout the manual set
as needed.

(From yocto-docs rev: 649d56b54987580039cbd52f54642112f810ffad)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18 16:28:24 +01:00
Scott Rifenbark
e975d26e84 documentation: Converted "meta-yocto" to "meta-poky"
Occurrences in many manuals and one figure.

(From yocto-docs rev: 26d30cd162083c62216fb4ab526d0b231f453de1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18 16:28:24 +01:00
Scott Rifenbark
ecb2eb6676 dev-manual: Updated "Additional Implementation Details" section
Fixes [YOCTO #5517]

I added two package management system generic implementation
details to the section.  This brings the section up to speed
as the definitive work on combining multiple versions of library
files into one image.  We no longer have to refer the reader
to a separate wiki page.

(From yocto-docs rev: 450e718ca1b853f332c4e607a5a76efd689f7769)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18 16:28:23 +01:00
Scott Rifenbark
1b7b548960 dev-manual: Updated poky-floating-revisions file snippit example.
Discovered typo in the file... "naivte" instead of "native".

Fixed.

(From yocto-docs rev: baa9fb2b553db425c8a5cfca04d913963e24d0a0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-09 08:00:18 +01:00
Yi Zhao
8d9e233f69 dev-manual: set correct task name for do_kernel_configme
(From yocto-docs rev: bb48ab8518ee89c23a251e98a011d652d6e49af8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-09 08:00:18 +01:00
Scott Rifenbark
133224fb31 documentation: Fixed references using the DISTRO_NAME variable
With the introduction of a DISTRO_NAME_NO_CAP variable, the occurrences
of the DISTRO_NAME variable had to be checked to see if they really
should be using the "NO_CAP" variable instead.  Output and actual
branch names are case-sensitive.

(From yocto-docs rev: 711a3255538298dd3c4bd2af8ad13bc2d159c872)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-06 23:11:59 +01:00
Scott Rifenbark
3831ca0dee documentation: Updated release date in manual history tables.
Updated to "April 2016" for all manuals that use this table.

(From yocto-docs rev: 4d3753cc92c446668b0c383736c2071e24e53dd2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-06 23:11:59 +01:00
Scott Rifenbark
b590fab4a1 dev-manual, ref-manual, sdk-manual: Removing oprofile references.
Fixes [YOCTO #9264]

I handled the occurrences of "oprofile" and "tools-profile" throughout
as I could.  They are not all done yet.  These in this commit have
been removed.

(From yocto-docs rev: d76e264ea210846ad8080134bacd56462ba69d24)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-06 23:11:59 +01:00
Scott Rifenbark
53bade8948 dev-manual: Added new section describing hardware and non-hardware config
Fixes [YOCTO #5092]

Added a new subsection to the "Configuring the Kernel" section to
describe the part of the configuration audit phase that deals
with non-hardware and hardware options.

(From yocto-docs rev: 2545c3f2cf45ffcc9bf9f388d929c8242b74b011)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-06 23:11:58 +01:00
Scott Rifenbark
d94fa00ab5 dev-manual, profile-manual: Removed oprofile section and link
Fixes [YOCTO #9264]

I commented out a large section that had to do with running
oprofile.  Also, located and removed the link to that section
from the profile-manual.

(From yocto-docs rev: 63d6e754f994693c9a4d4b8211c6ef5f817c31f7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-06 23:11:57 +01:00
Scott Rifenbark
2bbf77a6bb dev-manual: Fixed a grammar error
(From yocto-docs rev: 7b81f29a641cad4f10c3c721c0d40ce11d928648)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:09 +00:00
Scott Rifenbark
c3946bcaa6 dev-manual, profile-manual, ref-manual: Updates to remove meta-toolchain
The term "meta-toolchain" is legacy now.  I went through and removed
its use except for where it appears still as output from the
oe-init-build-env script.

(From yocto-docs rev: 1cc134060459278997d57f1293f54091c5404d85)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:09 +00:00
Scott Rifenbark
19e3648390 dev-manual: Edits from a 2.1 read-through.
* Removed some eMenlow stuff
* Cleaned up the description of the BSP structures we have now.
* Various links fixed into the SDK manual.
* Other minor fixes.

(From yocto-docs rev: 5e45005d7ff2254df2754a5ea2d7efd7f1c19a42)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:08 +00:00
Scott Rifenbark
4c5157f7dc ref-manual: Resolving a conflict
(From yocto-docs rev: b364516928d04da38ef3188f07f190ffac64762b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:08 +00:00
Belen Barros Pena
d06c7b8ce6 documentation: remove all references to Hob
Hob and the packageinfo class have now been removed from the
code base. This patch removes all references to:

* Hob
* meta-hob
* packageinfo and
* BBLAYERS_NON_REMOVABLE

from the documentation.

So long, Hob, and thanks for all the fish.

(From yocto-docs rev: 6a1ba2761d5c2ec1072616ce3d791787f1b1b2a7)

Signed-off-by: Belen Barros Pena <belen.barros.pena@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:06 +00:00
Scott Rifenbark
53dd8a06ec dev-manual: Moved "Optionally Using an External Toolchain" to Tasks chapter.
(From yocto-docs rev: e7880667db33c1495d1cbcb91de8c91b9b84dc59)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-11 23:06:05 +00:00
Scott Rifenbark
cd041b7546 dev-manual: Applied review comments to the devshell section.
Applied better wording to a couple areas in this section as
pointed out by the review.

Fixes [YOCTO #9114]

(From yocto-docs rev: f5a402aa08b102c767e112d8df05041650733d54)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:14 +00:00
Scott Rifenbark
a882267b58 dev-manual: Fixed typo in the devshell section.
(From yocto-docs rev: 6dd9cae65d8ae0617c69f57c6df67bfd769ce30c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:14 +00:00
Scott Rifenbark
70c7e36cb4 dev-manual: Created devtool upgrade section.
Created the new section for the devtool upgrade flow.

(From yocto-docs rev: f3a7f78305ce5045604d9892e18b31b7eabcba62)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:14 +00:00
Scott Rifenbark
b2b22d5eda dev-manual, mega-manual, Makefile: Added support for new upgrade flow
Created a new figure for the devtool upgrade flow.  Put the figure
in the "figures" folder of the dev-manual and the mega-manual.
Updated the Makefile to include the new figure when creating
Tarball of the dev-manual and the mega-manual.

(From yocto-docs rev: 4b504f6f179ca7c7e9a69f23fc25b1f33ced8e44)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:13 +00:00
Scott Rifenbark
0b7d8a4c76 dev-manual, mega-manual: Updated the workspace directory structure image
Removed the "mis-spelling" indicators.

(From yocto-docs rev: 558362fa59be94a8ebd29fbdbd932ef88d411272)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:13 +00:00
Scott Rifenbark
050e021d72 dev-manual: Applied review changes to the devtool section.
(From yocto-docs rev: 756cffbc732010f376c6c2362ba33a9061be121c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:13 +00:00
Scott Rifenbark
09ecf38658 dev-manual, mega-manual: Updated three figures for devtool
Made some review changes to the workflow structure, devtool
add flow, and devtool modify flow diagrams.

(From yocto-docs rev: f432d9b0270615974e67a0cc243560fdbfa44724)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:13 +00:00
Scott Rifenbark
f33ffaa3d4 dev-manual: Applied more review comments to the section.
Closing in on the devtool add and devtool modify sections.

(From yocto-docs rev: 202b688c03cc1801576bbed3b771bb329f6b8520)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:13 +00:00
Scott Rifenbark
fe70eb29b3 dev-manual, mega-manual: Updated the devtool modify flow diagram.
(From yocto-docs rev: 54fbb2c739eb696388c622fd755f0417fa98fe5e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:13 +00:00
Scott Rifenbark
eb3b414308 dev-manual, mega-manual: Updated the devtool add flow diagram.
(From yocto-docs rev: eef94731d1eb094623511e1b85a2d8bc47e58b86)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:13 +00:00
Scott Rifenbark
4c5bd3f452 dev-manual, mega-manual: Updated the devtool workspace figure.
(From yocto-docs rev: 7c26a08d7549dd47557386e7037429465732b112)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:13 +00:00
Scott Rifenbark
9cee16bd2e dev-manual: Applied review comments to the devtool section
(From yocto-docs rev: 8bd08b5bbe245e48496b95740d8b205650bd4a35)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:13 +00:00
Scott Rifenbark
c678d1a524 dev-manual: Updated the devtool add section.
(From yocto-docs rev: 3d6efac4a54de21f4c6bba4e3eb3a7c2fcfd33ba)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:12 +00:00
Scott Rifenbark
a09238adc7 dev-manual, mega-manual: Updated devtool add flow diagram
(From yocto-docs rev: 8ae3414d80a7636719184e1b7ae4cc8618ba6887)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:12 +00:00
Scott Rifenbark
7699f0ab60 dev-manual: Added section for devtool modify flow
New figure and some writer notes for now

(From yocto-docs rev: 0a627626f5f353e514b0225b468b0bd0fa3ceef3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:12 +00:00
Scott Rifenbark
1eecaea70d dev-manual, mega-manual: Added new figure for devtool modify flow
(From yocto-docs rev: 2472ab38e0badd50d4e30e161bb56edba4cfbdb2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:12 +00:00
Scott Rifenbark
9582da61de dev-manual: Edits to the devtool-add section.
(From yocto-docs rev: f7f3cfa4a6faa556650b5ab8a04e68c585c30107)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:12 +00:00
Scott Rifenbark
740369fa14 dev-manual, mega-manual: Updated the devtool add flow figure
(From yocto-docs rev: aec89678e191405e7757d322c004de7bd1ab482c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:12 +00:00
Scott Rifenbark
a848e9fec3 dev-manual, mega-manual: Updated the workflow layer content figure.
dev-manual: I did not have the checksum figure there or the sources
directory.

mega-manual: Per normal, had to copy the updated figure into the
figures directory of the mega-manual.

(From yocto-docs rev: d6fb3373b2f3c1e89da87d3e8b9877e643f73c8e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:12 +00:00
Scott Rifenbark
34e08b3373 dev-manual: Added new "writernotes" style.
This style is for review purposes and can be implemented in
the XML file using <para role='writernotes'>.  The text in the
paragraph is rendered red.

(From yocto-docs rev: db990802594af3a70b11e320c06fe6a9dc80579b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:12 +00:00
Scott Rifenbark
17a21e6f73 Makefile, dev-manual, mega-manual: Added new figure support
Created a new figure for devtool add flow.  Added support
for it in the Makefile.  The figure, as usual, needs to
reside in the figures directory in both the dev-manual and
the mega-manual.

(From yocto-docs rev: 2040a31b806fdade060f7a4182a09673b76db7b3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:12 +00:00
Scott Rifenbark
d346c35b19 dev-manual: Applied review comments to devshell section.
Fixes [YOCTO #9114]

Added a "Notes" box to address run script naming points
and the fact that running a task's script is identical to
what BitBake would do when it runs the task.

(From yocto-docs rev: ddfba59743c977a3a3483ed9053434d3c622f698)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:12 +00:00
Scott Rifenbark
3b410498fe ref-manual, dev-manual: Clarifying "native" and "sdknative"
Fixes [YOCTO #8620]

I applied some review comments for the changes made to several
areas in both these manuals.  Minor wording fixes and the
dropping of some changes as directed by Joshua Lock.

(From yocto-docs rev: 71af89da612c37162ba27844c297879d643caf65)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:11 +00:00
Scott Rifenbark
a1970eb17b dev-manual: Updated devshell section.
Fixes [YOCTO #9114]

Added more detail on how to run commands from within the devshell.

(From yocto-docs rev: 6535a8b80bbad3a4ece191c7e5a145ef5e09f1e2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:11 +00:00
Scott Rifenbark
c5b4f69821 ref-manual, dev-manual: Clarification of "native" and "sdknative"
Fixes [YOCTO #8620]

I went through and made some judgement calls on the use of
"native" and "sdknative".  I tried to make sure that the reader
understood the real meaning of these terms.

(From yocto-docs rev: d711e8c6dfb32a4ad79e9d11dbf44fbc759d0245)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:11 +00:00
Scott Rifenbark
41e9f7cdac dev-manual, ref-manual: Updated licensing text information.
Fixes [YOCTO #8634]

To clear up the behavior the COPY_LIC_DIRS, COPY_LIC_MANIFEST,
and LICENSE_CREATE_PACKAGE variable behaviors, I updated the
glossary descriptions of the variables.  Also, added more info
to the "Providing License Text" section in the dev-manual.  Tied
everything together with good referencing.

(From yocto-docs rev: e7b2a1ed29dcd9d572b71f756e7705e6499a05ac)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:10 +00:00
Scott Rifenbark
2a3942bd2a dev-manual: Updated section on adding license text.
Fixes [YOCTO #8634]

I updated the "Providing License Text" section to include some
verbiage on the new CREATE_LICENSE_PACKAGE variable.

(From yocto-docs rev: db2155875dd741000e5f67253486580bba70584f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:10 +00:00
Scott Rifenbark
b2b72143ab dev-manual: Restored ptest-runner2 to ptest-runner
Notified that Anibal wanted this reverted from the commit
that changed it.  This is due to the fact that we now use
the same name for the new recipe ptest-runner instead of
ptest-runner2 to maintain compatibility with old code.

Reported-by: Anibal Limon <anibal.limon@intel.linux.com>
(From yocto-docs rev: a1548ee35a797035247d8fdee6127560db9ead5d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-29 17:04:48 +00:00
Scott Rifenbark
d39e9d1451 ref-manual: Rewrite of "Image Generation" and devtool text.
Rewrite of devtool reference section. This was a separate commit
but got squashed wrong so it ended up with this commit.

The changes to "Image Generation" section reflect the new, more
detailed image generation figure

(From yocto-docs rev: 827c6872b88c17d2d0c8d44b1024fff19076e505)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-29 17:04:47 +00:00
Scott Rifenbark
9f192c81be dev-manual: Updated the devtool help examples.
(From yocto-docs rev: ca02638c515a77986f08c392602df105ab9c185a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-29 17:04:47 +00:00
Scott Rifenbark
4bbd39d00b dev-manual: Grammar fix to kickstart section.
The "Generate an Image Using an Existing Kickstart File"
section had a missing subject.  Fixed it.

(From yocto-docs rev: 7ab6d1422690373e59d681e423a80595879788b4)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-29 17:04:47 +00:00
Scott Rifenbark
75078dd273 dev-manual: Updated wic reference section
Fixes [YOCTO #8844]

Made some changes to reflect the requirement of certain options
when creating a partion such that the partition is automatically
mounted.

(From yocto-docs rev: 096f33b7b7a0360c1df345dd669bbe00723b1882)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-29 17:04:47 +00:00
Anibal Limon
afc6cbaa80 dev-manual: Updated "Running ptset" section
Changed out "ptest-runner" with "ptest-runner2" and updated
wording from "script" to "program".

(From yocto-docs rev: 221d7c6125f5fc02b9ce7bcf177fb382f421ff9f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-15 16:31:17 +00:00
Ed Bartosh
5d2745190f dev-manual: Added the --configfile bootloader option.
(From yocto-docs rev: 649b6cf64a726b0682d756e23e6d56a490ea505e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-07 12:13:46 +00:00
Ed Bartosh
7b3b1f9d31 dev-manual: Added three new wic option descriptions.
* --part-type
 * --use-uuid
 * --uuid

(From yocto-docs rev: 63e08898bc2853789a0a13ce015183a35cf1a92a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-07 12:13:46 +00:00
Ed Bartosh
eeffa647d5 dev-manual: Added the --overhead-factor wic option description.
(From yocto-docs rev: 67d90401faa4992638ed6903fb74388193ff6aec)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-07 12:13:46 +00:00
Ed Bartosh
2beb19b764 dev-manual: Added the --extra-space wic option description.
(From yocto-docs rev: 1c386d5f76eb905487fe59c55618aea02abd1d7e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-07 12:13:46 +00:00
Ed Bartosh
95851dffbe dev-manual: Added wic --notable option description.
(From yocto-docs rev: 5e0594889eee6cff30cf378ac66993439351b486)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-07 12:13:45 +00:00
Ed Bartosh
88a2794b18 dev-manual:
Updated the --source wic command-line option for partition
size details.

(From yocto-docs rev: 3affc38b6a9716316257d1d627185a4d5e9befef)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-07 12:13:45 +00:00
Anibal Limon
6686a3176e dev-manual: Correction to the KVM stuff in the runqemu commands.
Applied this patch from Anibal to correct an earlier patch.

(From yocto-docs rev: 9b944a5f4192b2e03df4ddcba5af4949df7bb8a9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-07 12:13:45 +00:00
Scott Rifenbark
ccc830df1d documentation: Prepare for 2.1 builds
The changes are for the poky.ent file and the mega-manual.sed
file to take care of variables.  Also, entries added for the
manual revision table.

(From yocto-docs rev: 60da39f85165e2d4aef55d456f8203183e089433)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-07 12:13:45 +00:00
Anibal Limon
2e649d79ab dev-manual: Updated runqemu command options list
Since 2.0 release KVM mode does not require VHOST
enablement and a new option was added to support the
old mode.  Updated the list of runqemu command options.

(From yocto-docs rev: 6bca626b163ee5e35e04d659579076ab92c4951a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-11-18 16:42:22 +00:00
Scott Rifenbark
cd48ccccaf dev-manual: Added notes to clarify use of pkg-config
Fixed [YOCTO #8168]

I placed a couple notes in the "Configuration" and "Compilation"
sections within the "Writing a New Recipe" section.  These notes
point out that the build system (as of release 1.7) now disables
several *-config scripts.  The user should be using "pkg-config"
to ensure proper pathname construction and location of these
types of scripts.

(From yocto-docs rev: a46fd0f7b4d5da7bf3b218441ec5b9a6ef552266)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21 23:06:35 +01:00
Scott Rifenbark
2fe3809465 ref-manual, dev-manual: Applied feedback to edit several classes
Fixes [YOCTO #8298]

Updated several classes with feedback from Jose Lamego of Intel.
The feedback fixed some class groupings so that previously isolated
classes could be bundled under common classes (e.g.
autotools*.bbclass).

I scrubbed the cross-references for cases where a particular
class became "undocumented."  The cross-references now point to
the bundled class entry in the ref-manual.

(From yocto-docs rev: 07a533cb41ad26d202f4e303f2dbc7d7bf26e076)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21 23:06:34 +01:00
Scott Rifenbark
b263a3e121 dev-manual: Added CentOS packages to enable runtime tests on QEMU
Fixes [YOCTO #8412]

Forgot about CentOS.  I have added that item in.

(From yocto-docs rev: f298ef74d7366ef01b9b1efcf5b0824a6e1aa742)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21 23:06:33 +01:00
Scott Rifenbark
10970a6e11 dev-manual: Added package requirements for runtime QEMU testing
Fixes [YOCTO #8412]

Added another bullet item that lists the required packages per
distributions needed to enable the runtime QEMU tests.

(From yocto-docs rev: f7e42f9b069e0fd3b419b571554669a89bc843e6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21 23:06:33 +01:00
Maciej Borzecki
08898485e0 dev-manual: Updated devtool build --help example
The wrong command was in the help example in the note.

(From yocto-docs rev: a1ba70d1dcc680c2ddfb8fd5c544f57a29745cbc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21 23:06:32 +01:00
Scott Rifenbark
1944d28000 documentation: Updated files to support 2.0 release.
These updates included editing the poky.ent file so that
DISTRO and related variables are now 2.0.  Also updated all
the title pages to have the manual revision table correct.
Finally, used my email for the manuals.

(From yocto-docs rev: deae61bfbb528ea0ced82399a78260a7f34a7a11)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21 23:06:32 +01:00
Scott Rifenbark
a87268ebbe dev-manual: Updated the Marking Packages information.
Fixes [YOCTO #8375]

Applied some suggested simpler wording for this bulleted item
of information.  Also, did some paragraph editing for better
organization.

(From yocto-docs rev: fd3e277b01ed6fd3580a1c008b1ac05bcfb98f38)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21 23:06:22 +01:00
Scott Rifenbark
54b4aff817 adt-manual: Updated some hard-coded distro values
I found four occurances of "1.8" used in manual.  These needed
to be set to "&DISTRO;" so that they resolve to the latest
YP release.

(From yocto-docs rev: 9db8a2a04085623588e51740a45ee58c500649f6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21 23:06:22 +01:00
Scott Rifenbark
196210ff90 dev-manual: Updated the multilib example.
Fixes [YOCTO #8256]

Applied some review comments to the multilib example.  The
syntax was incorrect.

(From yocto-docs rev: 4e8abf17374535be3b168525ed2bec66fb1ce759)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21 23:06:22 +01:00
Uwe Kleine-Konig
97298fb6d7 dev-manual: Fixed typo in path for wic plugins
Fixes [YOCTO #7910]

Three occurrances of this typo were fixed.

(From yocto-docs rev: f538137c93d4b34c6d5836d9b21b687fb79ae182)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21 23:06:21 +01:00
Scott Rifenbark
5a226f7e3c dev-manual: Changed multilib example
Fixes [YOCTO #8256]

The suggested multilib example in the "Using Multilib" section
was broken.  I replaced the lib32-connman library with the
lib32-glib-2.0 library.

(From yocto-docs rev: fa302dd1b7d71c880815fdc4b9a6764c095d476d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21 23:05:28 +01:00
Scott Rifenbark
6ca549fc31 dev-manual: Added note about building out Autotools projects
Fixes [YOCTO #8261]

Errors are being generated to Eclipse users when building
an Autotools project.  I added a note with steps to avoid
the errors.

(From yocto-docs rev: 7b915bab1b8a321f81453ad00886945c294a1d60)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21 23:05:28 +01:00
Scott Rifenbark
49bcb74203 dev-manual: Applied review edits to devtool section.
(From yocto-docs rev: 2b04710ccb1c63c4dafc2abbb79f5a7feddf43e9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28 18:02:32 +01:00
Leonardo Sandoval
3b9340828a dev-manual: Added a "biosfilename" item to the runqemu command section.
Poky's commit edde3e58da included
the biosfilename option on the runqemu script.

(From yocto-docs rev: 3c834547ace29c14bce6afa0369a727f3afbd650)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28 18:02:32 +01:00
Scott Rifenbark
ab23dd967e yocto-project-qs and others: Rewrite of the QS
This was a complete re-write of the YP Quick Start in an attempt
to streamline it, remove unecessary detail, and make it flow better
with the examples.  In doing so, many manuals were affected due to
section headings being renamed, information being moved, etc.  Here
is a list of the changes by manual:

Makefile - Removed two figures from TARFILE list for the
           yocto-project-qs.

           Added building-an-image.png to the ref-manual TARFILE list.

           Added using-a-pre-build-image.png to the adt-manual TARFILE
           list.

           Repositioned 'eclipse' in the adt-manual TARFILE list.

adt-manual: Fixed a cross-reference so that it goes to the new
            'Building Images' section that is within the YP QS.

            Added new section 'Example Using Pre-Build Binaries and
            QEMU' to hold the information that was formerly in YP QS.

dev-manual: Removed a cross-reference into the YP QS that promised how
            to configure the most efficent build.

            Changed a cross-reference into the YP QS from 'The Packages'
            to 'The Build System Packages'.

            Changed a cross-reference into the YP QS from 'Building an
            Image' to 'Building Images'.

            Changed a text reference from the YP QS to the adt-manual.

            Moved the bit about getting YP files by using the YP website
            from the YP QS to the dev-manual.

            Changed a cross-reference into the YP QS from 'Using Pre-Built
            Binaries and QEMU' to 'Example Using Pre-built Binaries and
            QEMU', which was moved to the adt-manual.

ref-manual: Changed a cross-reference into the YP QS from 'What You
            Need and How You Get It' to 'Setting Up to Use the Yocto Project'.

            Moved the note about if your system has oss4-dev in the
            packages area in the YP QS to the appropriate area in the
            ref-manual.

            Moved the introduction information regarding building an image
            along with the figure from YP QS to the ref-manual's section on
            building images.

toaster-manual: Changed a cross-reference into the YP QS from 'What You
                Need and How You Get It' to 'Setting Up to Use the Yocto
                Project'.

yocto-project-qs: Complete rewrite that changed many section headings and
                  removed much detail, which was placed in other manuals.

(From yocto-docs rev: da4ed8147b04963a700caa784bda709c57b4eb6e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28 18:02:32 +01:00
Scott Rifenbark
4ec8e88a9a documentation: Updated customization layers to point to XSL mirrors
The customization layers were pointing to Sourceforge site for the
XSl files needed to build the manuals.  Throuhgout time, this site
has failed me enough to warrent trying to get these XSL files from
some other source.  Rather than ship the XSL files with the YP release,
we decided to create some mirrors and point the customization files
there.

(From yocto-docs rev: 4fd1703870694dff1f593b421f90aad0803d9e65)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28 18:02:30 +01:00
Scott Rifenbark
540b8ef0f7 dev-manual: Added new section on "defconfig" files.
The "Configuring the Kernel" section did not address "defconfig"
files.  In my opinion, this is a hole in the docs for this section.
I added a new section titled "Creating a defconfig File" that is a
sub-section of the "Configuring the Kernel" section.

Additionally, I added a brief sentence in the introductory paragraph
to include the fact that this new information exists.

Finally, I included the bitbake command that ensures that the
proper configuration steps are minimally run before a user attempts
to use bitbake to get into menuconfig.

Fixes [#YOCTO 7474]

(From yocto-docs rev: 13c0c7dddca59474ef65dacc12f0bfaa38933887)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28 18:02:30 +01:00
Scott Rifenbark
64d74562a1 dev-manual: Updates to kernel configuration in the "Kernel Modification Workflow" section
This section needed some more information.  It referenced the yocto-kernel
script and menuconfig.  I added references to the appropriate areas of
YP documentation for these.  I also changed wordings to that it is
apparent that .config is created by menuconfig when changes are saved.

(From yocto-docs rev: bd1a3f6fa0268635f52bc77d9b35b5110b18a9f8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28 18:02:29 +01:00
Scott Rifenbark
3d2f2b6bdb dev-manual: Added a link to reference defconfig files.
(From yocto-docs rev: 088d5c99562c1c7a192a6734272eae8147657bc8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28 18:02:29 +01:00
Scott Rifenbark
8c43d0fa52 dev-manual: Minor edits to "Configuring the Kernel" section.
(From yocto-docs rev: 26df09f863a0e56748a34efe4a9b2d1b02ccaa99)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28 18:02:29 +01:00
Scott Rifenbark
e05c636bc8 ref-manual, dev-manual: Added info about make race work-around
I updated both the PARALLEL_MAKE and PARALLEL_MAKEINST variables
by expanding the note to indicate how to prohibit parallel make
threads.  Also, added a cross-referencing link to the
"Debugging Parallel Make Races" section.

I added a short note to the start of the "Debugging Parallel Make
Races" section noting that if they can't properly fix the condition,
they can always do a work-around to set the PARALLEL_MAKE or
PARALLEL_MAKEINST variables to null.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: f8dccf3f115647cb039d91415819186cf38fa8bb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28 18:02:28 +01:00
Scott Rifenbark
95108a1c34 dev-manual: Updated requirements for writing a new test.
Fixes [YOCTO #7524]

The "Writing New Tests" section needed more clarification in the first
paragraph.  One requirement is that minimally, an empty __iniit_.py
file must exist in the runtime directory.

(From yocto-docs rev: 519d0ff95e2ffbdb615d6dc27a6c11b393eb4b53)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28 18:02:27 +01:00
Scott Rifenbark
7a8f37daa7 dev-manual: Updates to add Luna support for Eclipse
Adding Luna and dropping Juno. Pretty much went through the
"Working With Eclipse" section and dropped Juno and added
Luna.  A major deletion was the BitBake Commander section using
Hob.  Todor told me to drop this section completely.  Note that
I also added a couple new YoctoProjectTools that appear on the
menu: SystemTap and yocto-bsp.

(From yocto-docs rev: b63ec6c706f41dc4666c2fd79d797962c35f8baa)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-05-03 11:49:35 +01:00
Scott Rifenbark
6e4a1a0936 dev-manual; ref-manual: Fixed &dash; issue
Fixes [YOCTO #7386]

Apparently the "&dash;" ENTITY used throughout the YP manual set to
get literal "-" characters in example commands renders into a unicode
that is not a dash.  This results in users getting errors if they
attempt to cut-and-paste a sample command that uses a "-" character
from the manual into a shell.  I have universally replaced all the
"&dash;" strings in the YP manual set to "-" strings.

(From yocto-docs rev: ef6dbf591eee70866f163e3c98454b6145f4fa3a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-28 16:30:46 +01:00
Scott Rifenbark
9a054c46b4 dev-manual: Applied some formatting for user input.
(From yocto-docs rev: 6a9ff5b63d704fa17edd8c304f6c3c6d8d903090)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-24 11:07:34 +01:00
Scott Rifenbark
87a60a2d1c dev-manual: Fixed link to Toaster Manual.
I found a link that is processed by the mega-manual.sed file correctly
but for the situation it does not resolve right.  The link is a
"naked" link.  In other words, it doesn't have a #<tag> part.
When the .sed file sees these types of links, no hyperlink is
generated.  I found a case in the dev-manual where I reference the
Toaster Manual in general and would like a link that would take the
user there.  So, I had to add a #<tag> part to the link in the XML

(From yocto-docs rev: ab11e9822b5ec1b0f7138f1419ce9c340f6f27ad)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-24 11:07:34 +01:00
Scott Rifenbark
7e1a9d9056 dev-manual: Fixed a cross-ref link that used "here" as the link.
I don't like these.  I fixed it up.

(From yocto-docs rev: 2267fc3353563a249cc9bf16ec0bf4d5930ddaa9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-24 11:07:33 +01:00
Scott Rifenbark
acf537ba82 dev-manual: Added Toaster to the list of ways to develop.
I put this in the intro list for the section that presents various
ways to use YP.

(From yocto-docs rev: 05f924f799a1f1396bf7154b298aabc3d06ad1d7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-24 11:07:33 +01:00
Scott Rifenbark
527cf8266c dev-manual: Removed a cross-ref link to "here"
This practice is not good.  I had one in the manual.  I reworded
the text to not use that term in a link.

(From yocto-docs rev: 53636ae7370827945b31d11785410dd44670bb91)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-24 11:07:33 +01:00
Scott Rifenbark
27471119e0 dev-manual: Updated branch descriptions for better manual maintenance
The "Repositories, Tags, and Branches" section had some wording
that described how branches are maintained in the poky repo that
made it hard to maintain in the doc from release to release.  I had
a list of past releases by name and as such would have to update
it every release to make it reflect the last set.  Well... this
is not the best way to do this and proved out as it slipped through
the cracks for the YP 1.8 release.  Consequently, I recast the text
so it is "release proof".

(From yocto-docs rev: b6e27d06df58a43bb767e9616ccf3c0711e83cf6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-24 11:07:33 +01:00
Scott Rifenbark
966dd9800d dev-manual: Updated the poky definition in the "Terms" section.
Added some stuff about "poky" meaning the default distribution
when using YP and the poky git repository to build an image.

(From yocto-docs rev: bd534a5bdf405044c8f1a60ee9e251bff2a0e53c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-24 11:07:33 +01:00
Michael Wood
d4dc2f8c96 dev-manual: Updated the "Enabling and Using the Tool" section
The send-error-report tool syntax has slightly changed since the
documentation was written.  Removed the [server] part of the
command and added more detail on its use and results.

Reported-by: Michael Wood <michael.g.wood@intel.com>
(From yocto-docs rev: 10e28ab877b327301be536e5d515d5a419d082ac)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-24 11:07:33 +01:00
Ed Bartosh
b8d0927941 dev-manual: Updated "Requirements" section for creating partitioned images
Wic is not using parted and other runtime dependencies from host
system anymore.  It uses native tools instead.  Removed host parted
from the list of requirements.  Added instructions to build native
tools.

(From yocto-docs rev: ab22aff62bd9ffde3dfefe9fcabadc6e5aae7e31)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-24 11:07:33 +01:00
Scott Rifenbark
02881a8d0b documentation: Preparation for 1.9 builds
This involves the following:

 * Inserting a new row for all manual revision history tables
   to have "October 2015" and 1.9 as the release information.

 * Updating the mega-manual.sed file to process links for 1.9

 * Updating variables in poky.ent to deal with the 1.9 release
   variables.

(From yocto-docs rev: 1ed55c08b96cf0fded38833635111a5c6da86781)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-15 15:57:18 +01:00
Scott Rifenbark
82fea808eb dev-manual: Fixed bitbake -c populate_sysroot example.
This was incorrectly stated as 'bitbake -c install' in two
places.  I substituted the correct string.

(From yocto-docs rev: fe54de82cff054d4319c635a0ddba2de7cc6ebd6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-02 17:42:13 +01:00
Scott Rifenbark
223d075788 dev-manual: Removed the detailed section on how to set up and use Toaster
(From yocto-docs rev: f3704c61a6def095cd6632ce2ad223ea84e35dac)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-01 17:35:34 +01:00
Scott Rifenbark
3bb1c76761 dev-manual: Added a small section to note Toaster as a development model.
(From yocto-docs rev: 63e73beca3b7d084c4776f296d3310a31dafcfc4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-01 17:35:33 +01:00
Scott Rifenbark
3237e33c08 dev-manual: Fixed a few broken links and added Toaster manual to list.
(From yocto-docs rev: 77e3a4c704836e599b8ef6b13e68ec783e6d642d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-01 17:35:33 +01:00
Scott Rifenbark
69121f2b5d dev-manual, yocto-project-qs: Dropped Python 2.6 as a requirement
Fixes [YOCTO #7535]

Removed this from two places.

(From yocto-docs rev: d169ce99610745e8c1b4b53d898f526e557af665)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-01 12:59:17 +01:00
Scott Rifenbark
ae4951d976 dev-manual: Updates to the devtool section.
Applied review edits from Paul Eggleton.

(From yocto-docs rev: 4815556b6c9f45ce230afede7cb3b2aadf0bef1c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-01 12:59:15 +01:00
Scott Rifenbark
c41b060c2e dev-manual: Updates to the receiptool section.
Applied review comments from Paul Eggleton.

(From yocto-docs rev: 403c9ae5443eaf2a115e2224f07ee19f98c8139d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-01 12:59:15 +01:00
Scott Rifenbark
2b822400f4 documentation: Updates to try to fix CentOS docs build errors
The docs are not building on CentOS and we think it is due to the
XSL templates being called for the Eclipse parts.  I located all
the "current" templates and switched them out for "1.76.1" version
as are used by the mainstream doc builds.

(From yocto-docs rev: afbddde6524630433dfec973bbe886de32395bc8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-01 12:59:13 +01:00
Scott Rifenbark
a4bd9cdaf2 dev-manual: Added footnote crediting Trevor Woerner for devtool addition.
Trevor wrote a nice paper (tutorial) on the use of devtool that I found
to be very helpful in developing the information for this new workflow.
I decided to publicly credit this effort with a small footnote near
the top of the section.

(From yocto-docs rev: 97d234f2d535f85e5a50ac4e7f0c0a79579cd004)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-01 12:59:13 +01:00
Scott Rifenbark
e1ff065bae dev-manual: Applied review edits to the devtool section.
Paul Eggleton reviewed the section.

(From yocto-docs rev: 82d9750b4349b3c54f73118ec7d65f0bb96e3f7a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-01 12:59:12 +01:00
Scott Rifenbark
4783ead254 dev-manual: Applied review edits to section on hostname changing
Edits to the "Customizing an Image Hostname" section from Ross.
Updated the last paragraph to not imply incorrect information.

Fixes [YOCTO #7417]

(From yocto-docs rev: 8997be297077ee0052a5afbe50b9864cdef14058)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-21 00:00:48 +00:00
Scott Rifenbark
083d4a36a2 dev-manual: Added new section on changing default image hostname
Fixes [YOCTO #7417]

New section to address how the user can change the devalt image
hostname written out to /etc/hostname.

(From yocto-docs rev: 4ac6bc05947e56106aafcc6f9aef93bd93293fba)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-19 12:38:18 +00:00
Scott Rifenbark
1345195137 documentation: Updated Manual revision tables with "April 2015"
(From yocto-docs rev: a012e34956b8ac2fa7610e264f460bc27bdd66d8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-19 12:38:18 +00:00
Scott Rifenbark
186104eeda dev-manual: Backed out the half-done Eclipse Luna changes.
Schedule did not permit support for Luna to complete.  So, I
backed out the half-complete changes to support this version of
Eclipse.

(From yocto-docs rev: 1ca893766047f30ffbb0c99e51e575ea1302e7bc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-19 12:38:17 +00:00
Scott Rifenbark
f7dbbd1879 dev-manual: Removed inc PR step from Quilt workflow
Fixes [YOCTO #7460]

There was a single occurrence of specifically calling out that PR
needed to be manually incremented in the workflow section of the
manual.  It was step 8 of the Quilt flow.  I deleted this step.
Previous edits to the set have included extensive instruction on using
a PR Service, which is basically what replaces the need for manually
updating PR as it was in the past.

(From yocto-docs rev: d8db2175225be45cb3f2b4d11f8281c5b1f40ad4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-19 12:38:17 +00:00
Scott Rifenbark
c504276d26 dev-manual, ref-manual: Replaced &dash;&dash; with "--"
Fixes [YOCTO #7386]

Apparently, copying HTML displayed commands that have a
double dash created through "&dash;&dash;" in the docbook source
causes some issues in the shell.  I have scrubbed the manual set
to replace any "&dash;&dash;" strings with "--".

Reported-by: Paul Eggleton <paul.eggleton@intel.com>
(From yocto-docs rev: e88b813b71d7d6d8acd8a8638f2db71265145b64)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-06 10:44:43 +00:00
Scott Rifenbark
42f5b116da dev-manual: Updates to the "Working Within Eclipse" section.
First edits to update this section to support the Luna version of
Eclipse.  I weeded out Juno, which leaves Luna as the preferred
version and Kepler as a second version if they don't want to update
to Luna.

(From yocto-docs rev: 4f2dc237aa3498402cdf637ac2e85fdf0c3bf8a0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-06 10:44:38 +00:00
Scott Rifenbark
0a2091376e dev-manual: Updates to Eclipse section
Modified the area from which the Eclipse Git repository is located.
This has changed.

(From yocto-docs rev: ec2bf4125877b28dae0681c8b578c7bebec5a5b6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-06 10:44:35 +00:00
Scott Rifenbark
f94b6298d8 dev-manual: Adjusted text for deprecated 3.10 and 3.17 kernels.
These kernels are unsupported for the 1.8 release.  They will still
show up in the YP source repos but the recipes are removed from the
poky area.  Updated all references appropriately.

(From yocto-docs rev: a9adc071409fd31dabc3affec12350c300312600)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-24 23:36:13 +00:00
Scott Rifenbark
46614dab87 dev-manual: Edit to wording in "Avoid Duplicating Include Files"
Changed wording to be more accurate.

(From yocto-docs rev: 1acb7ce94a4f4b02cc50d1e098f04a77d9a53ab3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:17:00 +00:00
Scott Rifenbark
f3410bfc75 dev-manual: Updates to "Avoiding Duplicating Include Files" section.
I removed the last paragraph example as it is not a good example.
Unfortunately, there is not a good example so I replaced it with
a minor suggestive work-around at the end of the first paragraph.

Also, used some <replaceable></replaceable> formatting for the
first paragraph.

(From yocto-docs rev: 6c3989fd4fe41a6434d70208d59747060e62a366)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:59 +00:00
Claudius Heine
b83bed6a3a dev-manual: Fixed reference to TEST_SERIALCONTROL link
Fixes [YOCTO #7256]

In the "Serial Console Connection" section there was a link to
TEST_POWERCONTROL_CMD when it should have been to the
TEST_SERIALCONTROL_CMD variable.

(From yocto-docs rev: 9ec64c86bd4171a017898daa332d2a98fea0358a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:56 +00:00
Claudius Heine
3c7ad6e41f dev-manual: Fixed tc attribute description
The description for "tc" was described as "the called text context..."
rather than "the called test context...".  Updated the description.

Fixes [YOCTO #7269]

(From yocto-docs rev: 0da4437c26225ce0302f10f7ba3c012f1f990c74)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:56 +00:00
Scott Rifenbark
5d19f2bf27 dev-manual: First draft of recipetool section.
(From yocto-docs rev: 3220f98c756291d95da0d9d7cff4aa09e8670ff2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:56 +00:00
Scott Rifenbark
b2a68067f5 dev-manual: Edits to Quilt and finding temporary source code sections
These edits help place the two sections within the new organization
that basically splits out the devtool and quilt methods as ways
of modifying your source code.

(From yocto-docs rev: 1dc2e8783d9774bb98a30e06d114f1c9bfb85b71)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:56 +00:00
Scott Rifenbark
be7e182140 documentation: Reverted back to the 1.76.1 XSL stylesheet
Using the 1.76.1 version in all the customization layers so
the manual revision tables will build with boxes.

(From yocto-docs rev: 85a31ef53a59d17bed23ebf57a14db507eb21338)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:56 +00:00
Scott Rifenbark
4a1ea28ce9 documentation: First draft devtools.
Completed draft of the new devtool material.  This commit affects
some linking and figures across the YP doc set.

* Added the build-workspace-directory.png file to both the
  dev-manual and the mega-manual.

* Updated the Makefile to include the new figure in the TARFILE
  for dev-manual and mega-manual.

* Re-did the section organization to pull the quilt and finding
  source file out of the "Modifying Source Files" section.

(From yocto-docs rev: 4585b9fbb1636ae3c65e2e3ad2d1d6baca636e59)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:55 +00:00
Scott Rifenbark
db030b19a2 dev-manual: Updated the OpenEmbedded build system term.
Added text to note how this term is used, what makes up the
OE BS, and how the term "build system" is used in general.

(From yocto-docs rev: 2af0a59a84fd1cf6d23db29f470cb5644f962746)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:54 +00:00
Scott Rifenbark
7ca1a51cd3 dev-manual: Added OpenEmbedded build system term, dumped build system
The list of terms had a "build system" term that basically
described the OpenEmbedded build system.  I dumped this entry
in favor of "OpenEmbedded build system."  I updated the term's
description to cover the generic term "build system" for no
confusion.

(From yocto-docs rev: 0ada8348a2ace6ce99e640d1c1f21812188151d5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:54 +00:00
Scott Rifenbark
ee80485443 dev-manual: Removed #!/bin/sh -e from the base script form
This start to the script is not really necessary and is in fact
the rare case.  I have removed two occurrences of it in the
"Post-Installation Scripts" section where it was used in code
as the best form to create a script.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: f7c1a1e135e8a9d76005bb6ae7b9cc2810f0af90)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:53 +00:00
Scott Rifenbark
f50e412d84 dev-manual: Updated the QEMUARCH option in the runqemu command.
Found a typo in this list.  The "qemux86-64" should be "qemux86_64".

(From yocto-docs rev: 32f62f51c1574f3a479c12b67aeba7ebcb743a02)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:53 +00:00
Scott Rifenbark
44ddc355ef ref-manual, dev-manual: Removed information about package name alias.
The section on "Handling a Package Name Alias" was confusing and
wrong.  We decided to eliminate it.  The section was removed from
the dev-manual.  The corresponding variable DISTRO_PN_ALIAS
remains for now but without the cross-reference link to the
now missing section.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 9938cdcc8488baffa4252288bf45243055e76fed)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:53 +00:00
Scott Rifenbark
db874ed595 ref-manual, dev-manual, adt-manual, yocto-project-qs: scrub eglibc
Scrubbed out the occurrences of eglibc and replaced them with
glibc.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 868ceda79b1c738349e512e523c850b24f9232ca)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:53 +00:00
Scott Rifenbark
4ab132a20d dev-manual, ref-manual, yocto-project-qs: Updates to parallelism variables
The way the old manual set had worded the use of the
BB_NUMBER_THREADS, PARALLEL_MAKE, and BB_NUMBER_PARSE_THREADS
had become depricated.  It suggested a lot of user intervention
to get these variables set to have the build system utilize
optimal parallelism.  The change a while back to the build system
where the variables are set to the number of build host cores
now makes the variables automatically be set to their best
values.  I have gone through the manual set and changed wordings
appropriately to reflect this.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 3a27b1792c92a2f22173315e2732f672cdad2c78)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:51 +00:00
Scott Rifenbark
d1bd81ed0e dev-manual: Updated examples in "Splitting an Application into Multiple Packages"
The example was out of date.  Updated accordingly.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: b95535fca149abbbe4fee7e74ebc13d2bb376c27)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:51 +00:00
Scott Rifenbark
281c4728d6 dev-manual: Edits to add more detail to where patch files are
Updated some text to indicate that you should put patch files
in $BP, $BPN, or "files."  Also, added more on how the patch
files suffix is (i.e. accounting for compressed suffix names
like diff.bz).

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: d9e23da24e9d86ec5e2b9d4067667478f3e56ba1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:51 +00:00
Scott Rifenbark
6a6687d6d5 dev-manual: Updated text to indicate patch files can end differently
Patch files can end with compressed suffixes such as
diff.gz and patch.bz2.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 69993710d1466dddc804c33c1d76f46d0982d28f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:51 +00:00
Scott Rifenbark
3cd8d861ab dev-manual: Removed unwanted characters from text.
Reported-by: Pascal Bach <pascal.bach@siemens.com>
(From yocto-docs rev: 3ffbebd6c638e9f5b334dfef1d4e0bcc698ae810)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:51 +00:00
Scott Rifenbark
f8245d98ea dev-manual: Updated section on how checksums are dealt with
In the "Fetching Code" section, some loose description of how the
build system reacts to the two checksums in a recipe existed.
Robert asked some questions about how the behavior would be if
just a single, correct checksum existed and if the two existed but
only one proved correct.  Turns out, if you supply a single one then
the build will not throw an error or warning.  If you supply two
but one is incorrect, then the build will throw an error or
warning.  I updated the text to be technically correct without
going into huge details.

(From yocto-docs rev: f49a744821d9326314803d5003158bd402e74e0d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:50 +00:00
Robert P. J. Day
4492b37a06 dev-manual: Replaced lttng-control and lttng-viewer with lttng-tools.
Replace references to these deleted items.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:50 +00:00
Scott Rifenbark
bc4858fe99 dev-manual, ref-manual: Edits to dev manager section and USE_DEVFS var.
Some minor edits to the original patch.  These edits were caught by
Robert P. J. Day.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: b50a2e44eccd50166351611f17c643cbbc60f8b8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:50 +00:00
Pascal Bach
da47cb736b dev-manual: New section on choosing a device manager added.
This patch was modified to fit in with the style of the book.

(From yocto-docs rev: 7c6c7ac573f92bfc844977e0d7a97ca4aac9bc70)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:50 +00:00
Scott Rifenbark
a23e76dbce dev-manual: repaired cross-line link for a <ulink></ulink> pair.
These can't split lines.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:49 +00:00
Scott Rifenbark
f972db3a04 dev-manual: Updates to the "Locate a Base Recipe" section.
Bob Cochran pointed out that the skeleton recipe shown in the
example is not really what is created by newbb.vim.  I updated the
example to match.

(From yocto-docs rev: 2dfa712522aec5204b9e739b6060109090280011)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:49 +00:00
Scott Rifenbark
c037dd7b4c dev-manual: Updates to the "Using .bbappend Files" section.
This section was a bit confusing on the use of "_prepend" as associated
with the FILESEXTRAPATHS statement.  Especially in the final note
where it indicated you don't need "_prepend" if your append file
is not adding any new files.  I updated the note to be more specific.

Another small change I made was to replace the Crown Bay BSP referenced
in the section with the Emenlow BSP, which has a longer life span than
CB.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 35bdc8031bc4ecf1ea321b0cafade97eeaa56513)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:49 +00:00
Scott Rifenbark
1e0797adfe documentation: Removed redundant ID tags that were throwing warnings
When you "make" the mega-manual, there were four tags across the
various manuals where the same string "id='intro'" occurred.  This
causes warnings during the make process.  I updated the strings to
be unique.  There are no cross-references to these so no collateral
issues were caused.

(From yocto-docs rev: d0e770e0ad797031a75e2373a41723408b4b051c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:49 +00:00
Scott Rifenbark
63750d8c11 dev-manual: Updates to using IMAGE_FEATURES and EXTRA_IMAGE_FEATURES
The section "Customizing Images Using Custom IMAGE_FEATURES
and EXTRA_IMAGE_FEATURES" needed a bit more clarification on
the image features.  The text pretty much passed off image
features as all mapping into package groups, which is not true.
Some, like "debug-tweaks for example, are more like general
configurations.  I updated the section accordingly.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 7dd55ff0bd6f7923e22695ed7323df5cfe17d1d4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:48 +00:00
Scott Rifenbark
73588fa725 dev-manual: Updated sysroot location for Eclipse examples.
Fixes [YOCTO #7029]

I was missing the "sysroots" part of the path.  I added this
to the pathname.

(From yocto-docs rev: 077efc8063ed01ef4067f7e71912dd52c1f6a4a6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:48 +00:00
Scott Rifenbark
d250d38974 documentation: Changed back to the "current" XSL style sheet.
I need to get back to how it was working and then fix the table
box issue from there.  Using the 1.76.1 stylesheets makes the
build too long for the manuals and sometimes the XSL sheets do
not load.

(From yocto-docs rev: 7bc502fa069fdc4aebf5705513bb82127716859f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:47 +00:00
Scott Rifenbark
66ad91bd54 dev-manual: Rewrite of the section on customizing images with packagegroups
This section was pointing to a poor example in meta.  I substituted
in a better example and rewrote the section to flow better around
that example and the final fabricated one.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: c7f07a2993d5c1b8e0c8b7da0e9d4c28242a5e26)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:47 +00:00
Robert P. J. Day
c8691a2d44 dev-manual, mega-manual: Updated kernel-overview-2-generic.png file.
There was a sample string in this tree that ended in "ro" when it
should have been "r0" (as in release 0). Anytime you update a figure,
the modified file must go in both the "figures" directory of both
the manual (dev-manual in this case) and in the mega-manual.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 8e75cc23fbf03f355fade416a12b7c8fe1e656a5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:47 +00:00
Robert P. J. Day
0cec924324 dev-manual: Applied wording to warn reader that wikis have dated info.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: ea4489f856417d70b54a7e38da32e068cbd54cbf)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:46 +00:00
Robert P. J. Day
cd37517f97 dev-manual: Add ref to bitbake-layers "add-layer" and "remove-layer"
(From yocto-docs rev: aafc8f1da396a1838ce541706a8162a1493382b3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:46 +00:00
Pascal Bach
b7020b0bb8 dev-manual: Added missing ending quotation to code snippet.
(From yocto-docs rev: 7bf228dbf54e227a06dc69d701b9c83f9c6a2f3a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:46 +00:00
Robert P. J. Day
2674ddb4b0 dev-manual: Some minor fixes to some text.
I applied (in spirit) the changes here... Some literal and some
with changes.

(From yocto-docs rev: 0ccf8a43264981accbe42f729c723804e5b69b72)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-01-06 14:27:03 +00:00
Robert P. J. Day
cf17b6cb72 dev-manual: Minor hyphenation fix.
(From yocto-docs rev: 7a88f5f3a3f826ff4c2a6415c279d1fc4a8cc5f8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-01-06 14:27:03 +00:00
Scott Rifenbark
46f120c85c documentation: Updated all XSL style sheet imports to use 1.76.1 version
This fixes the issue where the lines for the manual revision table
are not appearing.  For some reason they do not appear when building
the docs using Ubuntu 14.10 and the "current" XSL transformation
files.  So, I backed up to the 1.76.1 version, which is the nearest
version where the issue does not surface.

(From yocto-docs rev: 82b15986b97b9ed082b652b562eaaf843572fdff)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-01-06 14:26:59 +00:00
Scott Rifenbark
3a17209e12 dev-manual: Added link to ptest wiki page into Ptest section.
(From yocto-docs rev: 2a9cd5948cd17ce9f7eb5381b27c25f97963578e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09 15:09:06 +00:00
Scott Rifenbark
6a57cb10b7 dev-manual: Added more info to mulit-machine builds section.
Fixes [YOCTO #5400]

Per Martin Jansa, added some information in the bullet item that
talks about the tools and the cases that can cause issues when
tuning things by machine or architecture.

(From yocto-docs rev: e8e47828df65abdc18bbd681c47719a7df77b00f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09 15:09:06 +00:00
Scott Rifenbark
117c9b4a64 dev-manual: Edits to the multi-machine builds section.
Fixes [YOCTO #5400]

I applied some review edits to this section as suggested by
Richard Purdie.

(From yocto-docs rev: a1898cf65537e732e0e42605bb28d636077e7f56)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09 15:09:06 +00:00
Scott Rifenbark
5f4050f73d dev-manual: First draft of "multi-builds" section.
Fixes [YOCTO #5400]

This is the first draft of a new section on multi-machine builds.

(From yocto-docs rev: a47fd17295d943bff482a0747f3b2e69831aa985)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09 15:09:05 +00:00
Scott Rifenbark
9104c1c29c dev-manual: Fixed broken link to the allarch class.
(From yocto-docs rev: 3ec771dffdaf7d42b98371516bbb33f915dfe572)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-11-08 11:15:12 +00:00
Scott Rifenbark
1484e62e5f documentation: Updated the manual revision history tables.
Added an entry for the 1.8 release stating that the release
is slated for sometime in 2015.

(From yocto-docs rev: 9799a7848f24024048eae0cbed470a2be4b4b879)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-11-04 10:28:30 +00:00
Scott Rifenbark
a0aeeff2c6 dev-manual: Updates to "Performing Automated Runtime Testing"
Updated the section to account for some new variables and
several more ways to run tests against expanded targets.  Also
added power control section.

(From yocto-docs rev: a0f08466c00ae51a99d790fa6c9dccef2e0f1518)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-28 22:31:18 +00:00
Scott Rifenbark
e9ecf3fc24 dev-manual, ref-manual: Updated 1.7 migration section with review comments
Applied the second round of review edits from Paul Eggleton.
Minor fixes.

(From yocto-docs rev: 2c7c45c8f09b724e92e8b59fe47834226b44b4fb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18 16:15:28 +02:00
Scott Rifenbark
8eb706a41b ref-manual, dev-manual: Applied migration review edits.
Applied the full set of first draft revision edits for the
new migration section for 1.7.  Comments from Paul Eggleton.

(From yocto-docs rev: 90586addbc719ecaf7c768b267adf0e988e27b74)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18 16:15:28 +02:00
Scott Rifenbark
ba0483c9ed dev-manual: Updated the list of linux-yocto kernels
I removed the linux-yocto 3.4 kernel from the list in the
section describing which kernels we support.  Also, added
the 3.17 linux-yocto kernel to the list.

(From yocto-docs rev: 41f57a9abe1201ed2fb657f8441c97f86f75200a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18 16:15:27 +02:00
Scott Rifenbark
6c3d1192c7 documentation: Updated release date for manual rev tables.
Added "October 2014" to table for all manuals that have the
table.

(From yocto-docs rev: 3f9ceb4dd2397fe907bf701c842277eb65d11a56)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-03 14:41:30 +01:00
Scott Rifenbark
609c216b60 dev-manual: Updated the supported BSP bullet item.
The bulleted item on supported BSPs was very centric on meta-intel.
I rewrote the section to not be so exclusive.

(From yocto-docs rev: d8118bb6124fbbb2340ae8720cd6187fd5546967)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-30 21:37:42 +01:00
Scott Rifenbark
4995908b97 dev-manual: Added reference to the meta-selinux layer.
Fixes [YOCTO #5482]

Added a cross-reference to the meta-selinux layer in the section
that describes how to make images more secure.

(From yocto-docs rev: 0c96273ee857808046c5a76517c1eda4aa703c81)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-23 21:41:55 +01:00
Scott Rifenbark
bff185f625 dev-manual: Added a note to the EXTERNALSRC example about the class
Added a short note after the example that shows how to set up
the EXTERNALSRC variables stating that the externalsrc class
needs to be either globally or locally inherited.

(From yocto-docs rev: db935135c0b060e06f6a63530df995d286002598)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-22 13:04:44 +01:00
Scott Rifenbark
2acf47b6e6 dev-manual: Fixed typo in the make races section header.
(From yocto-docs rev: 26ffb2e47f3caa8a0ab0f2a9cd83af8cdf893cfd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-22 13:04:43 +01:00
Scott Rifenbark
ab7f117b09 dev-manual: Added a second EXTERNALSRC example.
Added a new example on how to set this from the recipe or the
recipe's bbappend file.

(From yocto-docs rev: bc0d9de3378f3462729301e74419b7dede17558b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-22 13:04:43 +01:00
Scott Rifenbark
79fd7f1b25 dev-manual: Updated another EXTERNALSRC example.
Found another occurrance of where I needed to add a <replaceable>
tag set in an example.

(From yocto-docs rev: 586e5a590bb5382a28fde4670fdcd6cbb75f6c32)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-22 13:04:43 +01:00
Scott Rifenbark
018c498d0f dev-manual: Updated EXTERNALSRC example for user-input formatting.
I missed a <replaceable> tag set on the example.  Adding it
clears up confusion for how to use the variable.

(From yocto-docs rev: 8bbf2a012e580d82aaf9c9a98ad5dab1aea64f7b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-22 13:04:43 +01:00
Scott Rifenbark
b4c03a7c28 dev-manual: Added some formatting for user-supplied input.
(From yocto-docs rev: 0b586d27a647d7afcaff0623919dff33a9206632)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-22 13:04:42 +01:00
Scott Rifenbark
f819f3d7b1 dev-manual: General edits to "Common Tasks" chapter.
* Found and fixed several areas with issues.

* Scrubbed for user-supplied input to make it use the
  <replaceable></replaceable> tags.

(From yocto-docs rev: 0e1c7ad31921ee7d4ee0d7d4ece01303a25a5d60)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-22 13:04:42 +01:00
Scott Rifenbark
c2e5449f96 dev-manual: Review edits for GDB without source
Fixes [YOCTO #6621]

Applied a few review edits for this fix.

(From yocto-docs rev: 99511bbcfa1de2f7bf691da1a002913f3a7f6034)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-22 13:04:42 +01:00
Scott Rifenbark
010d19ec2c dev-manual: Misc edits to the model chapter (Chapter 4).
I replaced user-supplied variables with <replaceable></replaceable>
tags to get proper formatting.  I inserted several references
to the new QEMU chapter for help using QEMU.  I updated a note
on the BSP available so that it is a bit more generic and not so
dependent on an exact list within meta-intel and the source
repositories.

(From yocto-docs rev: daef4406e7c3e45dd5d98d565e519d91939f6965)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:32 +01:00
Scott Rifenbark
1ab0c8fb8c dev-manual: Various small edits to Chapter 3.
Replaced angled bracket items for user-supplied variables
with the <replaceable></replaceable> tags.

(From yocto-docs rev: 393af6c0cfbfc0f3921bc1eb1fdbd3dd734f51ae)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:32 +01:00
Scott Rifenbark
4cc5cb151b dev-manual, mega-manual: Updated the downloads picture.
(From yocto-docs rev: 67c71f5a51749e4f15987ce7cb3ae8f22436bb93)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:32 +01:00
Scott Rifenbark
32b508e7ce dev-manual: Misc edits to Chapter 2.
Added some links and fixed up some replaceable items.

(From yocto-docs rev: 5c9ce934f13c68c2efbd952f399a8b88e87eb761)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:31 +01:00
Scott Rifenbark
d677a6839d dev-manual: Added Toaster to the list of other resources.
(From yocto-docs rev: 14652c5aeb7ae54d079f6360c1fa650638f280ab)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:31 +01:00
Scott Rifenbark
5370b58892 dev-manual: Updated section on launching remote GDB.
Fixes [YOCTO #6620]

I altered the path name of the .gdbinit file in the text to prepend
~/ to it to reinforce what file the user must modify.  I also removed
the /home/jzhang string in favor of ~ to make it more general.

(From yocto-docs rev: ff09d3a5666c97598adf385f63dee4b30b0f1792)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:31 +01:00
Scott Rifenbark
932b956b4c dev-manual: Minor edits to the section to add binaries to an image.
Review edits from Paul.

(From yocto-docs rev: 088410d607418531d6ab8a40fdc9d77495b132c9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:30 +01:00
Scott Rifenbark
a20e75f45b dev-manual: Review edits to how to find checksum values.
Edits from Paul to better word this section.

(From yocto-docs rev: 51425ab506050ee5ba30d5c3c10639d5a1b8cc8e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:30 +01:00
Robert P. J. Day
0467e3addf dev-manual: Minor edits via patch to "common tasks" chapter.
(From yocto-docs rev: b1516fb6e6d40e7668ca5a4d5804d1a09c7ed6f8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:30 +01:00
Robert P. J. Day
93f0d03a8d dev-manual: Technical and text edits applied as patch.
(From yocto-docs rev: 703cbe5c037334b3fbf08123b7cc501d36e1e8f0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:29 +01:00
Robert P. J. Day
99a3c1911c dev-manual: Edits to several examples and some typos.
These catches are from Robert P. J. Day and applied as a
patch.

(From yocto-docs rev: b805795e9bf68286aa5b79a94792e2fefd293b92)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:29 +01:00
Robert P. J. Day
034640585f dev-manaul: Small edits to various examples.
(From yocto-docs rev: 6ef54d31664b097b8ceeb5da1b8c48cdc6f673a3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:29 +01:00
Scott Rifenbark
4a226369b7 dev-manual: Updates for checksums and wic
Accidentally put in a couple different things in this one commit.
Oh well.

1. New wording for how the user needs to figure out some checksums
   for a recipe.

2. Fixed up some note placement in the wic reference section.

(From yocto-docs rev: 6c13f49c265c99ddd6dcd4ec3c3c8e66b78824e0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:26 +01:00
Robert P. J. Day
d283686dc3 dev-manual: Minor fixes.
(From yocto-docs rev: 71c9e378c86d03e5fb7f4e459e677ad8a9965f52)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:26 +01:00
Scott Rifenbark
152d307767 dev-manual: Updated manual overview to include new QEMU chapter
Fixes [YOCTO #641]

Added a new bullet to the list that overviews what the manual
covers.

(From yocto-docs rev: 54bdb50df3951346a2e926700681db55bd59a2e1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:26 +01:00
Scott Rifenbark
fb4649297b dev-manual: Edits to the wic reference section.
Pulled a note about future support of commands and options from
the bootloader section and got it up in the higher level intro
section for that part of the manual.

(From yocto-docs rev: f8d677301abcd0d549ea9ad4cca79f43cb2db7f0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:26 +01:00
Robert P. J. Day
f937e05b44 dev-manual: Miscellaneous fixes in the newbie chapter.
(From yocto-docs rev: 34d6bd814e813591631b336f6247c300381fd309)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:26 +01:00
Scott Rifenbark
3152e69383 dev-manual: Created new chapter on QEMU.
Fixes [YOCTO #641]

New chapter added that covers the YP instance of QEMU.

(From yocto-docs rev: 7ca17d02364af7e5924e23df6c138ab4dd2203d6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:26 +01:00
Scott Rifenbark
5f31e281ec dev-manual: Added support for new QEMU chapter.
(From yocto-docs rev: d8a852e244f1c0f4d5ef33f50844bb1cb479cb92)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Scott Rifenbark
25d7b0df2a dev-manual: Modified how to find checksums in the recipes
The section on wrting a new recipe suggested using a "build-fail"
method to get bitbake to return exact checksums for code.  It
was pointed out that this could be a middle-security risk and
that we should not do that but instead get the signatures from
the upstream website.  However, many times those sites don't
provide that information.  I re-worded the text to note the
ideal method (upstream checksums) and then resorted to the
"build-fail" method as a "way" to also get them when the upstream
location does not have them.

(From yocto-docs rev: b06699de2f512b01600bf952a8ee928c2a4c358a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Scott Rifenbark
3be4af9cf3 dev-manual: Applied review edits to the 'wic' section.
I made some small edits to the section based on Tom Zanussi's
review.

(From yocto-docs rev: 560ea7b0eb131e59b190a34cadbe77729e76d61c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Scott Rifenbark
73abcb0b16 dev-manual: Fixed up the list of other references.
There was a bogus link in there to the Build Appliance page.
I also noted many links that use the <ulink> tag that crossed
multiple lines.  That is not good.  I cleaned all that up.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: a39cea47cae29d7efb8e12495e8eefb484d464c4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Scott Rifenbark
231fde5b16 dev-manual: Replaced "--" with &dash;&dash; throughout.
(From yocto-docs rev: 79fb4973909ff3a2ba5da8cad8c3d7bdb4206003)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Tom Zanussi
7ef076cd9e dev-manual: Miscellaneous wic edits.
This is a set of fixes for miscellaneous dev-manual updates noticed
while transcribing wic help for the dev manual.

(From yocto-docs rev: fd2205e2778e2cef86561025fd904f303d64586a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Tom Zanussi
e0aa8f04e9 dev-manual: Miscellaneous updates from the wic help text.
(From yocto-docs rev: 99b04623aa47d07970f91e2bdf648f25ab54c59b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Tom Zanussi
b8a836c0c9 dev-manual: Added --fsoptions to wic
--fsoptions support was recently added to wic, so document it.

(From yocto-docs rev: 91efb698eea438083474c1e905dbaad3fffdbd81)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Tom Zanussi
537e965cc7 dev-manual: squashfs support added to wic section.
squashfs support was recently added to wic, so document it.

(From yocto-docs rev: 22ca1141953b4fae92e15126da296d3d95e80c25)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Tom Zanussi
2a11e9d294 dev-manual: Created new "Plugins" section in the wic section.
Add a new section discussing plugins, taken directly from the
corresponding wic help section.

(From yocto-docs rev: c1b4c378a496413f2dde8ad2f043a537cba24b6e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:24 +01:00
Scott Rifenbark
1a825210d8 dev-manual: Updates to the creating partitioned images section.
Fixes [YOCTO #6511]

Added a new example to this section that shows how to package
up binaries so that you can add them to an image.

(From yocto-docs rev: e52acc444c8f142d0469d7274fb936b5242306ec)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:24 +01:00
Robert P. J. Day
4560e2fc92 dev-manual: Added note and fixed a grammar spot.
(From yocto-docs rev: 934dbe2faff2a553bf281d55edcd6b8de9c31c06)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:24 +01:00
Robert P. J. Day
b1a9074744 dev-manual: Patch to fix some links and references.
Add in a few links to member orgs, and update the BitBake link.

(From yocto-docs rev: 481c89e9b8e219358db8bfdfff0b5b0150247c07)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:24 +01:00
Scott Rifenbark
6ebbf038ab dev-manual: Updated example "foo" recipe name used in examples.
The recipe should be named "foo_1.3.0.bb" instead of
"foo_1.3.0-r0.bb".

(From yocto-docs rev: c34c3ea05d550fc85ab04036856704a7c04fd64c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:24 +01:00
Scott Rifenbark
5ba68f32a8 dev-manual: Added the section on "Creating Partitioned Images"
This is the section on 'wic'.  I have dropped in the same exact
section from the 1.5.3 (dora branch) release as a starting point
for Tom Zanussi to scrub and update for the master branch.

(From yocto-docs rev: e189992bff4249664ba959b1c440541e0b84e03d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-23 10:02:13 +01:00
Scott Rifenbark
ed3cd02d4c dev-manual: Removed not to the PTEST_ENABLED variable.
The note did not need to be there.

(From yocto-docs rev: 5ff94a1a412447c1ed1cda64e985b52545ccd9e7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 19:06:53 +01:00
Scott Rifenbark
08d68e5bc8 ref-manual, dev-manual: Updates to support PTEST_ENABLED.
In the ref-manual, I added a new variable description for the
PTEST_ENABLED variable.

In the dev-manual, I added a note to the "Adding ptest to Your
Build" section to mention that the OpenEmbedded system uses
PTEST_ENABLED to enable or disable building ptests and that
the user does not set this variable directly.

(From yocto-docs rev: 52d6608caaa25378b873e41e1ddd05356ff8629a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:57:10 +01:00
Scott Rifenbark
11bf70bba1 dev-manual: Fixed a couple typos in the Template section.
(From yocto-docs rev: 9285eee037022ed29a0bdc2c9ecc628c63b47e2b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:57:10 +01:00
Scott Rifenbark
9eb3e85557 documentation: Added permalink display styles to CSS files.
Fixes [YOCTO #5772]

Updated each manual's CSS style sheet to contain a style for
how the permalink symbol looks on its own and how it looks
when a user hovers over it with the mouse.

(From yocto-docs rev: c8d4afa0b83a40ac2de0c47c191a11b3e7d241e5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:57:09 +01:00
Scott Rifenbark
01af798187 dev-manual: Fixed a mult-line <ulink> cross-reference
These types of references cannot span multiple lines.  If they
do then mega-manual.sed will not process the link in the
mega-manual.html file.

(From yocto-docs rev: 8a06542c0f1fee503eda12052adddaaf9c94ca91)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:57:07 +01:00
Scott Rifenbark
d785a16dff dev-manual, yocto-project-qs: New section on working with source files.
Fixes [YOCTO #5566]

For the dev-manual, I created a new section called "Working
with Source Files."  In the section, I cover how to set up mirrors
and also how to pre-fetch source using the bitbake -c fetchall
<target> command.

For the yocto-project-qs, I removed the mirror information in the
"Super User" section, which became redundant with the new section
now in the dev-manual.  I also, removed the fetchall variation of
the bitbake command.  Both areas reference into the new section of
the dev-manual now.

(From yocto-docs rev: f314061e3e752d35ea85ed16a60f7f9292180921)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 10:30:50 +01:00
Scott Rifenbark
5112dbd23d dev-manual: Edits to "Creating a Custom Template Configuration Directory"
Fixes [YOCTO #5895]

Some minor edits to the section.  I found a grammar error and a
mis-wording.

(From yocto-docs rev: 86e85512279a1379d9b30825d6af3e508faa320a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 10:30:50 +01:00
Scott Rifenbark
ac6bdb4d41 dev-manual, kernel-dev: Provides some cross-reference to "clean" stuff.
I scrubbed the manual set for appropriate places to reference into the
do_clean* type tasks.  Found and added several occurrences.

(From yocto-docs rev: 01594823b1d556bc70e928af1838039cc15a816d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 10:30:49 +01:00
Scott Rifenbark
a92fcf1c62 documentation: Updated style sheets to remove unused .PNG files.
Fixes [YOCTO #6430]

The style sheets were carrying over old .PNG files that are not
part of the manuals.  I have removed the statements that were
using them.

(From yocto-docs rev: 6e4fa419b9367ab5e34b9aa8010a24980416dc7d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 10:30:49 +01:00
Scott Rifenbark
ad76aa0a94 dev-manual: Small edit to locating the race failure.
Failure occurs during make, not do_compile as I previously
noted.

(From yocto-docs rev: 467ea8aa43fac14e3092a30ae15d1ace7a6558ab)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 10:30:48 +01:00
Scott Rifenbark
7755de2532 dev-manual: Second draft of make race section.
Fixes [YOCTO #6390]

Edits to the "Debugging Parallel Make Races" section.  Changes
originating from trying the procedure.

(From yocto-docs rev: 537f5bd8918450e30ea87465025f0069232cb229)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 10:30:48 +01:00
Scott Rifenbark
1daa2c0e9e dev-manual: First draft of new section on debugging race conditions.
Fixes [YOCTO #6390]

This is a section on parallel make race situations.  The draft
is the first cut at the section.

(From yocto-docs rev: c225d7fe121270a6f82b9fbffa78c7e3914b113d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 10:30:48 +01:00
Scott Rifenbark
a19f575cde dev-manual, kernel-dev, ref-manual: Updated task name usage.
There was inconsistency on how we refer to a task name throughout
the YP manual set.  The proper way is "do_<taskname>".  Some
occurrences did not include the "do_" prefix.  These have been
fixed.

(From yocto-docs rev: b32821bb0d3e6de7bca68b25c662a023526a10c4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 10:30:48 +01:00
Scott Rifenbark
3c22ec98a6 dev-manual: Added XSL templates to support permalinks.
Fixes [YOCTO #5772]

(From yocto-docs rev: 54f7fab50c8ddf9b4ee233610b8fab5b9776e419)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 10:30:47 +01:00
Scott Rifenbark
d9ce6c748c dev-manual: Edit to "Package Archtiture" section.
Added a bit more to the ending of the sentence to qualify
its meaning.

(From yocto-docs rev: 40b309a43d948d5800cfe908e72f6202c095a166)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 10:30:44 +01:00
Scott Rifenbark
3cb04638b4 dev-manual: Edits to "Writing a New Recipe"
Received and implemented some feedback from Paul Eggleton
on this section.  These were unsolicited observations.

Reported-by: Paul Eggleton <paul.eggleton@intel.com>
(From yocto-docs rev: 48ecc543d9f614b5258ab2573f0406aa3c778647)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 10:30:44 +01:00
Scott Rifenbark
59b50ea598 dev-manual: Edits to "Creating a Custom Template Configuration Directory"
Fixes [YOCTO #5895]

I applied some review comments from Paul to tighten up this section.

(From yocto-docs rev: 9f17ad00e9e707fcd6f2419762b4281d64f4ed0f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 10:30:44 +01:00
Scott Rifenbark
95a5fadc15 dev-manual: Edits to the "Understanding Recipe Syntax" section.
Added a new "Overrides" bullet item and fixed some minor issues
pointed out by Paul Eggleton.

(From yocto-docs rev: 44ff3d82985fa304c5641570fe72cf6a8ddabaa3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 10:30:44 +01:00
Scott Rifenbark
a456afa06c dev-manual: Updates to the "Understanding Recipe Syntax" section.
Paul Eggleton sent me some feedback on this section.  I implemented
his suggestions.  Changes were minor.  One included a cross-link
to the BitBake User Manual.

(From yocto-docs rev: e9b5f252a1368b8c231dd659428a18eacf9757af)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 10:30:44 +01:00
Scott Rifenbark
84ee8c653a ref-manual, dev-manual: Updates for custom template configuration directory.
Fixes [YOCTO #5895]

I created a new section in the dev-manual titles
"Creating a Custom Template Configuration Directory" that describes
how the build system uses the template local.conf and bblayers.conf
and conf-notes.txt files as a basis when creating the real
deals in the build directory's conf folder.  The context of this
is so that the user can create their own directory with their own
template files for repeated configurations and to create a custom
conf-notes.txt file should they want the setup scripts to display
some custom list of targets.

I also modified the two script references in the ref-manual for
oe-init-build-env and oe-init-build-env-memres.  I needed to
link to the "how-to" section and added a bit in there about how
the scripts go about forming the conf files in the build directory.

(From yocto-docs rev: c07fb7082fe08387bbc546b2a23620dedc7127b8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 10:30:43 +01:00
Scott Rifenbark
fae1d7d567 dev-manual: Added reference to QA checks in the "Packaging" section.
The "Writing a New Recipe" section has a subsection named
"Packaging."  We needed a cross-reference here to the QA checks
performed for packaging.

(From yocto-docs rev: 34952ee1b56a84e0ee0edd142c7c8c68b122a3e3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 10:30:43 +01:00
Scott Rifenbark
a3b8282d25 dev-manual: Edits to the "Making Images More Secure" section.
Fixes [YOCTO #5482]

I applied some review edits as directed by Paul Eggleton. The
main feature was to merge the information on setting root
and extra user's passwords.  Also, permanently removed the
reference to the wiki that showed the less optimal way of
setting a root password.

(From yocto-docs rev: fef0e17cd3835580abed175ef4a7baf22b9b7673)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 10:30:43 +01:00
Scott Rifenbark
5d14f3c03a dev-manual: Updates to the "Making Images More Secure" section.
Fixes [YOCTO #5482]

Applied extensive review edist from Paul Eggleton throughout
this section.

(From yocto-docs rev: aa0bcd9199c83b43bad2390ff2292a8c2abe7455)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-30 16:32:19 +01:00
Scott Rifenbark
57bd61eabb ref-manual: Edits to the "Making Images More Secure" section.
Fixes [YOCTO #5482]

I added some key references to the section on considerations
specific to the OpenEmbedded build system.  In particular, I
provided some cross-linking back to the extrausers.bbclass
section to reference an example of adding a user account.  I
also split out the topics of adding an extra user and setting
a password on the image in the bulleted list.

(From yocto-docs rev: 19dcd70b9b5aba1bd5e7ce090d5449afcef726bf)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-30 16:32:16 +01:00
Scott Rifenbark
28d5925bdf dev-manual: Updated the "Making Images More Secure" section.
Fixes [YOCTO #5482]

I did some significant re-writing and re-organization of this
section.  It now includes a bit about securing an image in general,
provides general considerations, considerations specific to the
OpenEmbedded build system, pointers to some tools in meta-security
layer, and some other items.

(From yocto-docs rev: a900286992e781f451b3c180726965f5c7172bb9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-30 16:32:16 +01:00
Scott Rifenbark
8e90933d3d dev-manual: Added links to new do_* sections.
With the creation of the new chapter that documents the 51 tasks
defined by the OpenEmbedded build system, the dev-manual had
many first-instance occurrences of do_* task names that could
be cross-referenced to the new sections. I have added these links.

(From yocto-docs rev: 78f91987b0ad9906571ec7888334301492361822)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-13 07:50:58 +01:00
Scott Rifenbark
ab864d71fb dev-manual: Edits to the "Understanding Recipe Syntax" section.
(From yocto-docs rev: 97e5025ccff55efd077fdaf9b2d65eae5b59bc2b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-13 07:50:58 +01:00
Scott Rifenbark
1744a1e5b9 dev-manual: Edits to the "Understanding Recipe Syntax" section.
(From yocto-docs rev: 9808ea79a1e219df794948bd42bc086ab4d56d9f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-13 07:50:57 +01:00
Scott Rifenbark
f7a161253f dev-manual: Added new "Understanding Recipe Syntax" section.
(From yocto-docs rev: d637ba317b22de50e25750e6031defcb707b36e5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-13 07:50:57 +01:00
Scott Rifenbark
d1594eacf7 dev-manual: Added "Properly Versioning Pre-Release Recipes" section.
Fixes [YOCTO #6243]

This section addresses situations when working with recipe
file names of recipes that have not been released (e.g.
recipe-name_1.0.3.rc1).  When the recipe is released the system
has difficulty recognizing the new recipe name as a later version.
So the work-around is to use PV to set the recipe version in
the recipe.  The section describes this.

(From yocto-docs rev: 612379f44e772cfc381e31171ae18af24a9e44fe)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-13 07:50:57 +01:00
Scott Rifenbark
95c6c26fba documentation: Updated the manual revision history tables for 1.7
(From yocto-docs rev: 9014fe95b9607a15c0e72ef1b6df14f250a3d241)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-13 07:50:57 +01:00
Scott Rifenbark
601d5f1af0 dev-manual: Fixed some "systemd" capitalization issues.
I was using this term inconsistently.  I have cleaned it up so
that no initial capital is used.

(From yocto-docs rev: 7dea2c5ef067d81b8350cd54ba4082c35d7077b1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21 22:47:11 +01:00
Scott Rifenbark
0403353623 documentation: Updated all the manual revision history tables.
Set the release date to April 2014.

(From yocto-docs rev: 2592bc968edeea941a92e6bdd321dd872745b78c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21 22:47:10 +01:00
Scott Rifenbark
2648f5d972 dev-manual: Updates to "Performing Automated Runtime Testing"
Fixes [YOCTO #5554]

I worked with Stefan here to update the section on running tests.
We are good now with it all.

(From yocto-docs rev: 806a89f1ddd3efc39d15d3f7e1a01e8fd69af7c1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-19 16:25:02 +01:00
Scott Rifenbark
ac054daa36 dev-manual: Changed GummiBootTarget to GummibootTarget.
(From yocto-docs rev: 0d870778d87dcbb38d1ce577f38b84c8fca0e464)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-19 16:25:02 +01:00
Scott Rifenbark
c4fec0d7ac dev-manual: Edits to "Using the Error Reporting Tool"
Created some sub-section structure to better organize this
section.

(From yocto-docs rev: 61b15f579c4c21378277051bb5905baa4e9741b5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-19 16:25:01 +01:00
Scott Rifenbark
15f128c3b4 dev-manual: Edits to "Using the Error Reporting Tool"
Added Information about setting up your own server.  Paul
Eggleton provided the information.

(From yocto-docs rev: 655bba9b91283dac502658dd72d866a7af4eacce)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-19 16:25:01 +01:00
Scott Rifenbark
583ce2ce46 dev-manual: Fixed typo for AUTOREV.
(From yocto-docs rev: a1fd83f0aeaab95693335150f330bbc7c5af18f8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-19 16:25:01 +01:00
Scott Rifenbark
ce9fb83aa9 dev-manual, ref-manual: Removed VIRTUAL-RUNTIME note from most places.
Fixes [YOCTO #5159]

Edits to fix the occurrences of VIRTUAL-RUNTIME_initscripts = "".
I removed it from all places in the manuals except under
"Selecting an Initialization Manager".  Note that it still
needed removed from "Using Systemd for the Main Image and
Using SysVinit for the Rescue Image".

Also, in the "Using Systemd Exclusively" section I made some
edits as suggested by Paul Eggleton's review.

(From yocto-docs rev: 28b2e3eba3acff17f165899a7f4a65c98263e201)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-19 16:25:01 +01:00
Scott Rifenbark
43de868668 dev-manual: typo fixed.
(From yocto-docs rev: 1bae90e7eb4d53cb0899b2a7b701d525587863d4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-13 12:03:52 +01:00
Scott Rifenbark
f3dccea14a ref-manual, dev-manual: Edits to running tests on hardware
Fixes [YOCTO #5554]

Applied edits to the section in the dev-manual on running tests
on hardware.

Edited the TEST_TARGET and TEST_IMAGE variables.

(From yocto-docs rev: a26ba11c739aabab4009a944d9b622e2814c7fca)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-13 12:03:52 +01:00
Scott Rifenbark
9659789223 dev-manual: Grammar fix to the Toaster section.
(From yocto-docs rev: 36e7ec1a7e01e9f57d670527f6889ea1aa3099cf)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-11 18:22:49 +01:00
Scott Rifenbark
ad3553be2e dev-manual: Applied Toaster section review edits.
(From yocto-docs rev: 362ac25d3fc98268d49f71aae9d477a2a2256c8a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-11 18:22:49 +01:00
Scott Rifenbark
f0e3476705 dev-manual: Added new "Exporting Tests" section.
Fixes [YOCTO #5554]

New section added on exporting tests.

(From yocto-docs rev: b4a818e769acca5559a8e174414c4e214379e292)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-11 18:22:49 +01:00
Scott Rifenbark
ea11a0c770 dev-manual: Added new "Hardware" section for running tests.
Fixes [YOCTO #5554]

This is the section that describes how to enable tests for
actual hardware.

(From yocto-docs rev: fd33b19e7fa32797ab2abd2b506b0d63209fbfc6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-11 18:22:48 +01:00
Scott Rifenbark
cc80d05141 dev-manual: Moved list of qemu-specific run information
Fixes [YOCTO #5554]

The list of items that described what happens when you run
tests is really specific to qemu.  Consequently, it is better
located in the section describing how to enable and get
set up for those tests.

(From yocto-docs rev: 1f0606f1c5c03c873a295819adcfb6fb51c196bd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-11 18:22:48 +01:00
Scott Rifenbark
7406f93121 dev-manual: Updates to the "target" class attribute
Fixes [YOCTO #5554]

In the "Class Attributes" section I updated several items.

(From yocto-docs rev: 8f97671319c4751885e5ec89423a061dd45c6684)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-11 18:22:48 +01:00
Scott Rifenbark
285ffd8307 dev-manual: Updated the "Class Methods" section.
Fixes [YOCTO #5554]

Removed the final bulleted item.  Changed the wording on the
first to account for the manifest file.

(From yocto-docs rev: 50e7557032a0dbf4bc2144e9d4f9a4e1a1726d6d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-11 18:22:48 +01:00
Scott Rifenbark
eb578b09bd dev-manual: Removed note about rm_work
Fixes [YOCTO #5554]

Removed the (second) note  about rm_work builds, that bug
was fixed. (#5072)

(From yocto-docs rev: f1223a67caae17db1abfd6b7465bfc71d295ab7f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-11 18:22:48 +01:00
Scott Rifenbark
9f1c18e22a dev-manual, kernel-dev: Replaced routerstationpro with edgerouter.
Fixes [YOCTO #2444]

Replaced a couple instances where routerstationpro was found.  This
reference BSP is no longer there and has been replaced by
edgerouter.

(From yocto-docs rev: 7ba629cc677310f04a17636e140142695242c5d2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-08 14:20:15 +01:00
Scott Rifenbark
7f6d83a895 documentation: Beagleboard replaced with Beaglebone
Fixes [YOCTO #2444]

Several areas affected by the reference BSP "beagleboard"
being replaced by "beaglebone".

(From yocto-docs rev: 2f02b570e1ebcf0469871b67a029b65fa8b285f2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-08 14:20:15 +01:00
Scott Rifenbark
9814bdfd6d dev-manual: Updates to the Toaster section.
Applied some feedback from Belen and Paul for the section in
light of the 1.6 release.

(From yocto-docs rev: 88bbc526446970c66642c2ae10ad3eba01f74eb3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-08 14:20:15 +01:00
Scott Rifenbark
b02932eb72 dev-manual: Edits to "Providing the Source Code" section.
Fixed some links to the arichiver class.  Also updated the example
to use the new ARCHIVER_MODE variable.

(From yocto-docs rev: 0774ddd2f83586c61f71f1b251fd559ccca45f50)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-08 14:20:14 +01:00
Scott Rifenbark
5d6dcdb837 dev-manual, ref-manual: Added notes for Systemd-based images.
Fixes [YOCTO #5159]

In the dev-manual, I located instances where a note about using
VIRTURAL-RUNTIME_initscripts = "" in the local.conf file would
be appropriate.  Three areas updated.

In the ref-manual, I located the note in the systemd.bbclass
section and the variable descriptions for SYSTEM_AUTO_ENABLE,
SYSTEM_PACKAGES, and SYSTEMD_SERVICE.

(From yocto-docs rev: 57b0acf2f3f8159b635b42dcffa129f7d945eb81)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-04 15:20:17 +01:00
Scott Rifenbark
6ff92a6966 dev-manual, ref-manual: Additions for making an image more secure.
Fixes [YOCTO #3686]

In the dev-manual, I created a new section called
"Making Images More Secure."  The section explains in general
how to enable the security flags.

In the ref-manual, I updated the CFLAGS variable to point to the
new section.

(From yocto-docs rev: 3ed91a46eaf5c1fdf84369ea69951775d87a42da)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-04 15:20:17 +01:00
Scott Rifenbark
d5a0a6b676 documentation: Updates to get rid of PRINC variable.
I did not eliminate this variable but rather changed the description
to indicate that it has been deprecated and that the user should now
use a PR Service to do this stuff.  There were several areas in the
YP manual set that used the variable in code.  I just deleted those
lines from the code.

(From yocto-docs rev: 88a075e6306349e5f8c0d53b5288ef1e64956cd3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-01 10:23:02 +01:00
Scott Rifenbark
e81d0bd961 dev-manual, ref-manual: Removed meta-hob layer from docs.
Hob no longer uses this layer so I removed the two instances in
the YP set where it appeared.

(From yocto-docs rev: 37e3f261bd61a96a2929a525f9896c39658d26f8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-01 10:23:02 +01:00
Scott Rifenbark
df02dd8c65 dev-manual: WIP for YOCTO #5554.
(From yocto-docs rev: 00ecee108d87b5c1044e7b6df702e59f0332035f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-30 10:18:37 +01:00
Scott Rifenbark
f1e9e335ee dev-manual, ref-manual: Added error reporting tool information
Fixes [YOCTO #1562]

In the dev-manual, I created a new section called "Using the
Error Reporting Tool" that describes how to use this feature.
The text was based on information I received from Andreea Proca.

In the ref-manual, I added a new variable entry for ERR_REPORT_DIR
in the glossary and a new report-error class in the class chapter.

(From yocto-docs rev: 70a5538fefcc1b77958fe4b2f29be00354f4137a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-30 10:18:37 +01:00
Scott Rifenbark
aa73618df5 dev-manual, ref-manual: Noting TMPDIR cannot be on NFS
Fixes [YOCTO #5442]

Updated the TMPDIR variable to call out the scenario where a user
might want to separtely set TMPDIR to a local drive and thus be
able to have the Build Directory on NFS.

Updated the "Build Directory" term with a note indicating that by
default, TMPDIR is inside the Build Directory and thus cannot be
on NFS.  However, the user is able to by-pass that per setting
TMPDIR separately outside of the Build Directory.

(From yocto-docs rev: a5a308c512a3f4285bce16f17974dbf6b67432b2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-30 10:18:37 +01:00
Scott Rifenbark
ff5b58e612 ref-manual, dev-manual: Point out "xterm" needed for eclipse use.
Fixes [YOCTO #5766]

In the ref-manual, I added "Eclipse" use in the title for the
"Graphics Support" packages because the "xterm" package is required
for graphics support across all distributions.

In the dev-manual, I specifically called out the need for "xterm"
as a host package at the top of the section describing workflow
with Eclipse.  I also updated the cross-reference links to the
host package and Linux distro requirements to point into the
ref-manual, which is more comprehensive, than into the QS.

(From yocto-docs rev: d3405be506fcb113f01d4fcba4631db80a1ed5dc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-30 10:18:37 +01:00
Scott Rifenbark
b80943fc47 dev-manual: Added notes saying you need to work from same branches
Fixes [YOCTO #4601]

Added a couple notes saying that you need to be in matching
branches for meta-intel and poky.

(From yocto-docs rev: 02bd63829b1d98f21183a10707753e9767bfe68e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 12:29:45 +00:00
Scott Rifenbark
20a17fd0f9 dev-manual: Added more detail for using an external SCM.
Provided more information based on an IRC conversation that
Richard Purdies saw on #yocto.

Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: ec28d9f8f01a6e58ade2954e4e6f2ff1c11aa198)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 12:29:45 +00:00
Scott Rifenbark
c441f5f005 dev-manual, ref-manual: Changed core-image-basic to core-image-full-cmdline
Fixes [YOCTO #2424]

Some imgage names were cleaned up to have more meaningful names.
These doc changes here take care of changing "core-image-basic"
to "core-image-full-cmdline".

Five instances changed.

(From yocto-docs rev: b758f9645e66867b5728da1dd989bae70a216fcc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 12:29:44 +00:00
Scott Rifenbark
97cfb8c453 dev-manual: Added new summary parameter to do_split_packages list.
Fixes [YOCTO #5406]

In the "Making Sure the Packaging is Done" section, I added the
Summary parameter the laundry list of parameters for the
do_split_packages list in the section.  Paul Eggleton reviewed
the change and approved it.

(From yocto-docs rev: 4c4f60ee611921d9f0f835a081b449565382ab90)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 12:29:44 +00:00
Scott Rifenbark
e8c60977c6 dev-manual: Read-thru edits for "Maintaining Open Source License..."
A few minor edits.

(From yocto-docs rev: 6051ad964bda3ba78ea3a75199fda87133cc08fd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 12:29:44 +00:00
Scott Rifenbark
c70b6e8a42 dev-manual: Read-thru edits to "Profiling with OProfile"
Minor edits.

(From yocto-docs rev: 551127f3afa65f36bf9baf21d0ca3e53a2fbb3c1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 12:29:43 +00:00
Scott Rifenbark
46330cd0bc dev-manual: Read-thru edits to "Examining Builds Using the Toaster API"
Minor edits.  Needed to add a few cross-reference links.

(From yocto-docs rev: 47d7c408984a552a6c5d25ac880b50634c576cc5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 12:29:43 +00:00
Scott Rifenbark
eb0a5d5b3b dev-manual: Read-thru edits to "Debugging with the GNU..." section.
Minor edits here.

(From yocto-docs rev: f2d8dfa11af30699f912853814e3dce37b335d34)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 12:29:43 +00:00
Scott Rifenbark
914b3e061b dev-manual: Read-thru edits for "Performing Automated Runtime Testing"
Minor edits.

(From yocto-docs rev: 29b999f259bc9c87ad0b2e3c1d54f5473b66edbc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 12:29:43 +00:00
Scott Rifenbark
128cdcf85d dev-manual: Read-thru edits to "Creating a Read-Only Root Filesystem"
I changed the way I referenced the read-only-rootfs feature. Since
it is something on the right side of a variable equation, I decided
to not render it in a Courier font.  I have quoted it.

(From yocto-docs rev: 90804e71e43cddd3ac7c194a677acaab0c866ed6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 12:29:43 +00:00