Commit Graph

36 Commits

Author SHA1 Message Date
Scott Rifenbark
e018769524 kernel-dev: Updated links to the SDK manual.
The name of the SDK manual changed and there was one link to the
manual that needed fixed.

(From yocto-docs rev: 800d5106a25ce4e87b0468ec3ab03dd8a49f3082)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:08 +00:00
Scott Rifenbark
29bcd3b387 kernel-dev: Updated dev-manual title
The name of the dev-manual has changed to be the
"Yocto Project Development Tasks Manual".  I have updated all the
areas in the kernel-dev manual that reference sections into the
dev-manual.

(From yocto-docs rev: f0309ab658a259637ba7f9301031887114ade988)

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

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

(From yocto-docs rev: 7059d3eac1fec20089cabf197503f1bec747686d)

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

1. I updated the YP Compatible Program section.

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

(From yocto-docs rev: cdb5bbc917db55a2ca987ce9b9ed371f9fca6524)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-26 11:18:59 +01:00
Scott Rifenbark
b64872f9ab kernel-dev, mega-manual: kernel dev flow fig update and chapter revs
Updated the kernel development flow diagram to have an arrow from
the repositories to the box that says you need to clone the
kernel repository.  Also, provided some wording changes in the
end of the chapter.

(From yocto-docs rev: c77cff4f7b0795d5429dc47c2ad63aec6d19d513)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13 18:00:19 +01:00
Scott Rifenbark
d4be6ea72a kernel-dev: Updates to the intro chapter
I moved the flow diagram up higher and completely removed
the procedures to get the build host ready for kernel
development.  Those are now in the common tasks chapter.

Lots of rewriting

Signen-off-by: Scott Rifenbark <srifenbark@gmail.com>

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13 18:00:18 +01:00
Scott Rifenbark
bfe0fba09c kernel-dev: Added output to kernel clone example.
(From yocto-docs rev: d5880262ab74499fbeef620af7907ee6e5d328fd)

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
cce4bf737e kernel-dev: Removed bare clone stuff for trad. kernel dev.
Bare clone setup is no longer recommended or necessary for
traditional kernel development.  All that is required is to
clone the kernel Git repo locally.

(From yocto-docs rev: cbe6d79da4fc2d5bba530b0fe6abead7783bdfbe)

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
59764811d0 kernel-dev: Some cleanup of the output for the kernel flow ex.
(From yocto-docs rev: 30bbe308339ad0665d59d8238e9420d1d594332e)

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
ea256df2a8 dev-manual, kernel-dev: Working kernel flow process using devtool
A work-in-progress of an example that modifies the kernel
using the devtool.  The procedure is not complete yet as it
does not run properly.

(From yocto-docs rev: 462ba2e46f237c294f05805ad5044291a085975d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:49 +01:00
Scott Rifenbark
2a1bdf7416 dev-manual: Added "next steps" for setting up a native linux host
The end of this section did not direct the user to the next
logical step for preparing a development host.  I added a
paragraph to guide the user to the next area they would need
to read based on their development methods.

(From yocto-docs rev: 4a1aa7800e7bca82dddef0ed83e14e075b3aa9f2)

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
0fbba0fb46 kernel-dev: Updates on how to prepare for kernel modification.
WIP at this point.

(From yocto-docs rev: 12e44f6ee7f9437d85c33d0789dbafe937af5664)

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
5865fcdf85 kernel-dev: Updated step 1 of flow and intro verbiage
Updated the step to include proper links and verbiage for
setting up the system for YP development.

(From yocto-docs rev: d5d908847d66178a995d2be985c605e6a5c48d76)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:48 +01:00
Scott Rifenbark
a64831cad7 kernel-dev, dev-manual: Moved Kernel prep steps
The dev-manual had a place-holder section for getting the
build host ready for using YP and then doing kernel
development.  This stuff is better suited for the actual
kernel development manual.  I moved the section.  Moving
created several broken links in the manual set that had to
be fixed.

In the dev-manual, I updated the introductory list to include
the newly moved kernel stuff.

(From yocto-docs rev: 2e21260bb5f84e9e30eb353ec841d5962e8a7642)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:48 +01:00
Scott Rifenbark
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
9648d0b905 kernel-dev: Updated kernel dev flow figure and supporting text.
(From yocto-docs rev: 68dafc1a68d48a8fe5292185d5ca62d1bdcd80ab)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:47 +01:00
Scott Rifenbark
293b53674c documentation: Moved devtool workflow to sdk manual
Fixes [YOCTO #11630]

The section on the devtool workflow in the dev-manual was 99%
identical to what was in the sdk-manual.  I have moved the
workflow procedure from the old "Model" chapter of the dev-manual
to be merged with what was in the sdk-manual.  In truth, the
only things added were a note about devtool not being exclusive
to SDK development.

The result of moving (deleting) this section was that the "model"
chapter of the dev-manual went away.  The devtool stuff, Quilt,
devshell, and python shell are all out now and there is no
chapter left.  So, mega-manual had to be adjusted to not pull that
chapter in when building the dev-manual.  I had to delete three
figures that were used in the flow.  The figures were already
replicated in the sdk-manual.  The figures were deleted from the
figures folder of both the dev-manual and the mega-manual.

I had to make sure all references to the old devtool stuf in the
YP doc set were adjusted.

(From yocto-docs rev: 5dbd643d31ab502df53a22229e457a03da7772b7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
925f2b2fc2 kernel-dev: Formatting and cleanup for "Other Resources"
Some general cleanup and formatting.

(From yocto-docs rev: 8d4458f8fbe02cb8bfa78cbf18726cdd8126850a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
431ceaea6c kernel-dev, dev-manual: Moved Kernel workflow section to kernel-dev
Fixes [YOCTO #11630]

The overview section of modifying the kernel needed to be in the
kernel-dev manual and not in the dev-manual.  I moved it and took
care of all the links and external references throughout the YP
doc set.  One figure was involved that had to be moved to the figures
folder in kernel-dev from dev-manual.  That is why the Makefile had
to be edited.

(From yocto-docs rev: 3a704b64544678785b883f82d6e82aedac6790c5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
f42d8f4cf0 documentation: Fixed links for "metadata" term.
Fixes [YOCTO #11630]

Moving the "Yocto Project Terms" section from the dev-manual
to the ref-manual broke the links to the "Metadata" term.
I fixed these.

(From yocto-docs rev: 190da4b4d44952d141db26ca72b5bc1a52d77023)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:43 +01:00
Robert P. J. Day
043e02c5d8 kernel-dev: Minor typo fixed and added LTSI link
Fixed a small text issue where a hypen was needed.  Also, provided
a real link to the YP LTSI page.

(From yocto-docs rev: aa8c06b79eef1855c3b5af4c8bfa47a96a86d332)

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

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

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

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

(From yocto-docs rev: 4585b9fbb1636ae3c65e2e3ad2d1d6baca636e59)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:55 +00:00
Robert P. J. Day
ca4e42ad28 kernel-dev: Fixed link to BitBake command:
Reported-by: Bill Traynor <btraynor@gmail.com>
(From yocto-docs rev: 4bce72419c01e0c77969a56eb194ad7179b7ad80)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 19:06:53 +01:00
Scott Rifenbark
8e45b6db49 kernel-dev: Commented out some development notes to Darren.
(From yocto-docs rev: 9981e5d85751eb6f21b1c06390158a995d7f59a8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:13:42 +01:00
Scott Rifenbark
b80e983620 kernel-dev: Added an AR to the beginning for Darren
The concepts in three bulleted items in the old kernel manual
need to be present in this new manual.  I put in a bit of text
right at the beginning of the manual in the form of an AR for
Darren.  This will eventually be removed, but for now it is there
so that it won't slip through the cracks.

(From yocto-docs rev: 85b7300df30837f72d936f8ec1af0b2a4a9c1a88)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:01 +00:00
Scott Rifenbark
e6310f6310 kernel-dev: Minor edits to the overview section.
(From yocto-docs rev: 42c9b33d38150672d1ea177f98a86c71806caa3a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:05 +00:00
Scott Rifenbark
5487eeb730 kernel-dev: Edits to Introduction chapter.
Removed the block of original text.

(From yocto-docs rev: ff36ef73cbf50b966bf539b013260fb7c668d82e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:20 +00:00
Scott Rifenbark
e826a50739 kernel-dev: removed "many" based on Darren's Feedback.
(From yocto-docs rev: 4f0de9cd389f37f86c2f88e399e52a284a4f870b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:15 +00:00
Scott Rifenbark
467cb3d32e kernel-dev: Edits to the introduction chapter.
I did some re-writing for better understanding based on what I
know.

(From yocto-docs rev: fc3adb037ac07a90dfbba6b76643391480e0bce5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:14 +00:00
scott-lenovo
9a6c5e1fdd kernel-dev: Updates to the introduction chapter.
General edits for readability, etc.

(From yocto-docs rev: eb52c743ad0fba7859ee4800f12981294aa71b23)

Signed-off-by: scott-lenovo <scott-lenovo@ubuntu.(none)>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:13 +00:00
Scott Rifenbark
76c2ace2bf kernel-dev: general edits to the Introduction chapter.
(From yocto-docs rev: 211d85ea41743264c2f06f2ab44f0cdda68e43da)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:07 +00:00
Scott Rifenbark
d0858ccb33 kernel-dev: Updates to get the new kernel-dev manual to make
These changes were to the intro chapter to introduce the DocBook
form, the Makefile to introduce the new manual, the figure used
for the title had to be updated, the root manual .XML file needed
changed, and the style sheet.

The manual now makes with just the raw text for Darren's intro
section.

(From yocto-docs rev: 1bceb7bdd4fe5773c11c7ddbdae00554680bbf6d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:05 +00:00
Scott Rifenbark
5cbeb84006 kernel-dev: Created file structure for new kernel-dev manual.
(From yocto-docs rev: 25be3ebb7713b875c4ec6e3723961b7dd860295d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:04 +00:00