mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-03-06 15:29:40 +01:00
Code Issues Packages Projects Releases Wiki Activity

documentation: Created new "Getting Started" manual.

Browse Source 
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 <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2018-01-29 15:18:03 -08:00
committed by Richard Purdie
parent ebc7de0948
commit ae06e04cd2
148 changed files with 10147 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
documentation/dev-manual/dev-manual-common-tasks.xml
View File

@@ -1507,7 +1507,7 @@
</itemizedlist>
<note>
For information on recipe syntax, see the
"<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#recipe-syntax'>Recipe Syntax</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#recipe-syntax'>Recipe Syntax</ulink>"
section in the Yocto Project Overview Manual.
</note>
</para>
@@ -1798,7 +1798,7 @@
<para>
You can find more information about the build process in
"<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#overview-development-environment'>The Yocto Project Development Environment</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#overview-development-environment'>The Yocto Project Development Environment</ulink>"
chapter of the Yocto Project Overview Manual.
</para>
</section>
@@ -1815,7 +1815,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_OVERVIEW_URL;#sources-dev-environment'>Sources</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#sources-dev-environment'>Sources</ulink>"
section in the Yocto Project Overview Manual.
</para>
@@ -2128,7 +2128,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_OVERVIEW_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>"
section in the Yocto Project Overview Manual.</para>
<para>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
"<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>"
in the Yocto Project Overview Manual for further details.
</para>
</section>
@@ -3211,7 +3211,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_OVERVIEW_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>"
section in the Yocto Project Overview Manual.
You can quickly create Autotool-based recipes in a manner similar to the previous example.
</para>
@@ -3418,7 +3418,7 @@
allows runtime dependencies between packages
to be added automatically.
See the
"<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>"
section in the Yocto Project Overview Manual
for more information.
</para></listitem>
@@ -4543,7 +4543,7 @@
architectures.
<note>
For more information on x32 psABI, see the
"<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#x32'>x32 psABI</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#x32'>x32 psABI</ulink>"
section in the Yocto Project Overview Manual.
</note>
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
<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink>
<ulink url='&YOCTO_DOCS_GS_URL;#source-repositories'>Source Repositories</ulink>
in the following two locations:
<literallayout class='monospaced'>
poky/meta-yocto-bsp/wic
@@ -7347,7 +7347,7 @@ Some notes from Cal:
<para>
Because the OpenEmbedded build system uses
"<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#overview-checksums'>signatures</ulink>",
"<ulink url='&YOCTO_DOCS_GS_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
@@ -7451,7 +7451,7 @@ Some notes from Cal:
<para>
For more information on shared state, see the
"<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#shared-state-cache'>Shared State Cache</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#shared-state-cache'>Shared State Cache</ulink>"
section in the Yocto Project Overview Manual.
</para>
</note>
@@ -7696,7 +7696,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_OVERVIEW_URL;#yocto-project-repositories'>source repository</ulink>.
<ulink url='&YOCTO_DOCS_GS_URL;#yocto-project-repositories'>source repository</ulink>.
You can also find examples in
<filename>meta/classes/kernel.bbclass</filename>.
</para>
@@ -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
<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink>
<ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink>
repository.
<note>
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
</literallayout>
For tasks that are accelerated through the shared state
(<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#shared-state-cache'>sstate</ulink>)
(<ulink url='&YOCTO_DOCS_GS_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>
@@ -11133,7 +11133,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_OVERVIEW_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>"
section in the Yocto Project Overview Manual for how BitBake
determines whether a task is "out of date".
</para>

10
documentation/dev-manual/dev-manual-newbie.xml
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_OVERVIEW_URL;#git'>Git</ulink>.
<ulink url='&YOCTO_DOCS_GS_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_OVERVIEW_URL;#git'>Git</ulink>
<ulink url='&YOCTO_DOCS_GS_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_OVERVIEW_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>"
"<ulink url='&YOCTO_DOCS_GS_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_OVERVIEW_URL;#workflows'>Workflows</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#workflows'>Workflows</ulink>"
section in the Yocto Project Overview 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_OVERVIEW_URL;#git'>Git</ulink>,
Using <ulink url='&YOCTO_DOCS_GS_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'>

12
documentation/dev-manual/dev-manual-start.xml
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_OVERVIEW_URL;#git'>Git</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink>"
section in the Yocto Project Overview Manual.
</para></listitem>
<listitem><para>
For concepts on Yocto Project source repositories, see the
"<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>"
section in the Yocto Project Overview Manual."
</para></listitem>
</itemizedlist>
@@ -277,7 +277,7 @@
<para>
Working from a copy of the upstream Yocto Project
<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink>
<ulink url='&YOCTO_DOCS_GS_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_OVERVIEW_URL;#git-commands-clone'>clone</ulink>
<ulink url='&YOCTO_DOCS_GS_URL;#git-commands-clone'>clone</ulink>
that repository (e.g.
<filename>&YOCTO_GIT_URL;/poky</filename>).
<note>
@@ -466,7 +466,7 @@
<para>
You create your Source Directory by using
<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink> to clone a local
<ulink url='&YOCTO_DOCS_GS_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
@@ -741,7 +741,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_OVERVIEW_URL;#images-dev-environment'>Images</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#images-dev-environment'>Images</ulink>"
section in the Yocto Project Overview Manual.
</para>