Commit Graph

576 Commits

Author SHA1 Message Date
Scott Rifenbark 2cae64b94f documentation/dev-manual: Re-org of topics
Several topics in the "Common Tasks" chapter really fit better in
the "Newbie" chapter.  I moved these sections out.  I also combined
information from the section on submitting changes from the
"Common Tasks" and the "Newbie" chapter to live in the "Newbie"
chapter only.

(From yocto-docs rev: 90fa8c125e545c57a5a994dd59715b73c5c4882f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:07 -08:00
Scott Rifenbark 0b17271a60 documentation/dev-manual/dev-manual-common-tasks.xml: new section
Added a new section on managing layers.  This is a sub-section that
completes the new layers section.

(From yocto-docs rev: 551f36a75485d0b3ecbd69d94fc359cfa42c875d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:07 -08:00
Scott Rifenbark c38b2de630 documentation/dev-manual: New Layer section and metadata link anchor
The change to the dev-manual-newbie.xml file was minor.  I added
a link anchor for the term "metadata."

The change to the dev-manual-common-tasks.xml was extensive.  I have
added an entirely new section on layers called "Understanding and
Using Layers."  The new material has several sub-sections.

Information was based on emails from Paul Eggleton.

(From yocto-docs rev: 4fb34abd60180fc2482ddb9f62e476763cee7679)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:06 -08:00
Scott Rifenbark eb829f2768 documentation: Section change and cross-reference fixes
I renamed the "BitBake Layers" section in the YP Development
Manual to "Understanding and Creating Layers."  Renaming the
section broke three cross-references in the YP documentation
manual set.  I applied fixes to the references.

(From yocto-docs rev: 93f4f5dfb61ed48047a40f5bbbc3f5e844c7c2f4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:06 -08:00
Scott Rifenbark 99d5ff0194 documentation/dev-manual/dev-manual-common-tasks.xml: Moved Layer section
The "BitBake Layers" section was grossly mis-positioned.  It appeared
in the "Making and Maintaining Changes" section.  I have moved the
layer section to the very front of this chapter.  It is fundamental
to know about layers and how to create your own custom layers.

(From yocto-docs rev: 410154f6e0a1e1f3ebc05d3f45ed2ce6f71cc618)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:06 -08:00
Scott Rifenbark ad5de9715a documentation/dev-manual/dev-manual-common-tasks.xml: New section
Added a new section on building from an external source tree.
This addition was driven by a need through two community members
whose feedback was picked up by Darren.

Reported-by: Inaky Perez-Gonzales <inaky.perez-gonzales@intel.com>
Reported-by: Mohamed Abbas <mohamed.abbas@intel.com>
(From yocto-docs rev: c9548803f58e5055d6686dbc16c94308296ccf2a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:04 -08:00
Scott Rifenbark c0859cd2b6 documentation/dev-manual: Fixed YP Build Directory Term
Throughout the manual there is a specific term to refer to the
YP build directory: "Yocto Project Build Directory."  This term
was being loosely referred to and was not consisten in linking to
the actual term definition in the Terms chapter.  All this is
fixed.

(From yocto-docs rev: 9229a512a62780a0e52089cc865d0903cbe7c92e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:00 -08:00
Scott Rifenbark ee69fb5782 documentation/dev-manual/dev-manual-common-tasks.xml: bblayer.conf edit
changed bblayer.conf to conf/bblayer.conf and also correctly referred
to the Yocto Project Build Directory.

Reported-by: Paul Eggleton <paul.eggleton@intel.com>
(From yocto-docs rev: 64dffc2a4e587f198d44b0ed0cea269bfa16d3be)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:00 -08:00
Scott Rifenbark a72bea5bf5 documentation/dev-manual/dev-manual-common-tasks.xml: Review comments
Had to back off a bit on the use of the term "working directory".
Paul clarified that it was okay to use the term "temporary source code
location" when talking about where the source code for a package was
located.

(From yocto-docs rev: 8d3f7613f32f1ce91c9d53e2db3c36448abb5a82)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:00 -08:00
Scott Rifenbark 8268a69c40 documentation/dev-manual/dev-manual-common-tasks.xml: review comments
Implemented Paul Eggleton's latest set of review comments to the
"Modifying Temporary Source Code" section.

(From yocto-docs rev: cd43c642308ba7c049e6ba79befa471673c078e7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:00 -08:00
Scott Rifenbark 9b5aedc3bc documentation/dev-manual/dev-manual-common-tasks.xml: S variable edits
More edits to the "Finding the Temporary Source Code" section as
pointed out by Paul Eggleton.

(From yocto-docs rev: 2987abe413687e216c4fe38d1db855409a595dab)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:59 -08:00
Scott Rifenbark 87133d137a documentation/dev-manual/dev-manual-common-tasks.xml: Review comments
Applied Paul Eggleton's review comments.  Basically trying to clarify
what is the S variable and what is the WORKDIR variable when
determining where unpacked source files are.

(From yocto-docs rev: e139e441653fa00309de204b7ad9f5a7ad7bdcb8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:59 -08:00
Scott Rifenbark f7fb723548 documentation/dev-manual/dev-manual-common-tasks.xml: review comments added
Paul Eggleton's review comments on the "Modifying Temporary Source
Code" section have been applied.

(From yocto-docs rev: 8f17f9e556e7027d8aba1fe69d614d17cdbcc054)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:57 -08:00
Scott Rifenbark 452d2764c9 documentation/dev-manual/dev-manual-common-tasks.xml: re-write to 4.4
Complete re-write to the "Modifying Temporary Source Code" section,
Section 4.4.  This strategy now comprises telling the user where
this temporary source code is, how to change it within a Quilt
workflow, and how to change it within a Git workflow.

I consulted with Paul Eggleton quite a bit to come to this conclusion
that the section needed more attention.

(From yocto-docs rev: 8c6c80121c1eeb1ec6f79e1efb6aa27aa9fd111f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:57 -08:00
Scott Rifenbark 797fabdbab documentation/dev-manual/dev-manual-common-tasks.xml: Edits
Applied some edits of Paul Eggleton's.

(From yocto-docs rev: ef5a82d429480c3820db93f0b7207d7e470454af)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:56 -08:00
Scott Rifenbark 70848f308d documentation/dev-manual/dev-manual-common-tasks.xml: Combined sections
I combined the section on changing package source code and
the section on changing package source code with quilt into one
over-arching section named "Modifying Package Source Code."
The section on Quilt was sort of a stand-alone section but Paul
Eggleton suggested that it is a natural follow-on.  So I put the
two sections in as sub-sections.

(From yocto-docs rev: ae4d3cf99e27f74b151939d2f5a2b440b91ac6d6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:56 -08:00
Scott Rifenbark 7a88a29c67 documentation/dev-manual/dev-manual-common-tasks.xml: review comments applied
Applied the review comments from both Paul Eggleton and Joshua
Lock for the "Modifying Package Source Code" section.

Reported-by: Paul Eggleton <paul.eggleton@intel.com>
Reported-by: Joshua Lock <joshual.lock@intel.com>
(From yocto-docs rev: 276c13517c7edda8407fdf82c36d14029c5fcee4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:56 -08:00
Scott Rifenbark ea70ac509b documentation/dev-manual/dev-manual-common-tasks.xml: new section
Created a new section called "Configuring the Kernel."  This is the
how-to counterpart for the concepts part created in the kernel
manual.  The section consists of three sub-sections:
"Using menuconfig", "Creating Config Fragments", and
"Fine-tuning the Kernel Configuration File."  Primary source for
information on this section was Bruce Ashfield.  He has this section
for review.

(From yocto-docs rev: 3ac718bc69b4914c41a0bb94134c085964ee71a7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:56 -08:00
Scott Rifenbark d8b27b6662 documentation/dev-manual/dev-manual-common-tasks.xml: Edits for links.
(From yocto-docs rev: f3a72e580eadca90d0f9f5d4173a3cb6da1579cd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:56 -08:00
Scott Rifenbark 1e608088cd documentation/dev-manual/dev-manual-common-tasks.xml: re-write
Re-write of the section describing how to update package source
code.  I added some rationale to the process and provided more
detail regarding where to find the source files and the naming
scheme behind it.  The new section is on review so changes could
occur.

(From yocto-docs rev: 2a1d37a87abb82c66a0ad3fc39d5da9f2f5b1b7e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:54 -08:00
Scott Rifenbark 7e23cd115c documentation/dev-manual/dev-manual-common-tasks.xml: Writer notes added.
(From yocto-docs rev: 40d00bde1585dbd0d23bf999e70940e15d52d74f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:53 -08:00
Scott Rifenbark eed16096e6 documentation/dev-manual/dev-manual-common-tasks.xml: Removed extra space.
(From yocto-docs rev: 734d6b2d9bd46011c8213b76d7cf2e1aa95e6750)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:53 -08:00
Scott Rifenbark 6c9445eacb documentation/dev-manual/dev-manual-common-tasks.xml: fixed autobot link
Broken link fixed.

(From yocto-docs rev: 6c9102ed8651ab93de46781dede05b2312d102d7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:51 -08:00
Scott Rifenbark b97cdc1c8c documentation/dev-manual: Reference link clean-up
I made another pass through the document and cleaned up some
mistakes and also removed redundant links to manuals where I had
already provided a link to the specific section.

(From yocto-docs rev: 5da8ffe100127f5fe4bfd2b478f177d6bef3a968)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:51 -08:00
Scott Rifenbark 646bda0f1d documentation/dev-manual/dev-manual-common-tasks.xml: links fixed.
Moving the "Common Tasks" section from the YP Reference Manual into
the YP Development Manual upset a bunch of links.  I have corrected
these links.

(From yocto-docs rev: 69ee73c59958aaab6f6370231c65300d1d8c92f8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:51 -08:00
Scott Rifenbark a8108a2f17 documentation: File swap
I am moving the "extended.xml" file from the YP Reference Manual
to the YP Development Manual.  This will be the basis for a common
tasks chapter that talks about common things developers do.

(From yocto-docs rev: 874b3a399c69e5eabf5001a5df5a3064a6d1f0ec)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:50 -08:00