From ae06e04cd225d2c2147ca355e2dd39b4f6cf6775 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 29 Jan 2018 15:18:03 -0800 Subject: documentation: Created new "Getting Started" manual. Creation involved removing the overview-manual and replacing it with the getting-started manual. All links to the string "&YOCTO_DOCS_OVERVIEW_URL" had to be replaced with "&YOCTO_DOCS_GS_URL" across the entire YP manual set. I renamed files used to create the manual with prefixes suited for the new manual name, which is "Getting Started With Yocto Project". The style sheet for the new manual needed updating to display the new .PNG image for the title page. The mega-manual file had to be updated to include the files. The mega-manual.sed file had to be updated to include the new manual and not use the overview manual. (From yocto-docs rev: 6c7abf9192390121000f577d6c98f259d290d15d) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-common-tasks.xml | 30 +++++++++++----------- documentation/dev-manual/dev-manual-newbie.xml | 10 ++++---- documentation/dev-manual/dev-manual-start.xml | 12 ++++----- 3 files changed, 26 insertions(+), 26 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 0c2101fde9..8b97c715d7 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -1507,7 +1507,7 @@ For information on recipe syntax, see the - "Recipe Syntax" + "Recipe Syntax" section in the Yocto Project Overview Manual. @@ -1798,7 +1798,7 @@ You can find more information about the build process in - "The Yocto Project Development Environment" + "The Yocto Project Development Environment" chapter of the Yocto Project Overview Manual. @@ -1815,7 +1815,7 @@ 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" + "Sources" section in the Yocto Project Overview Manual. @@ -2128,7 +2128,7 @@ containing the current checksum. For more explanation and examples of how to set the LIC_FILES_CHKSUM variable, see the - "Tracking License Changes" + "Tracking License Changes" section in the Yocto Project Overview Manual. To determine the correct checksum string, you can list the appropriate files in the @@ -2275,7 +2275,7 @@ automatically add a runtime dependency to "mypackage" on "example"). See the - "Automatically Added Runtime Dependencies" + "Automatically Added Runtime Dependencies" in the Yocto Project Overview Manual for further details. @@ -3211,7 +3211,7 @@ The variable LIC_FILES_CHKSUM is used to track source license changes as described in the - "Tracking License Changes" + "Tracking License Changes" section in the Yocto Project Overview Manual. You can quickly create Autotool-based recipes in a manner similar to the previous example. @@ -3418,7 +3418,7 @@ allows runtime dependencies between packages to be added automatically. See the - "Automatically Added Runtime Dependencies" + "Automatically Added Runtime Dependencies" section in the Yocto Project Overview Manual for more information. @@ -4543,7 +4543,7 @@ architectures. For more information on x32 psABI, see the - "x32 psABI" + "x32 psABI" section in the Yocto Project Overview Manual. To use the x32 psABI, you need to edit your @@ -5217,7 +5217,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 @@ -7347,7 +7347,7 @@ Some notes from Cal: Because the OpenEmbedded build system uses - "signatures", + "signatures", which are unique to a given build, the build system knows when to rebuild packages. All the inputs into a given task are represented by a @@ -7451,7 +7451,7 @@ Some notes from Cal: For more information on shared state, see the - "Shared State Cache" + "Shared State Cache" section in the Yocto Project Overview Manual. @@ -7696,7 +7696,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. @@ -9162,7 +9162,7 @@ Some notes from Cal: Enabling build history as previously described causes the OpenEmbedded build system to collect build output information and commit it as a single commit to a local - Git + Git repository. Enabling build history increases your build times slightly, @@ -11024,7 +11024,7 @@ Some notes from Cal: ${BUILDDIR}/tmp/stamps/i586-poky-linux/db/6.0.30-r1.do_fetch.sigdata.7c048c18222b16ff0bcee2000ef648b1 For tasks that are accelerated through the shared state - (sstate) + (sstate) cache, an additional siginfo file is written into SSTATE_DIR @@ -11133,7 +11133,7 @@ Some notes from Cal: -c, BitBake will only run the task if it considers it "out of date". See the - "Stamp Files and the Rerunning of Tasks" + "Stamp Files and the Rerunning of Tasks" section in the Yocto Project Overview Manual for how BitBake determines whether a task is "out of date". diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 638d9112c7..acbdc280a4 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. @@ -311,7 +311,7 @@ Use - Git + Git as the source control system. @@ -325,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" @@ -549,7 +549,7 @@ pull the change into the component's upstream repository. You do this by pushing to a contribution repository that is upstream. See the - "Workflows" + "Workflows" section in the Yocto Project Overview Manual for additional concepts on working in the Yocto Project development environment. @@ -749,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 27237c0d20..356abdf0a8 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml @@ -260,12 +260,12 @@ For concepts and introductory information about Git as it is used in the Yocto Project, see the - "Git" + "Git" section in the Yocto Project Overview Manual. For concepts on Yocto Project source repositories, see the - "Yocto Project Source Repositories" + "Yocto Project Source Repositories" section in the Yocto Project Overview Manual." @@ -277,7 +277,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 @@ -306,7 +306,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). @@ -466,7 +466,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 @@ -741,7 +741,7 @@ Build Directory under tmp/deploy/images. For detailed information on the build process using BitBake, see the - "Images" + "Images" section in the Yocto Project Overview Manual. -- cgit v1.2.3-54-g00ecf