Commit Graph

22 Commits

Author SHA1 Message Date
Scott Rifenbark
dbe100d6bb sdk-manual: Removed all references to Eclipse
Took care of links as well.

(From yocto-docs rev: a338dc13ebbcdc77fb16e36f12eb5f0e1e05187f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
402b7ce9df sdk-manual: Updated the "Makefile-Based Projects" section.
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>
2018-06-15 11:26:47 +01:00
Scott Rifenbark
0a764481ed sdk-manual: Review edits to the "Autotools-Based Projects" section.
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>
2018-06-15 11:26:47 +01:00
Scott Rifenbark
b15903d61b sdk-manual: Updates to the "Makefile-Based Projects" section.
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>
2018-06-15 11:26:47 +01:00
Scott Rifenbark
e8127d4fc4 sdk-manual: Added cross-reference to Makefile section. Fixed syntax
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>
2018-06-15 11:26:47 +01:00
Scott Rifenbark
61a7ab26ee sdk-manual: Updated the Autotools workflow example.
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>
2018-06-15 11:26:46 +01:00
Scott Rifenbark
9da094bb75 sdk-manual: Changed "configure.ac" file in the autotools-based example
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>
2018-06-15 11:26:46 +01:00
Scott Rifenbark
8ac16cc0a4 sdk-manual: Updated link to variables set for cross-toolchain script
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>
2018-06-15 11:26:46 +01:00
Scott Rifenbark
15728cd041 sdk-manual: Updated formatting for "configure" script
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>
2018-06-15 11:26:46 +01:00
Scott Rifenbark
ca3f701a98 sdk-manual: Replaced "configure.in" with "configure.ac"
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>
2018-06-15 11:26:46 +01:00
Scott Rifenbark
5b804813fc sdk-manual: Added cross-referencing to "Autotools-Based Projects"
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>
2018-06-15 11:26:46 +01:00
Scott Rifenbark
95e451e748 sdk-manual: Updates to the "Using SDK Toolchain Directly" chapter
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>
2018-05-24 17:16:10 +01:00
Scott Rifenbark
34befd259d sdk-manual: Split the Eclipse section into a separate chapter
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>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
2e0a818ba7 sdk-manual: Fixed two links to changed dev-manual title.
(From yocto-docs rev: 2cc71fb47c5281a981509fcd0f31f9100471f841)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:06 +00:00
Scott Rifenbark
4925a29322 sdk-manual: Updated Eclipse information
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>
2017-09-02 00:52:49 +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
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
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
1d5745f959 sdk-manual: Fixed link to Neon download site.
Fixes [YOCTO #11263]

(From yocto-docs rev: c7e68a533045ff482b5fc022886df58e199dd4b7)

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
7ff22fc572 sdk-manual: Fixed example in "Passing Host Options"
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>
2016-10-11 08:51:21 +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
fe8d575433 sdk-manual: New Projet chapter added and other fixes
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>
2016-09-28 15:02:32 +01:00