Commit Graph

237 Commits

Author SHA1 Message Date
Scott Rifenbark
7e7b066085 YP 3.1 Docs: Updated Manual revision tables.
Scrubbed so subsequent releases are relevant to the
initial release only.

(From yocto-docs rev: 7bb2c4f851aa968eb05b11c5471b81962f268eba)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-12-16 23:32:33 +00:00
Scott Rifenbark
292b0cc224 YP Documentation: Set up for YP 3.1 release
* Updates to poky.ent
* Updates to mega-manual.sed
* Updates to all <manual>.xml files for date

(From yocto-docs rev: 5f752ef0193cb60cd5d46a63e99ffcd02107e0c2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-12-09 12:02:54 +00:00
Scott Rifenbark
3eb09fd737 documenation: Changed "2.8" to "3.0".
I was using "2.8" throughout the manual set instead
of "3.0".  Updated all aspects to "3.0".

(From yocto-docs rev: db19937e98c59d4d2a9ce89877be3c8e0b05991a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23 17:15:53 +01:00
Scott Rifenbark
25efbee1d7 sdk-manual: Updated devtool to talk about oe-local-files.
Fixes YOCTO #13079

Bug is about making sure the section on the devtool command
talks about oe-local-files.  Two devtool commands (modify
and upgrade) needed to mention the role of the oe-local-files
area and how it is used during these commands.  I updated the
appropriate sections:

 * Use devtool modify to Modify the Source of an Existing Component
 * Use devtool upgrade to Create a Version of the Recipe that
   Supports a Newer Version of the Software.

(From yocto-docs rev: 70ed68eca6dcb5b1f1b5638fd27a7b513b65661e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-07-18 12:16:53 +01:00
Scott Rifenbark
d52682c054 sdk-manual: Added link to BB manual fetcher section.
In the "Use devtool upgrade to Create a Version of the Recipe
that Supports a Newer Version of the Software" section, we
reference "fetchers" but do not link to the section on them
in the BB manual.  I added a link.

(From yocto-docs rev: 633ac78daa2ab3bdde17ecb1a203f6addd6ee4af)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Scott Rifenbark
3693f075c4 documentation: Prepared for 2.8 release
poky.ent - variables all set up for 2.8
mega-manual.sed - "2.7" replaced with "2.8"
<folder>.xml - manual revision history tables updated.

(From yocto-docs rev: 6092a9282cbd397a2f64ca74361f862ea76b0e28)

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
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
c5bb614ca7 sdk-manual: Removed all references to Eclipse
One Neon appendix completely removed.  One other chapter
removed that held the latest version of Eclipse use
removed.  A figure was also removed.

(From yocto-docs rev: 03524fc363f9232a2ed45d10688ddeb0439b0917)

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
c18fe9eb64 Documentation: Removed customization.xsl files for Eclipse
The help files for YP manuals used in the Eclipse application
are no longer supported.  I removed the individual
*-customization.xsl files for the individual YP manuals.

(From yocto-docs rev: 8c19244298b2c95ac92a398a5b6d3aca788f075e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:40 +01:00
Gianfranco Costamagna
f9d789820b kernel-dev, sdk-manual: Unified question spacing
unify the spacing for questions in various places
e.g. before the [Y/n] there should be a space, and before
"?" there should be none. Unify the questions where the
system expect an answer from the end user

(From yocto-docs rev: 0643b2e22273a798b96f126931885efd733e5f89)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-04-09 22:16:06 +01:00
Scott Rifenbark
dfe7b95ea4 documentation: Preparing for 2.7 release.
Updated poky.ent to have variables for 2.7.
Updated mega-manual.sed file to use "2.7" string.
Updated all <manual>.xml Manual History Tables to use "TBD"

(From yocto-docs rev: d6f8bbd6e107913265ea1ac95ab8817e199ff60b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-15 11:48:59 +00:00
Scott Rifenbark
324d3ad00a documentation: Changed section title for required packages.
The title needs to use the terminology "Build Host" to be consistent
with the manual set.  I updated the title and the many links into that
section.

(From yocto-docs rev: 930030433e58e6180ee4f95e559d079c3899defc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
7a4d6b011f documentation: Fixed bad target ID for the dev-manual.
This fix involved a few other manuals.

(From yocto-docs rev: d2659951a458a8db773e8c1b2b86a7b109d667fa)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
720baedefc sdk-manual: Minor intro wording change
(From yocto-docs rev: 953db3d0b5fe14411e944b021a2f6f50a5bdeabd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
f4d1317d8f sdk-manual: Fixed bad anchor string.
Broken link fixed.

(From yocto-docs rev: 420bc55ceac1d8c89f9153a70c8b4e3ca38d747d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
880c15fe31 sdk-manual: Updated section on minimizing eSDK installer size
I made some re-writes for clearity.

(From yocto-docs rev: a68619a2ba8b7877cde6c9ef7dbb726adc75b0cd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
bfe4fef098 sdk-manual: Converted bullet list to ordered list
On second thought, the list I turned into a bullet list from the
previous commit was a bit hasty.  That list is order dependent.
Reverted the list.

(From yocto-docs rev: 9ea640ffea2a2c9827f18070a5b287453c8653e9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
5cdf2e8b2c sdk-manual: Updated "Providing Additional Installable Extensible SDK Content"
The list appears to be not a numbered list.  Fixed that.  Also, provided
better wording around "exposing" the sstate-cache.

(From yocto-docs rev: 15c65db41c9e6eddf7d12e138f6c63755e845beb)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
c89427bebe sdk-manual: Provided better wording for sharing HTTP or HTTPS server
Step 1 of the "Providing Updates to the Extensible SDK After Installation"
section really did not do much for the reader regarding setting up a
HTTP or HTTPS directory.  I added more detail on how to generally do
that.

(From yocto-docs rev: ff250cea239668db5fe26aa912942c0d142833fa)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
bf5e8e860c sdk-manual: Edits to the section that changes the sdk title
Made some suggestions on how and where to edit the SDK_TITLE
variable.

(From yocto-docs rev: 4a4393e00c7108eefaaeaa3951a75524589bf360)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
9af1d60bcc sdk-manual: Updated section on changing SDK installer title.
I added more detail to this section.

(From yocto-docs rev: 15beb33eadd03391a1af0c9bad0620cefad2a0e2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
55d5355b84 sdk-manual: Added section on changing the default ext. SDK install directory
(From yocto-docs rev: d3f0c7b9e2ddea3fec6f42fc9a3c8806b02119f3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
3b374b09df sdk-manual: Updates to sections for updating installed Ext SDKs
There are two sections that deal with this topic.  One is from the
standpoint of a user using a 3rd party published and installed
extensible SDK ("Applying Updates to an Installed Extensible SDK").
The other is from the standpoint of a person providing Extensible
SDKs for consumption ("Providing Updates to the Extensible SDK
After Installation").  These sections needed some closer examination
regarding fully describing what was going on.  I provided some
re-writes to both.

(From yocto-docs rev: 1c60b13b5f1813d6e3688e1efce32b7f31422e86)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
6cb9fddcab sdk-manual: Changed title to updating the SDK after install
The title for the section on how to effect changes to an installed
extensible SDK is better suited as "Providing Updates to the
Extensible SDK AFter Installation."

(From yocto-docs rev: 2120ba194abada1769be28ae2737ac12a16adebc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
67654c6100 sdk-manual: Fixed grammar error
In "Providing Updates After Installing the Extensible SDK" section,
Step 1 had a bit of a grammar error.  Not technically, but it
could have been written better.  I fixed that.

(From yocto-docs rev: 20f1cad5a813697afd99837699bf52a6586893bb)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
5e1a56eca6 sdk-manual: Updated section on changing title of extensible SDK installer
I added more information on how this is done.  Still could use a bit
of detail on how you actually do it.

(From yocto-docs rev: 007bbe40fd11a5f880adf7ad8137d1535f08c815)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
059d5e6e57 sdk-manual: Grammar fix
(From yocto-docs rev: b850e0d520401a52fbba083975f05f529b2b554d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
16eddf2be6 sdk-manual: Updates to "Adjusting the Extensible SDK to Suit Build Host"
I updated this section with clearer text.

(From yocto-docs rev: 433388ff37297d905c465a5f05d93953dfe062c5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
450a3d75f8 sdk-manual: Updates to "Configuring the Extensible SDK" section
Made improvements to this section and tied the variables together
for the explanation.

(From yocto-docs rev: de882b81ed8525dee5e10f247cc6f5c8f15e0f72)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:42 +01:00
Scott Rifenbark
2c8cc82b3e sdk-manual, mega-manual: Updated the fig for installed ext. SDK
This figure had changed.  I updated the file and folder hierarchy.

Also fixed some wording.

(From yocto-docs rev: 359292397781f9f5eac2fb693d89ec286ddf9940)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:42 +01:00
Scott Rifenbark
7bdb9a7bcc sdk-manual, mega-manual: Updated standard SDK install directory figure
The figure was incorrect for the installed file and folder hierarchy
for a standard SDK.  I updated it.  This figure goes in both the sdk-manual
and the mega-manual.

(From yocto-docs rev: a0dc11ce74bba0a18f385d9800f93524340ed033)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:42 +01:00
Scott Rifenbark
5c6ce7e467 sdk-manual: Final edits to the extracting root filesystem section
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>
2018-08-15 10:28:42 +01:00
Scott Rifenbark
f6bf56a17e sdk-manual: Added note in step to set SDKMACHINE
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>
2018-08-15 10:28:42 +01:00
Scott Rifenbark
c7d9010a07 sdk-manual: Updates to section on obtaining the SDK
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>
2018-07-07 10:59:38 +01:00
Scott Rifenbark
293183961e sdk-manual: Updates to "Building an SDK Installer" section.
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>
2018-06-28 09:22:57 +01:00
Scott Rifenbark
3658816dec sdk-manual: Updates to the section for locating SDK installers
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>
2018-06-28 09:22:57 +01:00
Scott Rifenbark
9e5a745d98 sdk-manual: Updates to Depolying and Debugging
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>
2018-06-28 09:22:57 +01:00
Scott Rifenbark
bb02c59e0b sdk-manual: Updates to neon section building the project
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>
2018-06-28 09:22:57 +01:00
Scott Rifenbark
0e870635f7 sdk-manual: Updates to configuring the cross-toolchains section.
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>
2018-06-28 09:22:57 +01:00
Scott Rifenbark
197ff097f7 sdk-manual: Updated Neon creating the project section
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>
2018-06-28 09:22:57 +01:00
Scott Rifenbark
48372e1bcc sdk-manual: Updates to configuring targe options sections
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>
2018-06-28 09:22:57 +01:00
Scott Rifenbark
74f4f81f62 sdk-manual: Updates to configuring the cross compiler options
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>
2018-06-28 09:22:57 +01:00
Scott Rifenbark
736e1d7916 sdk-manual: Fixed section capitalization problem.
(From yocto-docs rev: caf927123da995378116a3653232859992e8f8ec)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-28 09:22:57 +01:00
Scott Rifenbark
fa3643f2f5 sdk-manual: Used ordered list for sequence-dependent items.
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>
2018-06-28 09:22:57 +01:00
Scott Rifenbark
ad26f668c2 sdk-manual: Updates to Neon intalling YP plug-in from latest source
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>
2018-06-28 09:22:57 +01:00
Scott Rifenbark
6ee788433d sdk-manual: Updated the step to install the pre-build YP plug-in
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>
2018-06-28 09:22:57 +01:00
Scott Rifenbark
ec9606df06 sdk-manual: Updated steps to configure Neon Eclipse IDE
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>
2018-06-28 09:22:57 +01:00
Scott Rifenbark
1110ef2a9b sdk-manual: Updated the Neon step to unpack the tarball
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>
2018-06-28 09:22:57 +01:00
Scott Rifenbark
f9bfbc700a sdk-manual: Updates to step to download Neon Eclipse.
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>
2018-06-28 09:22:57 +01:00
Scott Rifenbark
9079fee0d2 sdk-manual: Fixed link in the intro section for Neon
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>
2018-06-28 09:22:57 +01:00