Commit Graph

136 Commits

Author SHA1 Message Date
Scott Rifenbark f6d3ca28d9 documentation/dev-manual/dev-manual-newbie.xml: fixed broken link
there was a link to some Git documentation referencing workflows that
apparently had gone stale.  I replaced the reference with a link to
the Git Community Book.

(From yocto-docs rev: 7a2cbe4c45eb9bb53d5ddbc014bd6005c2844d56)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:37 -08:00
Scott Rifenbark 31c4229d3c documentation/dev-manual/dev-manual-newbie.xml: Updates to Bugzilla use
I updated the Bug Tracking section to include rudimentary use of
Bugzilla for entering a new bug.

Fixes [YOCTO #237]

(From yocto-docs rev: 8f2702444812c9dc25195340acebbaae15cd59d7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-25 15:24:19 +00: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 bf1e5c6413 documentation/dev-manual/dev-manual-newbie.xml: Robert P. J. Edits
Robert suggested some minor wording changes that are good.

(From yocto-docs rev: 50822bc3722e2f3b0a73ed837842ddc5c7595c7b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-08 16:26:30 +00:00
Robert P. J. Day 296fd7a7de documentation/dev-manual/dev-manual-newbie.xml: Robert P. J. Edits
Robert ear-marked some links to point to downloads.yoctoproject.org.
He also made several wording changes that resulted in better language
and in a couple of cases fixed incorrect subject/verb usage.

(From yocto-docs rev: 9106619c4264c2669be041c1e6d6124e022ab2d1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-08 16:26:30 +00:00
Scott Rifenbark 1d06f45acb documentation/dev-manual: Fixed five broken links and removed note
The restructuring of the web site where we store manuals broke some
links that were cut-and-pasted in from older work.  These slipped by
me so not changing them would direct the user to a 1.0 version of
the externally referenced manual rather than the 1.1 version.

I also got rid of a visible "WRITER'S NOTE" in the document that
was left behind.

(From yocto-docs rev: 1508826312a2fe35e5d693821a4c7737baafcb2e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-14 00:31:11 +01:00
Scott Rifenbark f54a78c891 documentation: Fixed links for yocto-1.1
After greping through the documentation directory, I addressed
all the <ulink> statements that used to have yocto-1.0 in the URL.
They are now yocto-1.1.

(From yocto-docs rev: 97d160263c5905fdeaf4ec285bc5359918790581)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-06 18:41:47 +01:00
Scott Rifenbark 3790c5580a documentation/dev-manual/dev-manual-newbie.xml: added information for licenses
I added the directory where the list of know licenses are in the YP
files structure (meta/files/common-licenses).

(From yocto-docs rev: 6a8db1a5ac653dbc8730e61293221c0b0890888d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:46:38 +01: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 15793a8210 documentation/dev-manual/dev-manual-newbie.xml: note for maintainer
Added a note indicating where you can find the maintainer for yocto
code.  Suggestion by Robert Berger.

(From yocto-docs rev: 8e55cc4c460582964b0267b4f43c14e7100f17fe)

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 7021e04af8 documentation/dev-manual/dev-manual-newbie.xml: addes link to commit page
I provided a link to the OpenEmbedded wiki page created by Mark Hatle
that provides good guidelines on how to create well-formed commit
messages.

(From yocto-docs rev: ea7b0100a7b45c369cb67daa0705dcc5acef40c8)

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 2a745da247 documentation/dev-manual/dev-manual-newbie.xml: edits and enhancements.
General pass-through for consistency in referencing sections.
Also, added Darren Hart's review comments for the "Submitting a
Change" section.  I added more about the mailing lists and how to
submit a proper commit message.

(From yocto-docs rev: d9c8f5db8c862b1be724915cc43da6d12b88b97d)

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 d7dc960e14 documentation/dev-manual/dev-manual-newbie.xml: new terms
I moved the terms "Yocto Project Files" and "Yocto Project Build
Tree" into this development manual.  They were previous defined
in the ADT manual.  It makes more sense to have them where with other
terms.

(From yocto-docs rev: 2133110fd280db8cfbe998e6b46cdee0b260e777)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-25 17:59:57 +01:00
Scott Rifenbark 524f57771b documentation/dev-manual/dev-manual-newbie.xml: re-write change submit
The section on submitting a change was very sparse and incomplete.
I have significantly upgraded this section to provide more details.

(From yocto-docs rev: af43bb1e4902c45afb5ac4b0f099877acd7a81a2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-25 17:59:57 +01:00
Scott Rifenbark 7eea637db0 documentation/dev-manual/dev-manual-newbie.xml: Suggestions Robert Berger
I made several edits here.  There is some mystery as to which changes
are actually part of this commit.  I did a 'git diff' and am only seeing
one small change.  If I later find they are not there I will delete the
file and replace with a back up I saved prior to submitting this commit.

(From yocto-docs rev: 62c63b3a812eaf92ca2bffa5714a6d327ac32d64)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-13 21:48:38 +01:00
Scott Rifenbark 2f1d30ad65 documentation/dev-manual/dev-manual-newbie.xml: Updates from Robert Berger
Added some clarification on the ability for testing.  The wording as
it was implied that the YP provided a complete testing framework,
which is not true.

(From yocto-docs rev: e40b39179c69b69f012f231009131b1efa7e732b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-13 21:48:38 +01:00
Scott Rifenbark c3e83278c6 documentation/dev-manual/dev-manual-newbie.xml: added more to contributing
The section on how to contribute changes to the YP resides in this
development guide.  I took additional information from the YP reference
manual and merged it into the section here.

(From yocto-docs rev: 945dd29417cf51044332114e499b08fe24ef3077)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-30 17:27:37 +01:00
Scott Rifenbark 34de499685 documentation/dev-manual/dev-manual-newbie.xml: Updated term list.
I added a reference to the Image appendix for the description of
images.  Also, added a new term "meta-toolchain."

(From yocto-docs rev: a9c1110ec7499afa669416c00bc81573fcbf920d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:46:37 -07:00
Scott Rifenbark 1e789e60b5 documentation/dev-manual: Incorporated Joshua Lock's review comments.
(From yocto-docs rev: d4bf6343d7575ff96030242e2025570db52b515b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:46:36 -07:00
Scott Rifenbark 73b44c65ae documentation/dev-manual/dev-manual-newbie.xml: added picture for newbie Git
(From yocto-docs rev: 608656076131b7cab829344d8ed0f63c655566d7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-20 17:51:59 -07: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 a10057e507 documentation/dev-manual/dev-manual-newbie.xml: fixed git-format-email
Bruce Ashfield review comment indicated incorrect usage of
'git-format-email' command.  Changed to 'git format-email'

(From yocto-docs rev: 888cc503f836787462dc9d3029c761323037df52)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-15 15:27:03 +01:00
Scott Rifenbark fe155a19f2 documentation/dev-manual/dev-manual-newbie.xml: wording change.
(From yocto-docs rev: 752f43be2f5746d239a937d6b5ca8c5d6d83eac0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-15 15:27:02 +01:00
Scott Rifenbark 572449b29c documentation/dev-manual/dev-manual-newbie.xml: Added anchor point
I placed an anchor point in the Index of Downloads bulleted item for
reference from other documents.

(From yocto-docs rev: 7d4f96d20667fbf5f52e25840b39f1994b1c4cd3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-15 15:26:59 +01:00
Scott Rifenbark 5ce8039fde documentation/dev-manual/dev-manual-newbie.xml: edits suggested by Dave Stewart.
(From yocto-docs rev: c6924422778b525dfe63f5e9a121c92317c3ea25)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:07:52 +01:00
Scott Rifenbark e4448dac93 documentation/dev-manual/dev-manual-newbie.xml: updated intro paragraph and figs
I updated the introduction paragraph to cast the chapter more for YP than
just generic newbie information.  Also, added three screenshots for
the source areas at Dave Stewart's suggestion.

(From yocto-docs rev: 26d3c58ff6295515c593c8b0b12dc3d6952b752a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:07:52 +01:00
Scott Rifenbark 0e697a6c9e documentation/dev-manual/dev-manual-newbie.xml: edits to how to submit change section.
(From yocto-docs rev: 16533369264deb5f93b0d97f0d8491ee45fe23db)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:06:43 +01:00
Scott Rifenbark 5c6753735f documentation/dev-manual/dev-manual-newbie.xml: edits to tracking bugs section.
(From yocto-docs rev: 7a4487394f14214c287247020b3abda3c3b6cfde)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:06:43 +01:00
Scott Rifenbark 70b317ecce documentation/dev-manual/dev-manual-newbie.xml: edits to workflow
General edits to the workflow section.  Also created a link to
to Bugzilla in the next section.

(From yocto-docs rev: 2e70b19d24bb4649fb525232fca9ab2e01c5ec61)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:06:42 +01:00
Scott Rifenbark c6a7a82a9c documentation/dev-manual/dev-manual-newbie.xml: new section on terms added
created a new section on YP terms that might be useful to the new user.

(From yocto-docs rev: ab81b6468c39b5c015c7c0654ddf8c4cfd8bd245)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:06:42 +01:00
Scott Rifenbark 5c8f83592b documentation/dev-manual/dev-manual-newbie.xml: edits to Git section.
(From yocto-docs rev: e5844ac3b29aa1206b4c08d9d4b4bb461f9db23b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:06:42 +01:00
Scott Rifenbark f91f0c7fbb documentation/dev-manual/dev-manual-newbie.xml: re-writes of repo and license
I re-wrote the source repositories section a bit to better reflect the
overall picture of how the user finds and decides on source for YP.
Also added some punctuation to the licensing section.

(From yocto-docs rev: 12ec18e58eb4e4dc395c2161908a60d395684ab3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:06:42 +01:00
Scott Rifenbark a220e421f9 documentation/dev-manual/dev-manual-newbie.xml: bad links corrected. (From yocto-docs rev: 77560db929ead2b4ce5cd04dd3a125b941cb4875)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:24 +01:00
Scott Rifenbark 4b6d42f629 documentation/dev-manual/dev-manual-newbie.xml: Initial content added.
This content is the first cut for the chapter.  The original was a copy
of some adt-manual chapter.

(From yocto-docs rev: 4a563c3ed1e82837410ed114a07e39a0ccaad6f7)

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 e925bb268a documenation/dev-manual/dev-manual-newbie.xml: Initial file with new name.
(From yocto-docs rev: c729ce243a09724b79cb8bfbf671b5de38e5ce76)

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