Commit Graph

45 Commits

Author SHA1 Message Date
Scott Rifenbark aeead1fe2d dev-manual, ref-manual, poky.ent: Fixed broken Release Note scheme
The URL naming convention for the YP Release Notes has changed.
It now takes the following form:

  http://www.yoctoproject.org/download/yoctoproject-15-poky-1000

The above is an example for YP Release 1.5 and poky release 10.0.0.

I have set up three new variables in the poky.ent file to somewhat
automate the links in the docs to point to the location of a given
set of release notes:

 1. DISTRO_COMPRESSED - set to the DISTRO string with no period
    (e.g 15 for 1.5).

 2. POKYVERSION_COMPRESSED - set to the poky version with no
    periods (e.g. 1000 for 10.0.0).

 3. YOCTO_RELEASE_NOTES - set to the full-blown release note
    URL.

I made two changes to existing links for the Release Notes.  One
was in the dev-manual and one was in the ref-manual.

(From yocto-docs rev: e6088927980a1de8022b22f7f38b3046fea20235)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-31 08:19:21 +01:00
Scott Rifenbark 514176c231 dev-manual, ref-manual: Minor edits suggested by Bill Traynor
Applied some re-wordings as suggested by Bill Traynor.

Reported-by: William M.A. Traynor <wmat@alphatroop.com>
(From yocto-docs rev: 2510d9795720afc0309a10b18605e5af4a83769b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22 17:23:38 +01:00
Scott Rifenbark 90170fe4c9 dev-manual: Fixed typo.
(From yocto-docs rev: 0f691f5d10672bb9666a3038e71ff568aca7a2d6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-10 16:20:55 +01:00
Scott Rifenbark 0490239ed0 dev-manual: Updates to the "Other Information" section.
This section was VERY dated.

(From yocto-docs rev: 6a12809fdd60c707592fff88a5b246a94d6ca220)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-10 16:20:55 +01:00
Scott Rifenbark 9dae23da32 dev-manual: Capitalization issue fixed.
(From yocto-docs rev: 9afe9b9c9e7205b7de820ebe7c76c702f8715260)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-10 16:20:55 +01:00
Scott Rifenbark 00fea17416 dev-manual: Edits to "What this Manual Provides" section.
Updated to reflect the changed contents of this manual.
The section was rather dated.

(From yocto-docs rev: 08d126d611155e64d94084378cc0bb1f4cde4924)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-10 16:20:55 +01:00
Scott Rifenbark 772f064b49 dev-manual: Modified final paragraph of "Introduction".
(From yocto-docs rev: 49e3d96d674ca4c40dd89862ad615e876d57831f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-10 16:20:55 +01:00
Scott Rifenbark 999e4eec8e dev-manual: Edits to "Introduction" - better wording.
(From yocto-docs rev: ab48642c1800b40d43baf31c9733fd6c832faffc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-10 16:20:55 +01:00
Scott Rifenbark 9f1b358400 dev-manual: Added more examples of non-poky distros to note.
(From yocto-docs rev: 7ff0db9e6f6ba5f50b71280f8a99d2c3ed5f0c4a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22 17:08:42 +00:00
Scott Rifenbark ac18d660eb dev-manual: Added notes about creating your own distro
Added a couple of notes to point out the ease of creating your
own distro and not just relying on a Poky distribution.  One
note is at the very beginning of the manual and mentions
Angstrom as an example of a distro based on the YP.  The
other note is at the beginning of the second chapter.

(From yocto-docs rev: 1525a5e34c615cbfd25aeb12cc7a27ef95b51eab)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22 17:08:42 +00:00
Scott Rifenbark dc7221b2fc dev-manual: Fixed <ulink> to be on a single line.
These types of links must not span multiple lines in order for
mega-manual to process them.

(From yocto-docs rev: bcea042cd796a51d866f82399b2fd0cc89ec9e2b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:25:43 +00:00
Scott Rifenbark 347e99427f dev-manual: Scrub for correct YP manual cross-references.
I went through and got rid of all references to the old
YP Kernel Architecture and Use Manual and replaced with
appropriate references to the new YP Linux Kernel
Development Manual.

I also laced in appropriate references into various sections
of the new YP Profiling and Tracing Manual.

Also, updated the list of resource manuals to reflect the
new manual set (addition of kernel-dev and profile-dev and
removal of kernel-manual).

(From yocto-docs rev: ef531ad65c9b749dad5e8e39b060bf1641e4fa38)

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 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 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 20a2dda2c2 documentation: bsp-guide, dev-manual, kernel-manual - Removed links
Removing the Appendix A (BSP) example had some rippling affects
throughout the doc set.  There were several links into the appendix.
All these links had to either be modified (if possible) or simply
removed since the appendix will be removed.

(From yocto-docs rev: fff35abd87e945de1806eef63a56a956d104bf92)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-04 14:08:20 +01:00
Scott Rifenbark 5473c28ac8 documentation: dev-manual - Defines QEMU acronym.
(From yocto-docs rev: 665b9476a915031c30ada0f1d5cf80270486a404)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:26 +01:00
Scott Rifenbark 2b8d3c2db9 documentation: dev-manual - Fixed broken release notes link.
(From yocto-docs rev: af8f343cf62a0fabd1ef2fabc654817487cab6aa)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:26 +01:00
Scott Rifenbark 76dd4dd7b4 documentation: dev-manual - minor edits to manual limitations
changed the example of what the manual does not provide to
be more appropriate.

(From yocto-docs rev: c4e7712cfd2e13b42f7322ffed6a1f84116df963)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:26 +01:00
Scott Rifenbark 64b9137b43 documentation: Fixed links to BitBake User Manual
Robert P. J. Day pointed out a link in the development manual that
was for the BitBake User Manual.  The link resolved to an old,
non-maintained version of BitBake documentation.  According to
Richard Purdie, the BitBake docs referenced should be the ones
that ship in the bitbake/doc/manual directory of poky.  The
YP docs had been using a variable named BITBAKE_DOCS_URL that
also resolved to the antiquated user manual site.  Consequently,
there were many links that needed fixed across both the YP
Development Manual and the YP Reference Manual.  Each of these
references now points in general to the bitbake/doc/manual
directory in poky for more information.

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

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-14 09:50:45 +01:00
Scott Rifenbark 9df4aa6d8c documentation: Manual reference fixes for mega-manual processing
I fixed several occurences of cross-references to whole manuals where
the formatting was split in the <ulink> statement.  The <ulink> tag
and the manual title must be on one DocBook line in order for the
sed scripts to correctly process the links when the mega-manual is
created.

(From yocto-docs rev: 0dee12d518c892f59c0446e1c7b5d0f71b6ee22b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:54:58 +01:00
Scott Rifenbark 923563477e documentation/dev-manual: Title Fixes
Fixed several references to books.  There should be no books referenced
using "The" at the beginning of the manual title.  These need to be
"the" in order for correct mega-manual link processing with the
sed script.

(From yocto-docs rev: 76753216c7138d55f7b6f9167d678245ab3134e7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:54:58 +01:00
Scott Rifenbark b3ac19b1bf documentation: fixed Quick Start references
The way I refered to the YP Quick Start was inconsistant.
I have made edits to remove these.

(From yocto-docs rev: d9487c60db23861e8a9dd2c81ac46d4960abd462)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:54:56 +01:00
Ross Burton 0c6ac62a9f documentation: remove references to Pimlico
(From yocto-docs rev: f834df81cd8976f4710c1d3830c9384261f7500c)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-08-15 15:26:27 +01:00
Scott Rifenbark fb53d69d9c documentation/dev-manual/dev-manual-intro.xml: typo fixed.
(From yocto-docs rev: fc6fb25fd69b3af41692f482f768a63ee746d52f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-26 18:53:04 +01:00
Scott Rifenbark fad4b8fbbd documentation: Changes to ADT Manual title
The name of the ADT manual has changed to the "Yocto Project
Application Developer's Guide."  This change had some ripple effect
regarding cross-references into the manual.  These are now fixed.

(From yocto-docs rev: 7ba25c470b03a85098388e6cca7c78a6ebb245d8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-24 10:35:34 +01:00
Scott Rifenbark c20cdf677f documentation: Fixed the links to the BitBake Documentation page.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: ddee80872afc567b9381387980f257b337f29ea1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17 10:54:10 +01:00
Scott Rifenbark 85673e5466 documentation/dev-manual: Scrub for Yocto Project term
I have replaced the term "Yocto Project" with more appropriate terms
where possible.

(From yocto-docs rev: 622ef9a2b4897ecd151b641b43d7706ab673c989)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-03 14:55:02 +01:00
Scott Rifenbark a9f9eb27d3 documentation: Re-defined "Build Appliance" to mean the file
Previous renditions of the term "Build Appliance" referred to the
VMware system.  However, it was determined that the term
"Build Appliance" should really refer to the actual image that
can be booted and run on the VMware applications.  I have updated
the areas affected by this change.  The change assumes the name of
the built or downloaded file you boot will be named
"build-appliance-image."

Fixes [YOCTO_#2656]

(From yocto-docs rev: 6b27b7d92b9722351eb43a7c2a341ce3af056dba)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-26 15:34:39 +01:00
Robert P. J. Day a291d007b6 documenation//dev-manual: Typos fixed.
Some minor typoes in first couple chapters

(From yocto-docs rev: 36618cc6a261a994b00c5c524c76cbf3952a2eae)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-21 13:03:07 +01:00
Scott Rifenbark c8953cc337 documentation/dev-manual/dev-manual-intro.xml: Hob and BA added
Added Hob and Build Appliance to the list of other stuff the user
might want to reference.

(From yocto-docs rev: 4c94654e53e422e5e0a54476e3ca88e682f177af)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-05-01 20:50:45 +01:00
Scott Rifenbark aa3a201629 documentation/dev-manual: Converted to use poky.ent
I converted the hard links to use the variables as established
in the file poky.ent.

Also, Cleaned up some bad text in the term "Yocto Project Files."
Looks like a cut-and-paste problem.

(From yocto-docs rev: e2e20bf4895d80dae73595e93132f37fb31121d1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-23 14:24:43 +00:00
Scott Rifenbark e8a6970b0c documentation/dev-manual/dev-manual-intro.xml: updated intro
I added "tasks" to the bullet item that says the manual describes
common development models.  Now with the "Common Tasks" chapter
in here the intro needed tweaked.

(From yocto-docs rev: 8faa6308dbee2138f404d18c6d384b9af7bad5cb)

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 39899b2212 documentation/dev-manual: Edits from Tom Zanussi.
Tom Zanussi provided a review up through part of the "model"
chapter.  I have implemented his comments mosty verbatim.

Reported-by: Tom Zanussi
(From yocto-docs rev: 693d4fadd4b34ffef9953fb1850d381ff7c028a3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-25 15:24:17 +00:00
Scott Rifenbark 684c35b7aa documentation: Changed all manual links to point to "latest"
There are many references to YP documentation throughout the
YP manual set.  They used to have hard-coded links to the
current release (e.g. yoctoproject.org/docs/1.1 for Edison).
This created a situation where if you went to a document on
the website and clicked on a external reference to another
manual, you would redirect to the current manual on the website.
Really, you would want to go to the latest manual, which is
one that is under development.  Changing the links to
"yoctoproject.org/docs/latest" makes the tip of master, which
is used for devloping the next release, always have references
to the manuals being developed and not back to the stable
released set of manuals.

This "latest" and "current" scheme for the links is not perfect.
What has to happen when the latest set of the manuals freezes
and becomes the next stable release, all the links in the docs
will need to be changed from "latest" in the URL to the new
release number.  So for example, all the "latest" occurences
would need to be changed to "1.2".  Then for the next cycle
as development begins again, the links need to be infused with
"latest" again.

(From yocto-docs rev: a234aef34303b07671da956de0e94b352797143e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-25 15:24:17 +00:00
Robert P. J. Day 8c230114dd documentation: Standardized on spelling of BitBake
Robert found five instances where I missed the correct usage of
"BitBake."

(From yocto-docs rev: 0819076e8677accd157497ed4fa33ebab2528044)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-25 15:24:15 +00:00
Robert P. J. Day 9f103615fb Documentation/dev-manual/dev-manual-intro.xml: Edits to Intro section.
Open-source changed to open source (no hypen).  Broken URL fixed for the
1.1 release notes.

(From yocto-docs rev: d34df01aef674448d4cc06cfe4ff63cab764fe64)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-08 16:26:29 +00:00
Scott Rifenbark cbcdc22d90 documentation/dev-manual: Added TM to first Eclipse in chapters.
(From yocto-docs rev: 0f8b655da637ebf7708bdfff1473707c9ea3b8ef)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-25 17:59:59 +01:00
Scott Rifenbark 90ed20051c documentation/dev-manual/dev-manual-intro.xml: minor edits.
Some indentations applied.  Also, a few minor changes to some
wordings.

(From yocto-docs rev: a166f41a5bbf3590d8a2fabbee267bdd190f19dd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-25 17:59:58 +01:00
Scott Rifenbark f00ad2924f documentation/dev-manual/dev-manual-intro.xml: re-wrote the intro paragraphs.
(From yocto-docs rev: 5091b7c62c61b4c9ea14fb7a77cc4600437a9dbb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-25 17:59:58 +01:00
Scott Rifenbark 79bd1a1518 documentation/dev-manual/dev-manual-intro.xml: Added other information from ref
The YP reference manual had an appendix that included reference or
resource information such as mailing lists, bugzilla link, and
IRC chat stuff.  This type of information is best suited for the
introductory area of the development manual.

(From yocto-docs rev: a5576ed0d3360cdb32070ade6577cb7687923b10)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-30 17:27:36 +01:00
Scott Rifenbark a7e4747f49 documentation/dev-manual: Scott Garman's review comments.
Made several editing corrections for various terms and phrasings based on
Scott Garman's review.

(From yocto-docs rev: a21ba80151ce82683d45cd67ddb0728d779b007a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-15 15:27:04 +01:00
Scott Rifenbark af22a8c671 documentation/dev-manual/dev-manual-intro.xml: wording change.
I changed "complete reference guide" to "a reference guide."
I don't really believe the Poky Reference Manual will ever really
be complete.

(From yocto-docs rev: 9afcfe03e4f3595ac78f2cda111e5bd025654595)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:06:41 +01:00
Scott Rifenbark 387ed5934e documentation/dev-manual/dev-manual-intro.xml: Initial content added.
New content from my working chapter.  Previously this file was just a
copy of one of the adt-manual chapters.

(From yocto-docs rev: a50e69c19c23808d44ac4448b30394eedbbdbdab)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:23 +01:00
Scott Rifenbark 702eb2f170 documentation/dev-manual/dev-manual-intro.xml: Initial file with new name.
(From yocto-docs rev: 800c4424f7163177a97ff65428b549295069d9fe)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:22 +01:00