From b797db0db4b472edbee96cd891c9523818d13346 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Fri, 5 Jan 2018 11:00:59 -0800 Subject: documentation: Created new YP Overview Manual Fixes [YOCTO #12370] Added a new chapter to the newly created Yocto Project Overview Manual. This chapter originated from the YP Reference Manual and was the old chapter 3, which talked a lot about various concepts. This information is better suited for the new overview manual. The change involved moving the entire chapter and renaming it. This move of the content affected many, many external references and links into the old area. Consequently, I had to recast all these links from the different manual. Changes also included fixing the mega-manual.xml file so that it would include the new overview manual as part of it. Many figures had to be relocated as part of the move as well. This meant deleting them from the ref-manual/figures folder and putting them into the overview-manual/figures folder. (From yocto-docs rev: 87b81358f2bbd02b4a0d966d86c4d7b006d4d78f) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-common-tasks.xml | 16 ++++++++-------- documentation/dev-manual/dev-manual-newbie.xml | 13 +++++++------ documentation/dev-manual/dev-manual-start.xml | 18 +++++++++--------- 3 files changed, 24 insertions(+), 23 deletions(-) (limited to 'documentation/dev-manual') diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index dd74e7cd65..f04846ae36 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -1507,8 +1507,8 @@ For information on recipe syntax, see the - "Recipe Syntax" - section in the Yocto Project Reference Manual. + "Recipe Syntax" + section in the Yocto Project Overview Manual. @@ -1798,8 +1798,8 @@ You can find more information about the build process in - "The Yocto Project Development Environment" - chapter of the Yocto Project Reference Manual. + "The Yocto Project Development Environment" + chapter of the Yocto Project Overview Manual. @@ -1815,8 +1815,8 @@ Your recipe must have a SRC_URI variable that points to where the source is located. For a graphical representation of source locations, see the - "Sources" - section in the Yocto Project Reference Manual. + "Sources" + section in the Yocto Project Overview Manual. @@ -5183,7 +5183,7 @@ can use an existing file provided by the Wic installation. As shipped, kickstart files can be found in the Yocto Project - Source Repositories + Source Repositories in the following two locations: poky/meta-yocto-bsp/wic @@ -7458,7 +7458,7 @@ Some notes from Cal: connman.inc file in the meta/recipes-connectivity/connman/ directory of the poky - source repository. + source repository. You can also find examples in meta/classes/kernel.bbclass. diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index a0fbb4bfd1..638d9112c7 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml @@ -99,7 +99,7 @@ with the OpenEmbedded build system is advisable. Of the SCMs BitBake supports, the Yocto Project team strongly recommends using - Git. + Git. Git is a distributed system that is easy to backup, allows you to work remotely, and then connects back to the infrastructure. @@ -310,7 +310,8 @@ Consider the following: - Use Git + Use + Git as the source control system. @@ -324,7 +325,7 @@ Separate the project's Metadata and code by using separate Git repositories. See the - "Yocto Project Source Repositories" + "Yocto Project Source Repositories" section for information on these repositories. See the "Working With Yocto Project Source Files" @@ -548,8 +549,8 @@ pull the change into the component's upstream repository. You do this by pushing to a contribution repository that is upstream. See the - "Workflows" - section in the Yocto Project Reference Manual for additional + "Workflows" + section in the Yocto Project Overview Manual for additional concepts on working in the Yocto Project development environment. @@ -748,7 +749,7 @@ Search by File: - Using Git, + Using Git, you can enter the following command to bring up a short list of all commits against a specific file: diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index ff8b56e62b..64d048d240 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml @@ -262,13 +262,13 @@ For concepts and introductory information about Git as it is used in the Yocto Project, see the - "Git" - section in the Yocto Project Reference Manual. + "Git" + section in the Yocto Project Overview Manual. For concepts on Yocto Project source repositories, see the - "Yocto Project Source Repositories" - section in the Yocto Project Reference Manual." + "Yocto Project Source Repositories" + section in the Yocto Project Overview Manual." @@ -279,7 +279,7 @@ Working from a copy of the upstream Yocto Project - Source Repositories + Source Repositories is the preferred method for obtaining and using a Yocto Project release. You can view the Yocto Project Source Repositories at @@ -308,7 +308,7 @@ Find the URL Used to Clone the Repository: At the bottom of the page, note the URL used to - clone + clone that repository (e.g. &YOCTO_GIT_URL;/poky). @@ -468,7 +468,7 @@ You create your Source Directory by using - Git to clone a local + Git to clone a local copy of the upstream poky repository. Tip The preferred method of getting the Yocto Project Source @@ -734,8 +734,8 @@ Build Directory under tmp/deploy/images. For detailed information on the build process using BitBake, see the - "Images" - section in the Yocto Project Reference Manual. + "Images" + section in the Yocto Project Overview Manual. You can also reference the "Building Images" section in the Yocto Project Quick Start. -- cgit v1.2.3-54-g00ecf