From 800ee0167a4badcfad88ff1b885c711c9b137ed9 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 14 Jun 2017 07:43:11 -0700 Subject: dev-manual: Fixed broken links to "Source Directory" term. Fixes [YOCTO #11630] Moving the "Yocto Project Terms" section from dev-manual to ref-manual broke all the links to the "Source Directory" term. I fixed them. (From yocto-docs rev: d3a206b141e0b0c623362622ec73bbf44118071a) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-common-tasks.xml | 32 +++++++++++----------- documentation/dev-manual/dev-manual-model.xml | 14 ++++++---- documentation/dev-manual/dev-manual-newbie.xml | 18 ++++++------ documentation/dev-manual/dev-manual-start.xml | 6 ++-- 4 files changed, 36 insertions(+), 34 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 108ac78fe0..8f39d19044 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -59,7 +59,7 @@ Layers - The Source Directory + The Source Directory contains both general layers and BSP layers right out of the box. You can easily identify layers that ship with a @@ -438,7 +438,7 @@ Clone the repository alongside other meta directories in the - Source Directory. + Source Directory. Following these recommendations keeps your Source Directory and @@ -736,7 +736,7 @@ As an example, consider the main formfactor recipe and a corresponding formfactor append file both from the - Source Directory. + Source Directory. Here is the main formfactor recipe, which is named formfactor_0.0.bb and located in the "meta" layer at @@ -3074,7 +3074,7 @@ class. See the systemd.bbclass file located in your - Source Directory. + Source Directory. section for more information. @@ -4177,7 +4177,7 @@ Several examples exist in the meta-skeleton layer found in the - Source Directory: + Source Directory: conf/multilib-example.conf configuration file @@ -4203,7 +4203,7 @@ Many standard recipes are already extended and support multiple libraries. You can check in the meta/conf/multilib.conf configuration file in the - Source Directory to see how this is + Source Directory to see how this is done using the BBCLASSEXTEND variable. @@ -5188,7 +5188,7 @@ The directory in which these files reside is scripts/lib/image/canned-wks/ located in the - Source Directory. + Source Directory. Because the available files reside in this directory, you can create and add your own custom files to the directory. @@ -5937,7 +5937,7 @@ script found in the Build Directory. You must also be sure of the state of your build in the - Source Directory. + Source Directory. The following commands run menuconfig assuming the Source Directory's top-level folder is ~/poky: @@ -6371,7 +6371,7 @@ or even altering the source code itself. You can use the yocto-kernel script - found in the Source Directory + found in the Source Directory under scripts to manage kernel patches and configuration. See the "Managing kernel Patches and Config Items with yocto-kernel" section in the Yocto Project Board Support Packages (BSP) Developer's Guide for @@ -6389,7 +6389,7 @@ The example assumes a clean build exists for the qemux86 machine in a - Source Directory + Source Directory named poky. Furthermore, the Build Directory @@ -6814,7 +6814,7 @@ The security flags are in the meta/conf/distro/include/security_flags.inc file in your - Source Directory + Source Directory (e.g. poky). Depending on the recipe, certain security flags are enabled @@ -7108,7 +7108,7 @@ The TEMPLATECONF variable is set in the .templateconf file, which is in the top-level - Source Directory + Source Directory folder (e.g. poky). Edit the .templateconf so that it can locate your directory. @@ -7298,7 +7298,7 @@ To help you see where you currently are with kernel and root filesystem sizes, you can use two tools found in the - Source Directory in + Source Directory in the scripts/tiny/ directory: ksize.py: Reports @@ -10251,7 +10251,7 @@ All test files reside in meta/lib/oeqa/runtime in the - Source Directory. + Source Directory. A test name maps directly to a Python module. Each test module may contain a number of individual tests. Tests are usually grouped together by the area @@ -11350,7 +11350,7 @@ Once the patch file exists, you need to add it back to the originating recipe folder. Here is an example assuming a top-level - Source Directory + Source Directory named poky: $ cp patches/parallelmake.patch poky/meta/recipes-connectivity/neard/neard @@ -11700,7 +11700,7 @@ browse errors, view statistics, and query for errors. The tool works using a client-server system where the client portion is integrated with the installed Yocto Project - Source Directory + Source Directory (e.g. poky). The server receives the information collected and saves it in a database. diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 068fd66893..39d7b98f53 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml @@ -123,8 +123,9 @@ "The Build Host Packages" sections both in the Yocto Project Quick Start for requirements. Establish a local copy of the project files on your - system: You need this Source - Directory available on your host system. + system: You need this + Source Directory + available on your host system. Having these files on your system gives you access to the build process and to the tools you need. For information on how to set up the Source Directory, @@ -178,7 +179,7 @@ and edgerouter (MIPS). The recipes and configurations for these five BSPs are located and dispersed within the - Source Directory. + Source Directory. @@ -471,8 +472,9 @@ "The Build Host Packages" sections both in the Yocto Project Quick Start for requirements. Establish a local copy of project files on your - system: Having the Source - Directory on your system gives you access to the build process and tools + system: Having the + Source Directory + on your system gives you access to the build process and tools you need. For information on how to get these files, see the bulleted item "Yocto Project Release" earlier in this manual. @@ -1381,7 +1383,7 @@ S variable. Below is the default value for the S variable as defined in the meta/conf/bitbake.conf configuration file in the - Source Directory: + Source Directory: S = "${WORKDIR}/${BP}" diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index b9fc265211..b64036af61 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml @@ -418,7 +418,7 @@ column and see the URL at the bottom of the page that you need to clone a Git repository for that particular item. Having a local Git repository of the - Source Directory, which is + Source Directory, which is usually named "poky", allows you to make changes, contribute to the history, and ultimately enhance the Yocto Project's tools, Board Support Packages, and so forth. @@ -435,7 +435,7 @@ The recommended method for setting up the Yocto Project - Source Directory + Source Directory and the files for supported BSPs (e.g., meta-intel) is to use Git to create a local copy of @@ -444,7 +444,7 @@ Be sure to always work in matching branches for both the selected BSP repository and the - Source Directory + Source Directory (i.e. poky) repository. For example, if you have checked out the "master" branch of poky and you are going to use @@ -522,7 +522,7 @@ When you build an image using the Yocto Project, the build process uses a known list of licenses to ensure compliance. You can find this list in the - Source Directory at + Source Directory at meta/files/common-licenses. Once the build completes, the list of all licenses found and used during that build are kept in the @@ -554,7 +554,7 @@ You can find a list of the combined SPDX and OSI licenses that the Yocto Project uses in the meta/files/common-licenses directory in your - Source Directory. + Source Directory. @@ -665,7 +665,7 @@ $ git checkout -b &DISTRO_NAME_NO_CAP; origin/&DISTRO_NAME_NO_CAP; In this example, the name of the top-level directory of your local - Source Directory + Source Directory is "poky" and the name of that local working area (local branch) you just created and checked out is "&DISTRO_NAME_NO_CAP;". The files in your local repository now reflect the same files that @@ -960,7 +960,7 @@ workflow. You can find these scripts in the scripts folder of the - Source Directory. + Source Directory. For information on how to use these scripts, see the "Using Scripts to Push a Change Upstream and Request a Pull" section. @@ -1216,7 +1216,7 @@ Maintenance File: Examine the maintainers.inc file, which is located in the - Source Directory + Source Directory at meta-poky/conf/distro/include, to see who is responsible for code. @@ -1371,7 +1371,7 @@ These scripts are create-pull-request and send-pull-request. You can find these scripts in the scripts directory - within the Source Directory. + within the Source Directory. Using these scripts correctly formats the requests without introducing any whitespace or HTML formatting. The maintainer that receives your patches needs to be able to save and apply them diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 1808feb5c3..4dbcc7e34a 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml @@ -25,7 +25,7 @@ The Yocto Project is an open-source collaboration project focused on embedded Linux development. The project currently provides a build system that is referred to as the - OpenEmbedded build system + OpenEmbedded build system in the Yocto Project documentation. The Yocto Project provides various ancillary tools for the embedded developer and also features the Sato reference User Interface, which is optimized for @@ -85,7 +85,7 @@ You need a release of the Yocto Project locally installed on your development system. The documentation refers to this set of locally installed files - as the Source Directory. + as the Source Directory. You create your Source Directory by using Git to clone a local copy of the upstream poky repository, @@ -251,7 +251,7 @@ Be sure to work in the meta-intel branch that matches your - Source Directory + Source Directory (i.e. poky) branch. For example, if you have checked out the "master" branch of poky and you are going to use -- cgit v1.2.3-54-g00ecf