mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-31 12:49:46 +00:00
Code Issues Projects Releases Wiki Activity

dev-manual: Fixed broken links to "Source Directory" term.

Browse Source 
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 <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2017-06-14 07:43:11 -07:00
committed by Richard Purdie
parent 2ff49eaea0
commit 800ee0167a
4 changed files with 36 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/dev-manual/dev-manual-common-tasks.xml
+16 -16
View File
@@ -59,7 +59,7 @@
<title>Layers</title>
<para>
The <link linkend='source-directory'>Source Directory</link>
The <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>
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 @@
</para></listitem>
<listitem><para>Clone the repository alongside other
<filename>meta</filename> directories in the
<link linkend='source-directory'>Source Directory</link>.
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>.
</para></listitem>
</itemizedlist>
Following these recommendations keeps your Source Directory and
@@ -736,7 +736,7 @@
<para>
As an example, consider the main formfactor recipe and a
corresponding formfactor append file both from the
<link linkend='source-directory'>Source Directory</link>.
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>.
Here is the main formfactor recipe, which is named
<filename>formfactor_0.0.bb</filename> and located in the
"meta" layer at
@@ -3074,7 +3074,7 @@
class.
See the <filename>systemd.bbclass</filename> file
located in your
<link linkend='source-directory'>Source Directory</link>.
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>.
section for more information.
</para></listitem>
</itemizedlist>
@@ -4177,7 +4177,7 @@
<para>
Several examples exist in the
<filename>meta-skeleton</filename> layer found in the
<link linkend='source-directory'>Source Directory</link>:
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>:
<itemizedlist>
<listitem><para><filename>conf/multilib-example.conf</filename>
configuration file</para></listitem>
@@ -4203,7 +4203,7 @@
Many standard recipes are already extended and support multiple libraries.
You can check in the <filename>meta/conf/multilib.conf</filename>
configuration file in the
<link linkend='source-directory'>Source Directory</link> to see how this is
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink> to see how this is
done using the
<ulink url='&YOCTO_DOCS_REF_URL;#var-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></ulink>
variable.
@@ -5188,7 +5188,7 @@
The directory in which these files reside is
<filename>scripts/lib/image/canned-wks/</filename>
located in the
<link linkend='source-directory'>Source Directory</link>.
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>.
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
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
You must also be sure of the state of your build in the
<link linkend='source-directory'>Source Directory</link>.
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>.
The following commands run <filename>menuconfig</filename>
assuming the Source Directory's top-level folder is
<filename>~/poky</filename>:
@@ -6371,7 +6371,7 @@
or even altering the source code itself.
<note>
You can use the <filename>yocto-kernel</filename> script
found in the <link linkend='source-directory'>Source Directory</link>
found in the <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>
under <filename>scripts</filename> to manage kernel patches and configuration.
See the "<ulink url='&YOCTO_DOCS_BSP_URL;#managing-kernel-patches-and-config-items-with-yocto-kernel'>Managing kernel Patches and Config Items with yocto-kernel</ulink>"
section in the Yocto Project Board Support Packages (BSP) Developer's Guide for
@@ -6389,7 +6389,7 @@
<para>
The example assumes a clean build exists for the <filename>qemux86</filename>
machine in a
<link linkend='source-directory'>Source Directory</link>
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>
named <filename>poky</filename>.
Furthermore, the
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
@@ -6814,7 +6814,7 @@
The security flags are in the
<filename>meta/conf/distro/include/security_flags.inc</filename>
file in your
<link linkend='source-directory'>Source Directory</link>
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>
(e.g. <filename>poky</filename>).
<note>
Depending on the recipe, certain security flags are enabled
@@ -7108,7 +7108,7 @@
The <filename>TEMPLATECONF</filename> variable is set in the
<filename>.templateconf</filename> file, which is in the
top-level
<link linkend='source-directory'>Source Directory</link>
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>
folder (e.g. <filename>poky</filename>).
Edit the <filename>.templateconf</filename> so that it can locate
your directory.
@@ -7298,7 +7298,7 @@
<para>
To help you see where you currently are with kernel and root
filesystem sizes, you can use two tools found in the
<link linkend='source-directory'>Source Directory</link> in
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink> in
the <filename>scripts/tiny/</filename> directory:
<itemizedlist>
<listitem><para><filename>ksize.py</filename>: Reports
@@ -10251,7 +10251,7 @@
<para>
All test files reside in
<filename>meta/lib/oeqa/runtime</filename> in the
<link linkend='source-directory'>Source Directory</link>.
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>.
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
<link linkend='source-directory'>Source Directory</link>
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>
named <filename>poky</filename>:
<literallayout class='monospaced'>
$ 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
<link linkend='source-directory'>Source Directory</link>
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>
(e.g. <filename>poky</filename>).
The server receives the information collected and saves it in a
database.
documentation/dev-manual/dev-manual-model.xml
+8 -6
View File
@@ -123,8 +123,9 @@
"<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Build Host Packages</ulink>" sections both
in the Yocto Project Quick Start for requirements.</para></listitem>
<listitem><para><emphasis>Establish a local copy of the project files on your
system</emphasis>: You need this <link linkend='source-directory'>Source
Directory</link> available on your host system.
system</emphasis>: You need this
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>
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 <filename>edgerouter</filename> (MIPS).
The recipes and configurations for these five BSPs
are located and dispersed within the
<link linkend='source-directory'>Source Directory</link>.
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>.
</para>
<para>
@@ -471,8 +472,9 @@
"<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Build Host Packages</ulink>" sections both
in the Yocto Project Quick Start for requirements.</para></listitem>
<listitem><para><emphasis>Establish a local copy of project files on your
system</emphasis>: Having the <link linkend='source-directory'>Source
Directory</link> on your system gives you access to the build process and tools
system</emphasis>: Having the
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>
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
"<link linkend='local-yp-release'>Yocto Project Release</link>" earlier in this manual.
@@ -1381,7 +1383,7 @@
<filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink></filename> variable.
Below is the default value for the <filename>S</filename> variable as defined in the
<filename>meta/conf/bitbake.conf</filename> configuration file in the
<link linkend='source-directory'>Source Directory</link>:
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>:
<literallayout class='monospaced'>
S = "${WORKDIR}/${BP}"
</literallayout>
documentation/dev-manual/dev-manual-newbie.xml
+9 -9
View File
@@ -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
<link linkend='source-directory'>Source Directory</link>, which is
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>, 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 @@
<itemizedlist>
<listitem><para>
The recommended method for setting up the Yocto Project
<link linkend='source-directory'>Source Directory</link>
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>
and the files for supported BSPs
(e.g., <filename>meta-intel</filename>) is to use
<link linkend='git'>Git</link> to create a local copy of
@@ -444,7 +444,7 @@
<listitem><para>
Be sure to always work in matching branches for both
the selected BSP repository and the
<link linkend='source-directory'>Source Directory</link>
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>
(i.e. <filename>poky</filename>) repository.
For example, if you have checked out the "master" branch
of <filename>poky</filename> 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
<link linkend='source-directory'>Source Directory</link> at
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink> at
<filename>meta/files/common-licenses</filename>.
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
<filename>meta/files/common-licenses</filename> directory in your
<link linkend='source-directory'>Source Directory</link>.
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>.
</para>
<para>
@@ -665,7 +665,7 @@
$ git checkout -b &DISTRO_NAME_NO_CAP; origin/&DISTRO_NAME_NO_CAP;
</literallayout>
In this example, the name of the top-level directory of your local
<link linkend='source-directory'>Source Directory</link>
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>
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 <filename>scripts</filename>
folder of the
<link linkend='source-directory'>Source Directory</link>.
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>.
For information on how to use these scripts, see the
"<link linkend='pushing-a-change-upstream'>Using Scripts to Push a Change Upstream and Request a Pull</link>" section.
</para></listitem>
@@ -1216,7 +1216,7 @@
<emphasis>Maintenance File:</emphasis>
Examine the <filename>maintainers.inc</filename> file, which is
located in the
<link linkend='source-directory'>Source Directory</link>
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>
at <filename>meta-poky/conf/distro/include</filename>, to
see who is responsible for code.
</para></listitem>
@@ -1371,7 +1371,7 @@
These scripts are <filename>create-pull-request</filename> and
<filename>send-pull-request</filename>.
You can find these scripts in the <filename>scripts</filename> directory
within the <link linkend='source-directory'>Source Directory</link>.</para>
within the <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>.</para>
<para>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
documentation/dev-manual/dev-manual-start.xml
+3 -3
View File
@@ -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
<ulink url='&YOCTO_DOCS_REF;#build-system-term'>OpenEmbedded build system</ulink>
<ulink url='&YOCTO_DOCS_REF_URL;#build-system-term'>OpenEmbedded build system</ulink>
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 <link linkend='source-directory'>Source Directory</link>.
as the <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>.
You create your Source Directory by using
<link linkend='git'>Git</link> to clone a local copy
of the upstream <filename>poky</filename> repository,
@@ -251,7 +251,7 @@
<note>
Be sure to work in the <filename>meta-intel</filename>
branch that matches your
<link linkend='source-directory'>Source Directory</link>
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>
(i.e. <filename>poky</filename>) branch.
For example, if you have checked out the "master" branch
of <filename>poky</filename> and you are going to use