Verified a good example and updated the text to match that example.
(From yocto-docs rev: 053467557ef22ce37762222a2997ff9c10be87e8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The value of SDKMACHINE must match the architecture of the machine
on which the SDK installer is being built if you are building an
installer for an extensible SDK. I added a note to this effect.
(From yocto-docs rev: ffdd9a9d00cccf270b5aa236279e6eeea0ff47ed)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the example to more current information.
(From yocto-docs rev: 6952824473f820cbe6d02cba9523c023652f68e3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated some links. Also, rewrote the note about the libraries.
It was inaccurate.
(From yocto-docs rev: a0fce0ed36f3d0668e2d211433e7d93fb8833319)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I corrected some wrong information. Provided the correct terminology
for the build host, and provided quotations for supplied values to
be in line with manual writing conventions.
(From yocto-docs rev: 420a7e96e7145dbef31d706cd257059619f71e12)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made several formatting changes for selections. These should
be using quotes and not being formatted in Courier.
(From yocto-docs rev: ec0a2d7e3cfd78fa4e508d5672f1c8265a3600a4)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Rendered a menu correctly instead of in formatting mode.
(From yocto-docs rev: 7c7da68171dfee037d02fa683c5cba047237fd52)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The step that describes how Eclipse runs the Autotools is too
detailed and can run into problems as Autotools workflow changes.
I made it more general.
(From yocto-docs rev: 5d378a48f7237c620b7fc781b43ee86ea7522432)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Needed to render fields and items from the dialog in normal
text, not in formatted text.
(From yocto-docs rev: 204750e3e2a2e777207d5f2044e38d5482254c46)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Both Neon and Oxygen needed some changes for correct use of the
way we refer to menus and fields.
(From yocto-docs rev: 1cb20243194e61b925df6b0a3b136233f1da8a57)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Used correct formatting for menu items and items fromt the
dialog screens.
(From yocto-docs rev: 9f9d4d65036dc23d193961efb4ae3f236fc8935c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The list in the "Configuring the Neon Eclipse Yocto Plug-In
section should be an ordered list and not a bulleted list.
(From yocto-docs rev: 87926b1fb62f3678bd328af3f018f1b17a982092)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I provided similar wordings in places in this section as were provided
in the parallel "oxygen" section.
(From yocto-docs rev: f4fd33d10363ab84f1f76d3e4bf115df45aef77c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Needed to consolidate a couple steps here. When you add in the
location for the YP Plug-in, it auto-populates the options.
Updated the prose to reflect that.
(From yocto-docs rev: b16963844cd573e5f52289f8948b38a5d4a0f7f1)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The "Configuring the Neon Eclipse IDE" section needed a bit more
information in the note. Telling the users that if some options
are already installed they will not appear in the list.
(From yocto-docs rev: fbee757f102ee51e4db9fb6bdfd516775de8b5e0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Steps indicated you had to be in a clean directory to unpack the
tarball. This is false. You can be in any directory and unpack the
file. Unpacking it puts all the files into a directory named
"eclipse".
(From yocto-docs rev: 3e2fc8d013b51c1a90a44cf32a6cd69e2ef80a22)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed this step to be more accurate.
(From yocto-docs rev: 1a5c25c57a8f5829a8c3302520661def856adb58)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The link was pointing to the Chapter 5 as if it were in a different
manual. The link worked but should have been pointing to the actual
section of the Eclipse flow overview. Fixed it.
(From yocto-docs rev: 4cc906bf383af837855f4c40fc107c77ff6d3ff9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Using consistent wording.
(From yocto-docs rev: fad0230d99259aa94ef3d8db30bc81394b8da4ac)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The step describes the installation process and the intial launch
process. No information exists for describing how you launch
Oxygen from outside the install process. I added a note that
tells where the "eclipse" binary is installed and an example
line to invoke it.
(From yocto-docs rev: dc59410caf18e36497d70ea3c877b4f82f620e2c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided better instructions and accounted for the fact that it
is just this workflow here that is assuming the need for a
YP-built image.
(From yocto-docs rev: a05091768c914817ed262b15d39e7c9b54a5b863)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the "Workflow Using Eclipse" section head to not match so
closely the "Working With Eclipse" section heading. TOC appeared
funny.
Also, updated the step 1 to be more accurate regarding the real
need of having a YP build host and where to go to get information
on setting it up.
(From yocto-docs rev: 1cbca098a2f793bd86b6f73d3d35ce79bdf639f0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Found several items that were slightly off after working through the
procedure. Updates to bring it into line with reality.
(From yocto-docs rev: 0f34afe3c37dedda28a1a5714703787a5dfe649d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Expanded this section to contain a figure of the flow and an
example that showcases the ways to override and use SDK
environment and Makefile variables.
(From yocto-docs rev: 834c059c1df4e8328248ea86fa23ca9a397351fa)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The Makefile-Based Projects section was expanded to add a useful
example and figure. Added this figure to the sdk-manual and
mega-manual figures folders.
Updated the Makefile to include the new figure as part of the
tar files for each manual.
(From yocto-docs rev: 6261cb55b6393e0d5dce91cdb7c8e6e83849ec0c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Autotools is simpler now as it uses "autoreconf" to one-step a bunch
of the existing tools such as aclocal and autoconf. I updated the
figure to reflect the simpler flow and also the steps that accompany
the figure.
(From yocto-docs rev: 380cb1bb89003229befb4715e875586c798d6735)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I wrote the section to include a flow diagram using "make" and
provided a working example highlighting how to override environment
variables.
(From yocto-docs rev: 00e8e09a51a1f0305317f38975a9d7695c92bdb5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Two changes here. One was a note to the "make" step of the
Autotools-based section. I cross-referenced the Makefile section
for information on how SDK installation environment variables
are respected and or overridden when using make variables.
Also, fixed the quotation syntax of the four environment variable
examples used in the "Makefile-Based Projects" section.
(From yocto-docs rev: 5bd4e056496ff3478e213ccd9e49adfe1fac67ab)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New figure for the section on Autotools workflow. The figure
goes in the folders for both the sdk-manual and the
mega-manual.
Updated the Makefile to include the new figure in the tarball
when creating both manuals.
(From yocto-docs rev: ccb2c4b9ebd0b0aaa55b5790eb6a916701e10af4)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Did a re-write of this section with better explanations.
I also pulled the bit about passing parameters to the
configure script into the step that talks about that.
(From yocto-docs rev: 79432ba0eb0cc2f6bdb3410fbf99f227fb666b2c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The line used to be "AC_PROG_INSTALL". I did some digging and can't
really figure out why the example is not following the standard
"helloworld" stuff out there all over the internet. So, I have the
user create a configure.in file as follows now:
AC_INIT(hello,0.1)
AM_INIT_AUTOMAKE([foreign])
AC_PROG_CC
AC_CONFIG_FILES(makefile)
AC_OUTPUT
The original was as follows:
AC_INIT(HELLO,0.1)
AM_INIT_AUTOMAKE([foreign])
AC_PROG_CC
AC_PROG_INSTALL
AC_OUTPUT(Makefile)
(From yocto-docs rev: ed86d61178f86df3248b34d52602121c39bd56b5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The link was going to a spot from which another link was suggested.
Too many redirections for the reader. Linked to the original place
instead.
(From yocto-docs rev: 9fc383a99ae0a7ff8cae761c0c31b27030f765cf)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Formatting used for the "configure" script created using the
"autoconf" command in the example.
(From yocto-docs rev: dd55ceb2c19f9e013c13e776acf7201c25501ff7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The Autotools example called for a "configure.in" file as part
of the "hello-world" example. When working through the example,
a warning occurs saying that the file needs to be "configure.ac".
I changed the example.
(From yocto-docs rev: 7f677e3bbf0331228ed5aed1ace7c55d523d3121)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Needed to reference a couple terms for first use: "cross-development
toolchain" and "OpenEmbedded build system".
(From yocto-docs rev: 2370c3508574efe05e768f4515fec5b17f0ca177)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Minor edits to this section.
(From yocto-docs rev: 68a6e4cac6cecd14e87d4f05f558d79165761d4d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the output to reflect the real command's output. Updated
prose to match (mostly) that used in the similar extensible SDK
sections.
(From yocto-docs rev: fb6c8895f2afda0c43bbaa49870c425e25841ec4)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed some poor writing in this section.
(From yocto-docs rev: 5709c2c2c1c37166ec5df1193b58ff82bb10b4c3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Minor edits.
(From yocto-docs rev: 3ed2c1026bf03feb03001e00daec55b94d7dc35b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed a grammar error and made a few other corrections.
(From yocto-docs rev: 369a22ffe3780fd00514344f1b3b8a944305e320)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a cross-reference to the term "build host". Corrected
a subject/verb grammar error.
(From yocto-docs rev: 8763e333867d0039315f0ca0aa96fdadea676783)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section was poorly organized with a mile long sentence as
the opener. Fixed it.
(From yocto-docs rev: c7624244e40c807d1c3cea80d2eced3cd9948019)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed a few sentences up by providing clearer text.
(From yocto-docs rev: e81984d73c05f2d722bc082a100d01c3cc0173ab)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a cross-reference link to the term "bulid host" and removed
the redundant word "system".
(From yocto-docs rev: 205d6fb6030cecb02301ec9cdc92ac908d250160)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed some prose in various places.
(From yocto-docs rev: f754969eff4c314d9f4c489cca2b3c2f8fd87fff)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updates to prose for better understanding.
(From yocto-docs rev: 44a07560845c973a0da4c27969c740d3d712d323)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated various prose for better understanding.
(From yocto-docs rev: ddbd66d7732bbc8b4940c660f8a8c941a5cc4ea2)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Poor writing left over in here. Updated some of the prose.
(From yocto-docs rev: 8f71cd997c86610dd62780f74f39dad811098540)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Corrected some prose to be clearer.
(From yocto-docs rev: c73f3d486fab555e6c6ac3dd1f5fbaf4d531ab29)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Took out the $TMPDIR part for the output and left more generically
as "Build Output".
(From yocto-docs rev: 4b0375e3293d67e4b5be433cd6c468532fee5a30)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Edits to improve this section.
(From yocto-docs rev: f062882b3b3cf9c454466fa9d243284d97592bdc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added more detail at the top for how the local recipe interacts
with the Upstream Source.
(From yocto-docs rev: c1d49a7c00c458b55396c0efc7a329acd870be6c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Minor edits from the read-through.
(From yocto-docs rev: d165438d3d02f3154fc59197d75ab1cb6a285320)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added more detail on how the upstream source or files from
srctree are located.
(From yocto-docs rev: 5eff4b1b68c232071814969b6367188352639f17)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Had to update the figure to use "Upstream Source" labels and
fix a wrong "devtool edit-recipe" command. That new figure went into
both figures folders for the sdk-manual and mega-manual areas.
Provideds some cleaner wording.
(From yocto-docs rev: 6225d04dd0551a840d929b752225064a222962bc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I changed the way we handle the list of exported variables resulting
from running the *.sh installation script. Rather than list them
all out (they were getting to be quite numerous), I am referencing a
few as examples and recommending the user look at the actual *.sh file
if they would like to examine the entire list.
(From yocto-docs rev: ce2c1491f4f0991cad5f8d4a220a102adb024624)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some Minor edits to this section. Also, a scrub of the list of variables
exported when running the install script. The list is out of date and
is missing many variables. I noted these in comments for now and will
add them in later.
(From yocto-docs rev: 739a2ca42ee798625492ddb51a32ad09f80aa960)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The text had not been updated to include the many architectures
now supported in the Index of Releases toolchain directories.
I added the list of architectures.
Renamed the section to a more appropriate section heading.
Verified the example and put in the latest output.
(From yocto-docs rev: a567f5101d230ef1fa4428e9c6905e9e23bd5855)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I had a section on building an image up in chapter that talks about
getting set up to use YP. I moved the build section to a new parent
section that will hold topics on building various things. I renamed
the section to "Building a Simple Image". I had to fix several links
in the sdk-manual, overview-manual, and dev-manual.
(From yocto-docs rev: c119fc7c6148e7b08acad374fe2981842e9462a3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The "Setting Up the Development Host to Use the Yocto Project" title
changed to "Preparing the Build Host". Fixed links in a lot of
other manual.
(From yocto-docs rev: 00e487e01a0e2a16f5b8d786b3124cbe5115b38b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Now that 2.5 has released, I replaced the ENTITY variable used for
the moving month and year with the actual release month and year
(i.e. May 2018).
(From yocto-docs rev: 2d6e8ddce4fce0c405d2aea69cea2a5b262410f7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added detail for the step one. Clearer.
(From yocto-docs rev: ef95d547180ce53fade7a3764f8d362422472c7a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I found this section a bit loosely worded and could result in
confusion to a user ramping up with YP. I have done an extensive
rewrite focusing on exact wordings.
(From yocto-docs rev: af64c07d259e06fb13572fc224636ed240037b57)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Link was going to the right place but had an old chapter title
name.
(From yocto-docs rev: 57a5d25180429a97d47678c0782198623bc06eef)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This involved changing the root manual folder from
"getting-started" to "overview-manual".
Also, every link using the ENTITY "YOCTO_DOCS_GS_URL" was
changed to "YOCTO_DOCS_OM_URL". Most manuals had several
occurrences of these links.
The makefile needed updating to process the new manual
and not process the old "getting-started" manual.
(From yocto-docs rev: 1abf64e56e9096258038ae37b787a81bf786bb3b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The link to the appendix was referencing Appendix C instead of
Appendix D.
(From yocto-docs rev: b8b4ffe14f74ef0a76289258ae17a3843363397d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The step in the general Eclipse IDE workflow has a step that tells
the user to "Create and Build Your Application." I had a sentence
in that step that suggested if you were not using Eclipse to follow
some sort of procedure. The whole idea of this flow is to be
working within Eclipse. I removed that sentence.
(From yocto-docs rev: 83c35e9bb7190464af840822f5dd66d84e15ec64)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The list headings were not conforming to the capitalization rules
for lists used in the YP manual set, which is significant words
are capitalized in a bolded item of a bulletted or numbered list.
(From yocto-docs rev: af60763b7daccb6af22b4761f6b8370ea1956714)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some minor updates here. Mainly, bring a list into conformance
for use of capitalization in the bolded item heads.
(From yocto-docs rev: a9c9bb36caa146b0ff8338cb1fad850d75a64997)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the various fields for what goes into the name of one
of these *.sh files pulled from the download sites.
(From yocto-docs rev: 4b326ae834d50607062c2f29c27fccd496489eb6)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The note was written such that it appears some performance tools
were just recently deprecated with this release of the Eclipse
Yocto Project plug-in. This is not the case. I updated the
note wording to simply state that those tools are deprecated
with the plug-in.
(From yocto-docs rev: 4e8aa076ec009c71d7ceeda5c64a617e1c2696fb)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made sure that each first occurrence in a chapter used the
"tm" mark.
(From yocto-docs rev: b7b21441b5fc009b8161902a10cfe1863d87b8a8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated section IDs for the new Using Eclipse Neon
Appendix and Chapter 5 Working Within Eclipse (Oxygen).
Changed one link found in reference manual.
(From yocto-docs rev: d767007cf4151127063d1992a4e11e90437ae2da)
Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The original Yocto Project Quick Start is being retired for the
YP 2.5 release (sumo). I have purged all the various references
from the YP manual set and replaced them with references to the
appropriate doc. The references were mainly into the YP
dev-manual for setting up the host or for building an image.
There were a few references into the new "Yocto Project Quick
Build" document for overviewing manual-type references.
(From yocto-docs rev: 11c0ab693962f16f87f1e21f33dd5c6ca6a6f895)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I did some re-wording to account for when the user does a web
search for a manual and the search returns an ancient version
of the manual. Many times the user is oblivious of this fact
and is trying to use a version of the docs that don't come close
to matching the version of the YP.
(From yocto-docs rev: 1cbe06cefda2b35584a8365564e01888d229d0b3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed [YOCTO #12417]
Deleted the appendix.xml file.
Updated the mega manual .xml file to not include
the Mars appendix file.
Updated the sdk-manual.xml file to not include the
Mars appendix file.
(From yocto-docs rev: e7752c3db1aec8d5143e78aab44ec5afaaaf9c76)
Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Did some rewriting to add some references to other sections
in the manual set. Did some other minor clean up.
(From yocto-docs rev: 7e7be31e96a0e73e230b8596b2431716f254e027)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Creation involved removing the overview-manual and replacing it
with the getting-started manual. All links to the string
"&YOCTO_DOCS_OVERVIEW_URL" had to be replaced with
"&YOCTO_DOCS_GS_URL" across the entire YP manual set. I renamed
files used to create the manual with prefixes suited for the
new manual name, which is "Getting Started With Yocto Project".
The style sheet for the new manual needed updating to display the
new .PNG image for the title page. The mega-manual file had to
be updated to include the files. The mega-manual.sed file had
to be updated to include the new manual and not use the overview
manual.
(From yocto-docs rev: 6c7abf9192390121000f577d6c98f259d290d15d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
Added a new chapter to the newly created Yocto Project Overview
Manual. This chapter originated from the YP Reference Manual and
was the old chapter 3, which talked a lot about various concepts.
This information is better suited for the new overview manual.
The change involved moving the entire chapter and renaming it.
This move of the content affected many, many external references
and links into the old area. Consequently, I had to recast all
these links from the different manual.
Changes also included fixing the mega-manual.xml file so that it
would include the new overview manual as part of it.
Many figures had to be relocated as part of the move as well. This
meant deleting them from the ref-manual/figures folder and putting
them into the overview-manual/figures folder.
(From yocto-docs rev: 87b81358f2bbd02b4a0d966d86c4d7b006d4d78f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made the title page notes consistent across the manual set.
Made the author group information consistent as well. It is better
that authorship is seen as a third party and not tied to Intel
Corporation.
(From yocto-docs rev: 32cec087e384e1d92e3e84bbae5c6560a0af3136)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Change the name of the manual to "Yocto Project Application
Development and the Extensible Software Development Kit (eSDK)".
The "sdk-title.png" file was updated and all title information
was updated.
(From yocto-docs rev: 502a49a9e4f5e80efe16507391bc9d9618efefbd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This also affected a link in the dev-manual and some setup stuff
in the mega-manual and sdk-manual.xml file due to a new chapter
being introduced.
This section on the Eclipse stuff is big enough to warrant its
own chapter. I decided to pull it into a separate chapter of its
own.
(From yocto-docs rev: a4b2b605902f09bb200facfabb0a7c355fbf4c87)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The dev-manual title changed to the Yocto Project Development Tasks
Manual. I fixed a link to this title. Also, fixed several external
links that were going to the dev-manual and should have been going to
the ref-manual.
(From yocto-docs rev: 69c0832ea9378d097e85e23e45cec750b8c42042)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Two links that should have been to different places were overlooked.
I fixed these.
(From yocto-docs rev: a1681d065812546a573ed778141289a6b476cecd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
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>
Fixed [YOCTO #11970]
Updated the field description for "Specify Sysroot Location" to
note that the user can have this either downloaded or built and
the ramifications of using a downloaded root filesystem.
Updated the "Deploying and Debugging the Application" steps for
both supported Eclipse versions to tell the user what to do if
a browse operation fails or times out.
(From yocto-docs rev: 623000af186cb5632af551f95384d4c96d4d6c54)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Moved the "Patching the Kernel" section, which was in the
dev-manual to the kernel-dev manual. During the move,
renamed the section to "Using devtool to Patch the Kernel".
This move bothered a lot of links so I had to fix them in
various manuals.
(From yocto-docs rev: a000be1eddf33e4d7de8f350e076d48e27ca4b98)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The steps needed updated to reflect the introduction of CROPS
as a way to prepare a build host.
(From yocto-docs rev: 8f52372afad4c32d0b895a88c2298625e7f53da3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section needed to be a step-by-step procedure.
(From yocto-docs rev: de4868c97c1199b39b3c3e68b4ff159f6546cd9e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section "Locating Pre-Built SDK Installers" was turned into
a procedure. I also added some information on the actual names
of the *.sh files.
(From yocto-docs rev: 548886d5a392164783596c0c04779aaffd6ac930)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The section on the devtool workflow in the dev-manual was 99%
identical to what was in the sdk-manual. I have moved the
workflow procedure from the old "Model" chapter of the dev-manual
to be merged with what was in the sdk-manual. In truth, the
only things added were a note about devtool not being exclusive
to SDK development.
The result of moving (deleting) this section was that the "model"
chapter of the dev-manual went away. The devtool stuff, Quilt,
devshell, and python shell are all out now and there is no
chapter left. So, mega-manual had to be adjusted to not pull that
chapter in when building the dev-manual. I had to delete three
figures that were used in the flow. The figures were already
replicated in the sdk-manual. The figures were deleted from the
figures folder of both the dev-manual and the mega-manual.
I had to make sure all references to the old devtool stuf in the
YP doc set were adjusted.
(From yocto-docs rev: 5dbd643d31ab502df53a22229e457a03da7772b7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
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>
For development purposes, static libraries need to be
present only in the SDK. We do not need those static
libraries in the image for most scenarios. So, replace
IMAGE_INSTALL with TOOLCHAIN_TARGET_TASK in the documentation.
I updated the note to reflect this.
Suggested-by: Maxin B. John <maxin.john@intel.com>
(From yocto-docs rev: c05458c6614c38961d23db8f894d542bf93dbf09)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Moving the "Yocto Project Terms" section from the dev-manual
to the ref-manual broke the links to the "Metadata" term.
I fixed these.
(From yocto-docs rev: 190da4b4d44952d141db26ca72b5bc1a52d77023)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Moving the "Yocto Project Terms" section from the dev-manual to the
ref-manual broke links for the "cross-development-toolchain" term.
I have fixed these.
(From yocto-docs rev: f2d2b5936bd339d691ab859cbe3df86e3da58f0c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Moving the "Yocto Project Terms" section from the dev-manual to the
ref-manual broke several links to the id "build-directory". I fixed
these to reference into the ref-manual now.
(From yocto-docs rev: debe2ae8ce203ebe0f1cee0de54124c15df8bb7e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
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>
poky.ent - changed the "tbd" and "TBD" strings to "pyro" and
"Pyro", respectively.
Manual Head Files - Updated the manual history table with the
May release month.
(From yocto-docs rev: 076226d2986d0cf69685121e4342f50c1603fc7b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #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>
Fixes [YOCTO #10714]
Apparently there is some issues with GTK3 libraries for the Mars
Eclipse version. The note provides a workaround that requires
editing the eclipse.ini file.
(From yocto-docs rev: f940d5d3f7bf446af8f3c7cec5958c8395425a69)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #8584]
Made some edits to tighten this down and make it more efficient.
(From yocto-docs rev: d5a37b77fa5c8df766248849601ca229502bb4ab)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changes to the following:
* All manual revision tables to indicate a 2.3 release proposed
for April of 2017.
* Updated the poky.ent file so that all variables needed reflect
2.3 values.
* Updated the mega-manual.sed file so that processing of links in
the mega-manual work for a 2.3 release.
(From yocto-docs rev: 926e282c17b67c79b94a0b62a0b18bfbe0b26c40)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #8584]
This fix essentially had to document how to add the API
documentation to the standard SDK. The fix required adding a
new appendix to the SDK manual on how to customize that
standard SDK. I could not put just one topic in a new appendix
so I also added a sub-section on how to add indidual packages
to the standard SDK.
Other changes here were the introduction of a new file for the new
appendix, updated the mega-manual.xml file so that it would include
the new chapter when the MM was built. Finally, I added some
cross-referencing to the new appendix from the TOOLCHAIN_HOST_TASK
and TOOLCHAIN_TARGET_TASK variables. And a cross reference from the
distro features section on the api-documentation bullet.
(From yocto-docs rev: 1fb4321ae42253d1fc9602496b5e9e8b495197dd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #8584]
Updated the "Distro Features" section to include the
"api-documentation" feature.
(From yocto-docs rev: 5b4e8fc58b84aea9a940f67f8d7585912fadc676)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
Fixes [YOCTO #10267]
Changed the example to use a single long line.
(From yocto-docs rev: c80d8bb8773b7bbe9c85c48880f42ffb273729b7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
* Removed the note box formatting for the cross-reference
from the sdk-manual and dev-manual sections that
talk about devtool. The reference is now non-note
form and goes to the ref-manual devtool quick ref.
* Added devtool upgrade as a third item in the list that
introduces methods to use devtool.
* Fixed the working on the devtool finish step 5 for both
the dev-manual and sdk-manual.
* Renamed the new chapter that describes different projects
you can use devtool on. The focus is on using the SDK
toolchain directly.
* Scrubbed the entire sdk-manual for the term "toolchain
installer" and replaced with "SDK installer".
(From yocto-docs rev: 6d4daef49cc6d54a700a8c3965c9e8814f75d20a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I extracted the sections on Makefile, Autotools, and Eclipse into
their own new chapter. Seemed to make sense as they are projet
types for both standard and extensible SDK types. Also, swapped
the order of appearance from standard first to extensible first.
This swapping caused a bit of rewriting.
(From yocto-docs rev: 138a4d5576123da800a8fd8d99462a138ceeb743)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Did the following:
* Added the devtool upgrade flow to the SDK manual.
* Removed the devtool Quick Reference from the dev-manual and
added it as a new chapter to the ref-manual.
* Made sure all the links and cross-references work now with the
moved material.
* Updated the Make file so that the manual set builds correctly
regarding the new chapter in the ref-manual.
* Created cross-referencing notes in both the sdk-manual and the
dev-manual to the newly located devtool Quick Reference chapter.
(From yocto-docs rev: fda0bf68b3654b1b96407d552c5254657465b5fc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I needed a new figure and a new section.
(From yocto-docs rev: d413ca7b9b946450af7c2c15ab0e68e9181517e9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These notes can't be in the final version of the manual.
Now is the time to get them out.
(From yocto-docs rev: 600b4f2c7360b30d12fdc7ed0f5ba41bc09fc778)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10032]
The fix to remove the BitBake Commander from the tools to install
when dealing with the Eclipse Yocto Plug-in has happened.
Consequently, I removed the developer notes in the manual stating
that the Commander was still showing up there. The manual set
is now clean of this stuff.
(From yocto-docs rev: fbe169b086faac571de8a2ebd9d32682162cfd31)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10267]
The example works better using OECORE_TARGET_SYSROOT for the
aclocal line. I changed it to that.
(From yocto-docs rev: 362b786e7bf2083c5809e961f61c0ad81b778d71)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A new command devtool finish has superceded the final commands
in the SDK workflow. I updated the two figures (add and modify)
to reflect this new flow. I also updated the ordered number list
to match reality.
(From yocto-docs rev: 0ba31e730cd748d06eab8d46b38764cda5c4e3bd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a new variable description for SDK_INCLUDE_TOOLCHAIN.
Along with the new glossary entry, I updated a couple places
where it would be relevant to cross-reference the new variable.
(From yocto-docs rev: df99b097595e7488a93354082b8d9f33acd9c229)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided clearer instruction on how to set up a new SSH
connection when deploying an application to QEMU.
(From yocto-docs rev: 93adc542a40e86377380684e1ce294edd0fd7268)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #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>
