mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-04-18 03:32:13 +02: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

34
documentation/ref-manual/ref-tasks.xml
View File

@@ -220,7 +220,7 @@
<para>
For more information on image creation, see the
"<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#image-generation-dev-environment'>Image Generation</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#image-generation-dev-environment'>Image Generation</ulink>"
section in the Yocto Project Overview Manual.
</para>
</section>
@@ -246,7 +246,7 @@
<para>
For more information on image creation, see the
"<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#image-generation-dev-environment'>Image Generation</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#image-generation-dev-environment'>Image Generation</ulink>"
section in the Yocto Project Overview Manual.
</para>
</section>
@@ -268,7 +268,7 @@
and
<link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link>),
run under
<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#fakeroot-and-pseudo'>fakeroot</ulink>.
<ulink url='&YOCTO_DOCS_GS_URL;#fakeroot-and-pseudo'>fakeroot</ulink>.
<note>
<title>Caution</title>
@@ -342,7 +342,7 @@
For additional information, see the
<link linkend='var-PKGDESTWORK'><filename>PKGDESTWORK</filename></link>
variable and 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.
</para>
</section>
@@ -367,7 +367,7 @@
<filename>${</filename><link linkend='var-DEPLOY_DIR_DEB'><filename>DEPLOY_DIR_DEB</filename></link><filename>}</filename>
directory in the package feeds area.
For more information, see the
"<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>"
section in the Yocto Project Overview Manual.
</para>
</section>
@@ -381,7 +381,7 @@
<filename>${</filename><link linkend='var-DEPLOY_DIR_IPK'><filename>DEPLOY_DIR_IPK</filename></link><filename>}</filename>
directory in the package feeds area.
For more information, see the
"<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>"
section in the Yocto Project Overview Manual.
</para>
</section>
@@ -395,7 +395,7 @@
<filename>${</filename><link linkend='var-DEPLOY_DIR_RPM'><filename>DEPLOY_DIR_RPM</filename></link><filename>}</filename>
directory in the package feeds area.
For more information, see the
"<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>"
section in the Yocto Project Overview Manual.
</para>
</section>
@@ -408,7 +408,7 @@
<filename>${</filename><link linkend='var-DEPLOY_DIR_TAR'><filename>DEPLOY_DIR_TAR</filename></link><filename>}</filename>
directory in the package feeds area.
For more information, see the
"<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>"
section Yocto Project Overview Manual.
</para>
</section>
@@ -431,7 +431,7 @@
<para>
Locates patch files and applies them to the source code.
See the
"<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#patching-dev-environment'>Patching</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#patching-dev-environment'>Patching</ulink>"
section in the Yocto Project Overview Manual for more information.
</para>
</section>
@@ -451,7 +451,7 @@
<para>
Creates the file and directory structure for an installable SDK.
See the
"<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#sdk-generation-dev-environment'>SDK Generation</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#sdk-generation-dev-environment'>SDK Generation</ulink>"
section in the Yocto Project Overview Manual for more information.
</para>
</section>
@@ -538,7 +538,7 @@
<link linkend='var-S'><filename>S</filename></link> variable also
plays a role in where unpacked source files ultimately reside.
For more information on how source files are unpacked, see the
"<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-fetching-dev-environment'>Source Fetching</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#source-fetching-dev-environment'>Source Fetching</ulink>"
section in the Yocto Project Overview Manual and also see the
<filename>WORKDIR</filename> and
<filename>S</filename> variable descriptions.
@@ -628,7 +628,7 @@
<para>
Running this task does not remove the
<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#shared-state-cache'>sstate</ulink>
<ulink url='&YOCTO_DOCS_GS_URL;#shared-state-cache'>sstate</ulink>
cache files.
Consequently, if no changes have been made and the recipe is
rebuilt after cleaning, output files are simply restored from the
@@ -645,7 +645,7 @@
<para>
Removes all output files, 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, and downloaded source files for a target (i.e. the contents
of
<link linkend='var-DL_DIR'><filename>DL_DIR</filename></link>).
@@ -676,13 +676,13 @@
<para>
Removes all output files and 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 for a target.
Essentially, the <filename>do_cleansstate</filename> task is
identical to the
<link linkend='ref-tasks-clean'><filename>do_clean</filename></link>
task with the added removal of 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.
</para>
@@ -760,7 +760,7 @@
<para>
Creates or updates the index in the
<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>
<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>
area.
<note>
This task is not triggered with the
@@ -812,7 +812,7 @@
Creates the root filesystem (file and directory structure) for an
image.
See the
"<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#image-generation-dev-environment'>Image Generation</ulink>"
"<ulink url='&YOCTO_DOCS_GS_URL;#image-generation-dev-environment'>Image Generation</ulink>"
section in the Yocto Project Overview Manual for more information
on how the root filesystem is created.
</para>