Commit Graph

3434 Commits

Author SHA1 Message Date
Scott Rifenbark
46b0fc3ec6 kernel-dev: Updated the root file to include the metadata chapter.
(From yocto-docs rev: b31e8928dbfeef3908d8a83a152e6701fa3bbbe0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:08 +00:00
Scott Rifenbark
7c5dfcbfb6 mega-manual: Updated the top-level XML file.
1. Changed "poky-ref-manual" to "ref-manual"
2. Inserted new lines to support "kernel-dev" manual.

(From yocto-docs rev: a134992633572c0b006ae73d47512be89d13ba8e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:08 +00:00
Scott Rifenbark
c9c0029c9b tools: Updated SED file that processes links for mega-manual
The version changed from 1.3 to 1.4.  The poky-ref-manual changed
to ref-manual.  And I added the new kernel-dev manual.  For now
I am leaving the kernel-manual book.  Likely it will be replaced
later.

(From yocto-docs rev: 3df7476724c96e97f309118fb6d906a999414093)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:08 +00:00
Scott Rifenbark
a2606d3b9f Makefile: Added the kernel-dev-title.png file to tarball.
(From yocto-docs rev: 1bb975547f509eb9c8364762f8e5040c7ead423a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:08 +00:00
Scott Rifenbark
7d46d48558 mega-manual: Added the title figure for the new kernel-dev book.
(From yocto-docs rev: 7f1fc6b50be882bd73f394f1ebe5f6dc0e3b0c28)

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
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
142de606a3 kernel-dev: Added original text into "Preparing a Layer" section.
(From yocto-docs rev: 504023d6a70d29c5501ef3f367029dcc033aeb6a)

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
9a5376be50 kernel-dev: Re-write of "Incorporating Out-of-Tree Modules" section.
(From yocto-docs rev: 1abc8be7a2862d51165615f49c8c9cfab319564b)

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
bb715c8eb8 kernel-dev: Re-write of "Working With Your Own Sources" section.
(From yocto-docs rev: 21b923bcb13cf918ddfad3b1cb449829c43aa3ab)

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
1b23230b65 kernel-dev: Re-write the "Modifying Source Code" section.
(From yocto-docs rev: 5ba8873b3ae182a06964ffc682acbe7b7947bb02)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:06 +00:00
Scott Rifenbark
2e106f9caa kernel-dev: Re-write of the "Generating Configuration Files" section.
(From yocto-docs rev: 5f5bbdf42bd7e53ca9332b662999a3f3cd73db71)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:06 +00:00
Scott Rifenbark
2c0358ccc7 kernel-dev: Re-write of "Iterative Development" section.
(From yocto-docs rev: fe86005486a9bf41307546bcfa7d718e0e95abf9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:06 +00:00
Scott Rifenbark
716306ad2b kernel-dev: Re-write of the "Changing the Configuration" section.
(From yocto-docs rev: 22f1f167c3c55b392ad8fd9e3d2e965183a2d884)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:06 +00:00
Scott Rifenbark
74d43d3a11 kernel-dev: Re-write of the "Applying Patches" section.
(From yocto-docs rev: 6f72b0ca3e883cb03618c9f37c69cb1ab774a9fe)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:06 +00:00
Scott Rifenbark
1306d5ca59 kernel-dev: Rewrite of the "Modifying an Existing Recipe" section.
(From yocto-docs rev: 699ab26ba14eb34166094ec93a2e3dff62d51b56)

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
1e76c5c558 kernel-dev: Rewrite of "Preparing a Layer" section.
(From yocto-docs rev: 9121a1afbf57023b180335541c551ae9356dcd83)

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
974ef52d56 kernel-dev: Rough text in for new chapter. Makefile edited.
The raw text for the second chapter is in by section.  This has
no formatting whatsoever.  I also edited the Makefile so that
the new "Common Tasks" chapter would make as part of the manual.

(From yocto-docs rev: 68bcc1e977fbdd7b1a4b448171d1149edc72db51)

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
494e9ef06b yocto-docs: updated poky.ent to have a temporary URL for kernel-dev
I added in the variable YOCTO_DOCS_KERNEL_DEV_URL as a placeholder
for the variable used to resolve to the published manual.  This
will need changed when we decide how to retire the existing
kernel-manual.

(From yocto-docs rev: 0a42af6c02b3fc6ebcad5be47d69c66ff0ced7ac)

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
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
6833ec86ac kernel-dev: Edits to set up root .XML file for new kernel-dev manual.
(From yocto-docs rev: 12019f8ddebc78162f4a759c5e84fac314a962ef)

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
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
Scott Rifenbark
8ec1a47afd dev-manual: Updated list of mailing lists to include listinfo
Robert P. J. Day suggested adding http://lists.yoctoproject.org/
listinfo to the list of mailing lists, which included yocto,
poky, and yocto-announce.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: f322c60814471e4216e112b193e5769fd6008a79)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-07 14:43:28 +00:00
Robert P. J. Day
4c582a8b2e dev-manual: Various fixes for links, typos, and grammar
1. Added "Debian" as a distribution for best results.
2. Fixed a link to the Hob page and two links for the
   Build Appliance.
3. Three typos fixed and a few grammar items fixed.

(From yocto-docs rev: 0b381094ed9cc2d66895d4ad7c63005c8a918eb1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-07 14:43:28 +00:00
Scott Rifenbark
30c0c9e358 mega-manual: Fixed to include ref-manual.
this still had the "poky-ref-manual" string in it. It needed the
"ref-manual" string.

(From yocto-docs rev: f771aaa09bf439e506dc5d8573a34283a1a905fb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-07 14:43:27 +00:00
Scott Rifenbark
a44106a0db tools: Updated the SED file that processes links in the mega-manual.
Substituted "1.4" for "1.3".  Substituted "dev-manual" for
"poky-ref-manual".

(From yocto-docs rev: b0b92c85f402c2280312ed909f4c4b976da28c54)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-07 14:43:27 +00:00
Scott Rifenbark
7aa9df2972 tools: updated the .sed file that processes the links in mega-manual
Had to change 1.3 to 1.4.  Also had to change poky-ref-manual
to ref-manual.

(From yocto-docs rev: e0448415218bacc7ce6555cad47e60a2dc7fc287)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-07 14:43:27 +00:00
Scott Rifenbark
e8ebe60b7f Documentation: ref-manual - Updated LIC_FILES_CHKSUM example.
One of the examples used "startline" instead of "beginline".
Correction made.

(From yocto-docs rev: 1ed3ae72b0492e03b37dc2c9519cf37209a7034b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-07 14:43:27 +00:00
Scott Rifenbark
2855f7e92f Documentation: Removing three unwanted files.
(From yocto-docs rev: b9b69da0c1f264388481817e988b5d131a0bb804)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-07 14:43:26 +00:00
Scott Rifenbark
8753c6b288 Documentation: ref-manual - removing old poky-ref-manual files
Removed the old poky-ref-manuals from the new ref-manual
structure.

(From yocto-docs rev: b5db4ddea205875ed3acacb90f46efd557337e0d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-07 14:43:26 +00:00
Scott Rifenbark
bb8e9d0599 Documentation: poky.ent - Updated the YOCTO_DOCS_REF_URL
Changed the variable to use "ref-manual" instead of
"poky-ref-manual" to support the new folder name for the
YP Reference Manual.

(From yocto-docs rev: 9dc6ff494c6841cb4830b6932a2b5faf4645ba98)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-07 14:43:26 +00:00
Scott Rifenbark
5f69362227 Documentation: Makefile - Changes to support ref-manual folder
Updates to allow the reference manual to be built as
ref-manual.htm and ref-manual.pdf.

(From yocto-docs rev: 2bac348d4f4c5e7385fc4a250d1f40f070edb15b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-07 14:43:25 +00:00
Scott Rifenbark
ed0a240e16 documentation: Rename of poky-ref-manual folder to ref-manual.
Changing the folder that holds the YP Reference Manual to be
"ref-manual".  This will help with confustion over the manual's
intended purpose.

(From yocto-docs rev: 1106442964b5080cb0b6b3bd3af32e9407c0f7c1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-07 14:43:25 +00:00
Scott Rifenbark
45915123a7 Documentation: poky-ref-manual - Updates to WORKDIR structure
The file structure beneath WORKDIR has changed such that
PN and PV are now separate directories.  This affected several
areas in poky-ref-manual.

(From yocto-docs rev: 52b033c2c9e5aaa1f03072dd16c21a9d59a87150)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 16:17:57 +00:00
Scott Rifenbark
044a8f9e6a Documentation: poky-ref-manual - Updated STAMPS directory information
The STAMPS directory is now structured as
build/tmp/stamps/$MULTIMACH_TARGET_SYS/<extended_PN>/$PV.
There were three areas in the manual that needed adjusting
to reflect this change.

(From yocto-docs rev: 1f8d64ecfa8e060680a90f9c6cc5f69554328da5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 16:17:57 +00:00
Scott Rifenbark
0173d4e10d documentation: poky-ref-manual - Fixed typo.
(From yocto-docs rev: fd43218181a20272b25b17a9fc0b99ece57e3a35)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 16:17:57 +00:00
Scott Rifenbark
0b18e1dbc9 Documentation: yocto-project-qs - Removed all trailing whitespace.
(From yocto-docs rev: 36376c49df34856b33bf8f4180ff6960f3280b48)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 16:17:56 +00:00
Scott Rifenbark
73ffb8298b Documentation: poky-ref-manual - Removed all trailing whitespace.
(From yocto-docs rev: 564a28c2501034ea7e2eb16afc43dfaf931b6f6f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 16:17:56 +00:00
Scott Rifenbark
acb3f72afa Documentation: kernel-manual - Removed all trailing whitespace.
(From yocto-docs rev: 188e1ad10217ff1a6a8363f100bff4e9ef3b9bf7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 16:17:51 +00:00
Scott Rifenbark
72d01bf43d documentation: dev-manual - Removed all trailing whitespace.
(From yocto-docs rev: d117584a589460412a7fc4df15512b0d9c9448c7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 16:15:24 +00:00
Scott Rifenbark
eb8c9e1494 Documentation: bsp-guide - Removed all trailing whitespace.
(From yocto-docs rev: 00d9bb4dcce101a77761418c1279ebfb9441b0d2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 16:15:24 +00:00
Scott Rifenbark
3bcdba62b1 documentation: adt-manual - Removed all trailing whitespace.
(From yocto-docs rev: c1c271c0404dff9ed49597a4582a56def8237dd7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 16:15:24 +00:00
Robert Cochran
205c7961f3 Documentation: dev-manual - Fixed maintainer link.
I updated a note that points the reader to the maintainers list.  The
note in the master branch pointed the reader to a nonexistent (old) file.

(From yocto-docs rev: d947d6d9bd42562a84ad3ac90e4c2052f421119c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 16:15:23 +00:00
Scott Rifenbark
260fd34e66 documentation: poky-ref-manual - Fixed grammar typo.
(From yocto-docs rev: 1f4da7fb6845407adb0f59f2f1a770f03c5a8f49)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-07 17:13:15 +00:00
Scott Rifenbark
f00ba684e0 Documentation: dev-manual, bsp-guide, poky-ref-manual - bblayer.conf updates
Fixes [YOCTO #3176]

Several places throughout the YP manual set examples are given
for the bblayer.conf file.  For release 1.3, a bug existed that
surfaced when a user removed either the meta or meta-yocto
layer from this configuration file.  The bug has been fixed and
the ripple effect through the YP documentation set affected
several manuals.

Fixes include updating the code samples that show bblayer.conf
so that they now include the BBLAYERS_NON_REMOVABLE variable,
a new glossary entry for the variable, and an explanation of
both BBLAYER and BBLAYER_NON_REMOVABLE in the section that
talks about the bblayer.conf file.

(From yocto-docs rev: 904b9ec1cd6d823af0e92f6891fc7e434cf2e358)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-07 17:13:15 +00:00
Scott Rifenbark
ac1981e41a documentation: Makefile - Added tarfile to the clean target
Clean operation should also remove the *.tgz file.  I added
code so that if the user makes the file and specifies the
'clean' target, the generated tarfile is removed.

(From yocto-docs rev: 565c147eaa169e287278b87e9bba2979a44be9d5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-07 17:13:14 +00:00
Scott Rifenbark
6a6ebdb2ad documentation: kernel-manual - removed white-space
White space at the end of a line in the DocBook .XML files
presents a problem for certain Git commands.  It evidently
shows the white space as red-highlighted errors.  I have removed
the white space from this concepts chapter.

Also, fixed one grammar item.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: dd0ab98a655ae61008d18cef44940622a901c9f6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-07 17:13:14 +00:00
Scott Rifenbark
a21cf1bc5f documentation: kernel-manual - Fixed broken link.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 0fc811748fce26f9c14791a286742905b51e77a6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-07 17:13:14 +00:00
Scott Rifenbark
17938797b2 documentation: poky-ref-manual - PACKAGECONFIG typo corrected.
(From yocto-docs rev: 110ca97f1f1f3b5edacf014c944b79e9a65ebd23)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-07 17:13:13 +00:00
Scott Rifenbark
377aee76f5 documentation: poky-ref-manual - PACKAGECONFIG edits
Fixes [YOCTO #3327]

Applied some edits to make it more accurate based on
Paul Eggleton's review comments.

(From yocto-docs rev: 94c15c9550fba77a2ab079502a62916357de0cf5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-07 17:13:13 +00:00
Scott Rifenbark
951efacceb documentation: poky-ref--manual - Updated PACKAGECONFIG
Fixes [YOCTO #3327]

Re-write of the glossary description for the
PACKAGECONFIG variable.  This went through a couple of
iterations.  Paul Eggleton reviewed and provided
technical information.

(From yocto-docs rev: 7edf3d03bc4a448516f24caea4b49423a026885f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-03 13:53:01 +00:00