Commit Graph

5897 Commits

Author SHA1 Message Date
Scott Rifenbark
908e338110 dev-manual: Fixed bad link
Link to metadata term was not going to the ref-manual.

(From yocto-docs rev: 7a116ece403cb88977dfcce3006e2e1bb52b5df0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:53 +01:00
Scott Rifenbark
72c820f08b documentation: Updates to cull out buried YP Website references.
With the redoing of the YP website, it was decided that the manuals
could only reference into the top-level and the top-level/documentation
URLs of the website.  I removed all references to areas such as
projects (e.g. Toaster, VM, etc.) and any other URL that was not
the top-level landing page or the documentation page.

(From yocto-docs rev: 2bd838f1a9fb2698bab098b13b76c8852853e0e7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:53 +01:00
Scott Rifenbark
67ab2e601f kernel-dev: Fixed typo.
Reported-by: Andrea Galbusera <gizero@gmail.com>
(From yocto-docs rev: 8955c2f09a421976ce296806b572afb4c7841470)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:53 +01:00
Kristi Rifenbark
73f1453e4e toaster-manual: Updated the "Remote Toaster Monitoring" section
Updated with review fixes.

(From yocto-docs rev: de6e7e194a414826c9b1bcc19a4975c67f90ee4f)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:53 +01:00
Kristi Rifenbark
4e818ce297 toaster-manual: Updated the "Configuring Toaster" section
Updated with review edits.

(From yocto-docs rev: 43dc539fb195e6194117dbc4de4d053fff53e9ff)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:53 +01:00
Kristi Rifenbark
332e309030 toaster-manual: Updated "Remote Toaster Monitoring" chapter
Review fixes.

(From yocto-docs rev: 8f01b79dd217af94af1794c339027a00ff1f64c2)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:53 +01:00
Kristi Rifenbark
285c92aef9 toaster-manual: Created "Configuring Toaster" chapter
Deleted the existing JSON chapter, and replaced it
with this new chapter.

(From yocto-docs rev: 86f9fb9c567310ecd1b06944c4c9107ec30df29c)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:53 +01:00
Kristi Rifenbark
4940360961 toaster-manual: Removed section "What Makes up a Release"
The content was obsolete. The new information is covered
in the new chapter "Configuring Toaster".

(From yocto-docs rev: 680273cb8fecea84297c3102c0b19fff5bcd9d88)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:53 +01:00
Kristi Rifenbark
4185ee3515 toaster-manual: Updated "Remote Toaster Monitoring" section
Updated with review fixes.

(From yocto-docs rev: 424e9cad5f950b068e6f977355c5dbdb17da52a2)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:53 +01:00
Kristi Rifenbark
b02ece66c0 toaster-manual: Added new chapter "Remote Toaster Monitoring"
Documented new direct JSON API with four subsections to let
you remotely monitor Toaster.

(From yocto-docs rev: 8b18ccffbcfe896f878dd912ea39b14557426b2c)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Kristi Rifenbark
2be2a1200e toaster-manual: Updated "Install Toaster Packages" section
(From yocto-docs rev: ad679fbcd86c06e784d0ba722030b73a4698e64c)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Kristi Rifenbark
42c7053e0f toaster-manual: Updated "Use the Fixture Feature" section
Updated section based on review notes.

(From yocto-docs rev: 843fb2c1344a50eb7481cfc6632fa1118a3b542f)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Kristi Rifenbark
f0b353f9e8 toaster-manual: Removed toaster-command-loadconf section
There is no longer a "loadconf" command

(From yocto-docs rev: 25c4385833c636bf4cff889ff6325b2a14f5fc14)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Kristi Rifenbark
0b85ab45df toaster-manual: Added "Use the Fixture Feature" section
Removed two outdated sections, "Use the toasterconf.json File"
and "Edit the Configuration File" and replaced them
with "Use the Fixture Feature" section.

(From yocto-docs rev: 8a247836a958449836effac3600f6923c5289bb6)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Kristi Rifenbark
aabfda2415 toaster-manual: Rewrite of the 'Pre-Configured Releases' section
(From yocto-docs rev: 4036a69be34613f71cca4a1f879998409f7a0665)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Kristi Rifenbark
f258b6ac3a toaster-manual: Rewrite of the 'Setting Up External Access' section
(From yocto-docs rev: f3737aaeabf5ae169d07b72ef6b70e2b5d7cb4b7)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
962edb8d3d dev-manual: Updated .mtoolsrc error instruction note.
(From yocto-docs rev: cb8b2e89406a8c786bbabf78f17d66bb953c6dbf)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
557d532b7c yocto-project-qs: Updated some links to work better from mega-manual
Links to the top of a manual don't really work from the mega-manual.
I updated the manual links at the bottom of the yocto-project-qs
so that they go to the introduction sections of the appropriate
manual rather than attempting to go to the top of the manual, where
they don't render from within the mega-manual.

(From yocto-docs rev: e8e1c72b6c79065d86479d48974d1a188f4ebf30)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
59c64247f7 yocto-project-qs: Updated the "Next Steps" section
Provided better roadmapping into the kernel development manual and
more explanation of the dev-manual.

(From yocto-docs rev: 811e6ee07ee5e84400b90c18b251d8053000f859)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
07ec3f2f86 dev-manual: Added wic ls, rm, and cp example
Fixes [YOCTO #12191]

Put in a new example in the Wic section to highlight the use of the
'wic ls', 'wic rm', and 'wic cp' commands.

(From yocto-docs rev: 2bf316961d22d5dc2df2d849c50ec347d5f9db51)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
4320b808c2 ref-manual, dev-manual: Updated "Creating Partitioned Images" section title.
Added "Using Wic" to the section head because that is all we
talk about.  This affect three links in the ref-manual so I
fixed those as well.

(From yocto-docs rev: 0e4f245f2b872810e2e164a227900ca6aa313ab8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
cbe8009a17 dev-manual, ref-manual: Moved kickstart reference to ref-manual
This section was misplaced in the dev-manual and really needed to
be in the ref-manual.  I created a new chapter that follows the
devtool reference chapter and put the kickstart chapter there.

Links were needed to be fixed up and a new chapter in the
ref-manual named ref-kickstart.xml had to be created.

(From yocto-docs rev: b4d5b7077a978e4966d1273a374741075a1b0c7d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
6077ebbe80 ref-manual, dev-manual: Moved plug-in section for wic to ref-manual
Fixed links affected by the move.

(From yocto-docs rev: 250d312274788b0eebf3ae9143f2f89eafd4ab90)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
6cee5c8b9b ref-manual: Updated a cross-link to the creating partitioned images section
This link is going to a link that disappearing.  So had to re-route
it to a different spot.

(From yocto-docs rev: 8b2a3eafa10b1f6fdf034e6e13d0277c9a556170)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
4c0e713b81 kernel-dev: Applied review feedback
Various edits for review feedback on the manual in general.

(From yocto-docs rev: 218061535b5bed326331d00eee6f514c81299238)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:51 +01:00
Scott Rifenbark
0b75283fa9 ref-manual: Updated the FILESEXTRAPATHS variable
Added an example to show machine overrides.

(From yocto-docs rev: d0c54caf2a2a6ccb9a6fb38b77c9827b66b9ff10)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:51 +01:00
Scott Rifenbark
7cf82df8b0 dev-manual: Updated the plug-ins section.
(From yocto-docs rev: d1a4ff5ee177c7b9442d805b6e20a8ba8410d91d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:51 +01:00
Scott Rifenbark
e746cc1c65 dev-manual: Updated Wic Kicstart examples.
(From yocto-docs rev: b5393e416c779aa9d4f5116cdea8d5fd09c21bd1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:51 +01:00
Scott Rifenbark
3823b6edd3 ref-manual: Fixed typo
(From yocto-docs rev: eb16cc85e9a14e82d5416f6a4a3ebc9eff7c3057)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:51 +01:00
Scott Rifenbark
b8d329644f ref-manual: Fixed redundancy in MACHINE list for runqemu command
In the "runqemu Command-Line Options" section there is a bulleted
list showing options you can provide.  The "MACHINE" option lists
valid values and listed "qemux86" twice in the list.  I removed
one of them.

(From yocto-docs rev: 7831b60391544e9fca94b1fe299ec4cb57992222)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:51 +01:00
Scott Rifenbark
59ddd7c386 ref-manual: Added Debian GNU/Linux 9 (Stretch) to supported distros.
(From yocto-docs rev: f759827b163a844b4f9eb31b2a4ecea56d2aa004)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:51 +01:00
Scott Rifenbark
b402b283c8 dev-manual: Fixed broken link to "Images" section in ref manual.
(From yocto-docs rev: b5bc0f8d4be9746281d81555d7c90f66be285fe0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:51 +01:00
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
50c8c730ad ref-manual: Updated Metadata term in Terms section
Provided a description for metadata in the context of the kernel
that ties it to the yocto-kernel-cache Git repository rather
than the old meta-* directories that were in the actual
kernel trees.

(From yocto-docs rev: 7105459bf687cad7d973d8bdffbc51c9ffcd9721)

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
65013d1579 kernel-dev: Updated Title Page.
Using Scotty's Documentation Services, INC. and Scott Rifenbark
as the author.  Added a note in the note box to send an email to
the yocto@yoctoproject.org discussion group or log into the freenode

(From yocto-docs rev: 657ef0a09a72c023dd2ab523ff3c7ad1e7a2efea)

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
ba33c69b24 kernel-dev: Updated Tree Construction section with review feedback.
(From yocto-docs rev: c28b349a972d81d3b60bf1b0de48d837fbc76cdb)

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
6ca1a37dfb kernel-dev: Added KMACHINE and MACHINE descriptions for using metadata
Needed to remove an old example that was showing how two BSPs could
share the same KMACHINE value.  I replaced it with corei7-based
machines.  Also noted that KMACHINE is for kernel mapping only
whereas MACHINE is for the layer's BSP machine type.

(From yocto-docs rev: c1dad2815b6fd1ed78e0dce0fecb422f342eaf14)

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
39c520e77b kernel-dev: Removed note about KTYPE being optional in future.
(From yocto-docs rev: 2ecf347fe5b9f60d29a5624bab2f57a7278fa9ab)

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
540324a82f kernel-dev: Updated what the manual covers to include appendices
(From yocto-docs rev: 1782241165aa09ab3d3ecf66a91a355555f5f42b)

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
453a619dc6 kernel-dev: Updated lists for formatting consistency
(From yocto-docs rev: 7fe10c067219eccdbfd8d99223cdb38b84d7d2a5)

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
d7ad579ce5 kernel-dev: Updates to "Working With Your Own Sources"
Formatting changes for the list.

(From yocto-docs rev: df1201085408eec45d8fbf649e80437299daa0e8)

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
cb9150394d kernel-dev: Edits to "Build Strategy" section.
This section was written before the yocto-kernel-cache strategy
existed and was thus incorrect.  I updated it with how I understand
things to work.

(From yocto-docs rev: 629f24c9312a168ddcd28b0d9dde92ff06068483)

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
766770aa35 kernel-dev: Updated Tree Construction section
The section was using the "meta-*" stuff, which is not how it
is done any longer.

(From yocto-docs rev: c9d95e85a832a38c3fd099a728693af3fa708d50)

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
f83991dc04 ref-manual: Updated KERNEL_FEATURES variable description
Added a more relevant example from the 4.12 Yocto Linux kernel
recipe.

(From yocto-docs rev: 98c40729b2b22a2ac8444d899848c05880cb920b)

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
398a00a74c kernel-dev: Minor updates to the "Kernel Maintenance" appendix.
(From yocto-docs rev: eabeff4611d447be12af64f0f44c218c69da3409)

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
214c692889 kernel-dev: Minor edits to the "Advanced Kernel Concepts" appendix
(From yocto-docs rev: 645b642965ffcbb12f171e11a53b4efe5d0fd756)

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
732f317002 kernel-dev: Changed title for advanced metadata chapter
Introduced the "yocto-kernel-cache" term into the title.

(From yocto-docs rev: ca74c49e2809851bb22bbe0d68830127d7bba4e9)

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
42303c0d9f kernel-dev: Miscellaneous Edits to Advanced Metadata chapter
(From yocto-docs rev: 74e27b697efa7ea7ecc1d1d59266b537dd70ae98)

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
dc2f2ae714 kernel-dev: Updated example in metadata outside recipe-space
Went from 4.4 kernel to 4.12.

(From yocto-docs rev: 4cf2710a381925b8bf13536c1f8da3d12938fffe)

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
99151aef77 kernel-dev: Updates to "Using Kernel Metadata in a Recipe"
This section had some old emenlo examples and was a little
confusing.  I removed the old examples and inserted some new
wordings to help smooth it out.

(From yocto-docs rev: 365129e0cd37772f404d96a51eb498210e4f1ee9)

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