summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-development-environment.xml
Commit message (Collapse)AuthorAgeFilesLines
* documentation: Purged "oe-init-build-env-memres" from docsScott Rifenbark2017-09-221-5/+2
| | | | | | | | | | | | | | Fixes [YOCTO #11968] Purged all occurrences of the "oe-init-build-env-memres" script from the YP documentation set. Occurrences in a lot of places. The BBSERVER variable was also impacted and had to have the definition updated. (From yocto-docs rev: 274b05108d1bc53df20c11ab2efa15363bce23da) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Moved recipe syntax section to ref-manualScott Rifenbark2017-09-021-4/+303
| | | | | | | | | | | The section on recipe syntax that was buried in the creating a new recipe section was really a reference on syntax. I have moved it to the ref-manual. (From yocto-docs rev: cb55d1b5832cca6faa6e2a5b26f3add3032cade2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Re-write of dev-manual setup chapterScott Rifenbark2017-07-121-1/+1
| | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #11630] The chapter on setting up YP has been completely re-written to move towards a "how-to" manual. This involved touching every aspect of the chapter. All subsections now have procedures surrounding set up stuff. There are some development sections that still need fleshed out. Many, many links and references in other chapters were affected. These have been fixed. A couple style-sheet (*.css) files were also updated to support the "writernotes" style, which renders paragraph text in red. (From yocto-docs rev: c4c2a6cf575ce5c783b1cc84d9f7e961aebef49c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Added procedure for Downloads pageScott Rifenbark2017-07-121-6/+12
| | | | | | | | | | | | Fixes [YOCTO #11630] Added a new procedure section for using the Downloads page from the YP website. (From yocto-docs rev: 7efb29dfa7a0960710ca7cf3983048f166c6a13f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Added section on index of releases procedureScott Rifenbark2017-07-121-0/+7
| | | | | | | | | | | | | | | | | Fixes [YOCTO #11630] I have added a new procedure on using the Index of Releases area to get snapshots of various tarballs. I recommend that is not the way you usually want to get files as using Git is recommended. The section exists for completeness. In the ref-manual, I cross-reference the procedures from the associated conceptual areas. (From yocto-docs rev: 812f344966966591d883fbebb4ae1f72c11dd483) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed spelling error.Scott Rifenbark2017-07-121-1/+1
| | | | | | | (From yocto-docs rev: 8dc9623efec7624b137055d21762aeb0c1b36562) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: New section on viewing GUI YP repositoriesScott Rifenbark2017-07-121-1/+1
| | | | | | | | | | | | | Fixes [YOCTO #11630] I created a new procedure for locating and viewing YP source repositories using the GUI-based method. Created an anchor in the ref-manual so I could reference the 'git clone' command. (From yocto-docs rev: 2ae28682407039420f4fcca71a298e1dd34c81f0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Established section on YP source filesScott Rifenbark2017-07-121-1/+1
| | | | | | | | | | | | | | | Fixes [YOCTO #11630] To move toward a "how-to" dev-manual, I am consolidating procedures for locating and establishing local copies of YP source files into a single heading. I set up a "Working With Yocto Project Source Files" section. This will contain sub-sections to find the various areas of YP files and how to clone and check out stuff. (From yocto-docs rev: 87ff4ee41a50e8aed6b9c5402c51bb47f5a252a3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Changes section head for sumbitting change to YPScott Rifenbark2017-06-221-3/+3
| | | | | | | | | | | | | Fixes [YOCTO #11630] I changed the section heading for the section that describes how to make a change to the YP. It was passive. I need it to be active and in line with the "how-to" dev-manual. (From yocto-docs rev: 340e1b6ab9806ec11ec894d4472bc2c937c2b058) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added "see also" informational note at beginning.Scott Rifenbark2017-06-221-10/+21
| | | | | | | (From yocto-docs rev: 3af3d821b6e26fd352223f3f4196e0e200614203) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Moved "Git" section to the ref-manualScott Rifenbark2017-06-221-1/+355
| | | | | | | | | | | | | | | | Fixes [YOCTO #11630] The "Git" section in the dev-manual is really about concepts. There are a couple of examples that might or not might be allowed to ultimately stay. I have moved the section to the ref-manual. If those examples get replicated in the new dev-manual, I will update the "Git" section further. For now, however, these remain in this moved section. (From yocto-docs rev: 2e4b87fdab29c13ce0d2314e50c93e37404b6f7e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Moved "Workflows" section to ref-manualScott Rifenbark2017-06-221-0/+191
| | | | | | | | | | | | | Fixes [YOCTO #11630] I moved the "Workflows" section to the ref-manual. This section is primarily concepts and needs to be out of the dev-manual, which is being reconstituted into a "how-to" manual. (From yocto-docs rev: 2f8bfaac3da9e2d7042ea381a3e8957f96b5bf5a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Moved "Licenses" section to ref-manualScott Rifenbark2017-06-221-1/+85
| | | | | | | | | | | | | | Fixes [YOCTO #11630] Moved the "Licenses" section from the dev-manual to the ref-manual. The information in the section is purely reference material and does not belong in the dev-manual, which is being reconstructed as a "how-to" manual. (From yocto-docs rev: a89cb18f6cab6702a2bf2a0f77d46e64f82b1729) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Moved "Yocto Project Source Repositories" sectionScott Rifenbark2017-06-221-0/+101
| | | | | | | | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #11630] The "Yocto Project Source Repositories" section is purely conceptual and thus does not belong in the reconstituted dev-manual, which is converting to a "how-to" manual. I have moved this section to the ref-manual under "The Yocto Project Development Environment" section. Moving the section affected several things. Three figures that where in the dev-manual were copied and moved to the figures folder of the ref-manual. This required deleting them from the dev-manual and adding them to the ref-manual. The makefile had to be edited to move those figures into the ref-manual and delete them from the latest version of the dev-manual in order for the tarball of files to be correct when the manuals are made. Links to anchors within the moved section had to be fixed in various manuals. Links to the main section "id" had to be fixed to point to the ref-manual manual. (From yocto-docs rev: c619ae2bbc6be93cb0324ca44e936eefec12b28c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual: Moved "Open Source Philosophy" to ref-manual.Scott Rifenbark2017-06-221-3/+57
| | | | | | | | | | | | | | | | | Fixes [YOCTO #11630] The "Open Source Philosophy" section that was in the dev-manual is really conceptual reference information and has no place in the dev-manual, which is being re-written to be a "how-to" manual. I moved the section into the new "ref-development-environment.xml" chapter. No links were affected by this. (From yocto-docs rev: 0a3e65bf7a23eec6e36a3cda3c2011b70aef325b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Re-org for "closer-look" chapterScott Rifenbark2017-06-221-0/+1635
Fixes [YOCTO #11630] The ref-manual needs expansion for the old "closer-look" chapter. This chapter previously held a detailed look at what happens when a user uses the YP to develop something. Now, the chapter needs to also contain YP development environment concepts (e.g. open- source philosophy, etc.), which are coming from the dev-manual. Because of this, I renamed the "closer-look.xml" chapter to be "ref-development-environment.xml". I also renamed the larger section that was formerly the entire chapter into its own section named "Development Concepts". Both these changes caused a few links to break. I fixed all the links from within the various manuals so they would find appropriate targets. I did some re-writing for introductory material to introduce the new chapter and the section on "Development Concepts". A new file ("ref-development-environment.xml") was added by basically renaming the "closer-look.xml" chapter. And, the tracking for "closer-look.xml" was deleted. (From yocto-docs rev: e37806474578b4f0ed137f64d68a39a17ab60644) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>