mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-09 05:29:32 +00:00
Code Issues Projects Releases Wiki Activity

documentation: Updated everything for new overview-manual

Browse Source 
This involved changing the root manual folder from
"getting-started" to "overview-manual".

Also, every link using the ENTITY "YOCTO_DOCS_GS_URL" was
changed to "YOCTO_DOCS_OM_URL".  Most manuals had several
occurrences of these links.

The makefile needed updating to process the new manual
and not process the old "getting-started" manual.

(From yocto-docs rev: 1abf64e56e9096258038ae37b787a81bf786bb3b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2018-04-12 10:57:32 -07:00
committed by Richard Purdie
parent 7105c52799
commit 1b877bc9dd
26 changed files with 118 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/dev-manual/dev-manual-common-tasks.xml
+14 -14
View File
@@ -24,7 +24,7 @@
each other.
For introductory information on the Yocto Project Layer Model,
see the
"<ulink url='&YOCTO_DOCS_GS_URL;#the-yocto-project-layer-model'>The Yocto Project Layer Model</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#the-yocto-project-layer-model'>The Yocto Project Layer Model</ulink>"
section in the Yocto Project Overview and Concepts Manual.
</para>
@@ -1855,7 +1855,7 @@
<para>
You can find more information about the build process in
"<ulink url='&YOCTO_DOCS_GS_URL;#overview-development-environment'>The Yocto Project Development Environment</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#overview-development-environment'>The Yocto Project Development Environment</ulink>"
chapter of the Yocto Project Overview and Concepts Manual.
</para>
</section>
@@ -1872,7 +1872,7 @@
Your recipe must have a <filename>SRC_URI</filename> variable
that points to where the source is located.
For a graphical representation of source locations, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#sources-dev-environment'>Sources</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#sources-dev-environment'>Sources</ulink>"
section in the Yocto Project Overview and Concepts Manual.
</para>
@@ -2185,7 +2185,7 @@
containing the current checksum.
For more explanation and examples of how to set the
<filename>LIC_FILES_CHKSUM</filename> variable, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>"
section in the Yocto Project Overview and Concepts
Manual.</para>
@@ -2334,7 +2334,7 @@
automatically add a runtime dependency to "mypackage" on
"example").
See the
"<ulink url='&YOCTO_DOCS_GS_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>"
section in the Yocto Project Overview and Concepts Manual for
further details.
</para>
@@ -3398,7 +3398,7 @@
The variable
<filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</ulink></filename>
is used to track source license changes as described in the
"<ulink url='&YOCTO_DOCS_GS_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>"
section in the Yocto Project Overview and Concepts Manual.
You can quickly create Autotool-based recipes in a manner
similar to the previous example.
@@ -3606,7 +3606,7 @@
allows runtime dependencies between packages
to be added automatically.
See the
"<ulink url='&YOCTO_DOCS_GS_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>"
section in the Yocto Project Overview and
Concepts Manual for more information.
</para></listitem>
@@ -6347,7 +6347,7 @@
can use an existing file provided by the Wic installation.
As shipped, kickstart files can be found in the
Yocto Project
<ulink url='&YOCTO_DOCS_GS_URL;#source-repositories'>Source Repositories</ulink>
<ulink url='&YOCTO_DOCS_OM_URL;#source-repositories'>Source Repositories</ulink>
in the following two locations:
<literallayout class='monospaced'>
poky/meta-yocto-bsp/wic
@@ -8506,7 +8506,7 @@ Some notes from Cal:
<para>
Because the OpenEmbedded build system uses
"<ulink url='&YOCTO_DOCS_GS_URL;#overview-checksums'>signatures</ulink>",
"<ulink url='&YOCTO_DOCS_OM_URL;#overview-checksums'>signatures</ulink>",
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
@@ -8610,7 +8610,7 @@ Some notes from Cal:
<para>
For more information on shared state, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#shared-state-cache'>Shared State Cache</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#shared-state-cache'>Shared State Cache</ulink>"
section in the Yocto Project Overview and Concepts
Manual.
</para>
@@ -8856,7 +8856,7 @@ Some notes from Cal:
<filename>connman.inc</filename> file in the
<filename>meta/recipes-connectivity/connman/</filename>
directory of the <filename>poky</filename>
<ulink url='&YOCTO_DOCS_GS_URL;#yocto-project-repositories'>source repository</ulink>.
<ulink url='&YOCTO_DOCS_OM_URL;#yocto-project-repositories'>source repository</ulink>.
You can also find examples in
<filename>meta/classes/kernel.bbclass</filename>.
</para>
@@ -10399,7 +10399,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
<ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink>
<ulink url='&YOCTO_DOCS_OM_URL;#git'>Git</ulink>
repository.
<note>
Enabling build history increases your build times slightly,
@@ -12261,7 +12261,7 @@ Some notes from Cal:
${BUILDDIR}/tmp/stamps/i586-poky-linux/db/6.0.30-r1.do_fetch.sigdata.7c048c18222b16ff0bcee2000ef648b1
</literallayout>
For tasks that are accelerated through the shared state
(<ulink url='&YOCTO_DOCS_GS_URL;#shared-state-cache'>sstate</ulink>)
(<ulink url='&YOCTO_DOCS_OM_URL;#shared-state-cache'>sstate</ulink>)
cache, an additional <filename>siginfo</filename> file
is written into
<ulink url='&YOCTO_DOCS_REF_URL;#var-SSTATE_DIR'><filename>SSTATE_DIR</filename></ulink>
@@ -12370,7 +12370,7 @@ Some notes from Cal:
<filename>-c</filename>, BitBake will only run the task if it
considers it "out of date".
See the
"<ulink url='&YOCTO_DOCS_GS_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>"
section in the Yocto Project Overview and Concepts Manual for
how BitBake determines whether a task is "out of date".
</para>
documentation/dev-manual/dev-manual-newbie.xml
+5 -5
View File
@@ -99,7 +99,7 @@
with the OpenEmbedded build system is advisable.
Of the SCMs BitBake supports, the
Yocto Project team strongly recommends using
<ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink>.
<ulink url='&YOCTO_DOCS_OM_URL;#git'>Git</ulink>.
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 @@
<itemizedlist>
<listitem><para>
Use
<ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink>
<ulink url='&YOCTO_DOCS_OM_URL;#git'>Git</ulink>
as the source control system.
</para></listitem>
<listitem><para>
@@ -325,7 +325,7 @@
Separate the project's Metadata and code by using
separate Git repositories.
See the
"<ulink url='&YOCTO_DOCS_GS_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>"
section for information on these repositories.
See the
"<link linkend='working-with-yocto-project-source-files'>Working With Yocto Project Source Files</link>"
@@ -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
"<ulink url='&YOCTO_DOCS_GS_URL;#gs-git-workflows-and-the-yocto-project'>Git Workflows and the Yocto Project</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#gs-git-workflows-and-the-yocto-project'>Git Workflows and the Yocto Project</ulink>"
section in the Yocto Project Overview and Concepts Manual for additional
concepts on working in the Yocto Project development environment.
</para>
@@ -749,7 +749,7 @@
</para></listitem>
<listitem><para>
<emphasis>Search by File:</emphasis>
Using <ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink>,
Using <ulink url='&YOCTO_DOCS_OM_URL;#git'>Git</ulink>,
you can enter the following command to bring up a
short list of all commits against a specific file:
<literallayout class='monospaced'>
documentation/dev-manual/dev-manual-start.xml
+6 -6
View File
@@ -260,12 +260,12 @@
<listitem><para>
For concepts and introductory information about Git as it
is used in the Yocto Project, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#git'>Git</ulink>"
section in the Yocto Project Overview and Concepts Manual.
</para></listitem>
<listitem><para>
For concepts on Yocto Project source repositories, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>"
section in the Yocto Project Overview and Concepts Manual."
</para></listitem>
</itemizedlist>
@@ -277,7 +277,7 @@
<para>
Working from a copy of the upstream Yocto Project
<ulink url='&YOCTO_DOCS_GS_URL;#source-repositories'>Source Repositories</ulink>
<ulink url='&YOCTO_DOCS_OM_URL;#source-repositories'>Source Repositories</ulink>
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 @@
<listitem><para>
<emphasis>Find the URL Used to Clone the Repository:</emphasis>
At the bottom of the page, note the URL used to
<ulink url='&YOCTO_DOCS_GS_URL;#git-commands-clone'>clone</ulink>
<ulink url='&YOCTO_DOCS_OM_URL;#git-commands-clone'>clone</ulink>
that repository (e.g.
<filename>&YOCTO_GIT_URL;/poky</filename>).
<note>
@@ -473,7 +473,7 @@
<para>
You create your Source Directory by using
<ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink> to clone a local
<ulink url='&YOCTO_DOCS_OM_URL;#git'>Git</ulink> to clone a local
copy of the upstream <filename>poky</filename> repository.
<note><title>Tip</title>
The preferred method of getting the Yocto Project Source
@@ -748,7 +748,7 @@
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
under <filename>tmp/deploy/images</filename>.
For detailed information on the build process using BitBake, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#images-dev-environment'>Images</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#images-dev-environment'>Images</ulink>"
section in the Yocto Project Overview and Concepts Manual.
</para>