diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-01-29 15:18:03 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-02-14 15:25:29 +0000 |
commit | ae06e04cd225d2c2147ca355e2dd39b4f6cf6775 (patch) | |
tree | c920e85262a91e7626279e7dcbbd56a299919f49 /documentation/dev-manual/dev-manual-common-tasks.xml | |
parent | ebc7de094881dd8f2450aa4fdf548f2e9c835df1 (diff) | |
download | poky-ae06e04cd225d2c2147ca355e2dd39b4f6cf6775.tar.gz |
documentation: Created new "Getting Started" manual.
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>
Diffstat (limited to 'documentation/dev-manual/dev-manual-common-tasks.xml')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 0c2101fde9..8b97c715d7 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -1507,7 +1507,7 @@ | |||
1507 | </itemizedlist> | 1507 | </itemizedlist> |
1508 | <note> | 1508 | <note> |
1509 | For information on recipe syntax, see the | 1509 | For information on recipe syntax, see the |
1510 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#recipe-syntax'>Recipe Syntax</ulink>" | 1510 | "<ulink url='&YOCTO_DOCS_GS_URL;#recipe-syntax'>Recipe Syntax</ulink>" |
1511 | section in the Yocto Project Overview Manual. | 1511 | section in the Yocto Project Overview Manual. |
1512 | </note> | 1512 | </note> |
1513 | </para> | 1513 | </para> |
@@ -1798,7 +1798,7 @@ | |||
1798 | 1798 | ||
1799 | <para> | 1799 | <para> |
1800 | You can find more information about the build process in | 1800 | You can find more information about the build process in |
1801 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#overview-development-environment'>The Yocto Project Development Environment</ulink>" | 1801 | "<ulink url='&YOCTO_DOCS_GS_URL;#overview-development-environment'>The Yocto Project Development Environment</ulink>" |
1802 | chapter of the Yocto Project Overview Manual. | 1802 | chapter of the Yocto Project Overview Manual. |
1803 | </para> | 1803 | </para> |
1804 | </section> | 1804 | </section> |
@@ -1815,7 +1815,7 @@ | |||
1815 | Your recipe must have a <filename>SRC_URI</filename> variable | 1815 | Your recipe must have a <filename>SRC_URI</filename> variable |
1816 | that points to where the source is located. | 1816 | that points to where the source is located. |
1817 | For a graphical representation of source locations, see the | 1817 | For a graphical representation of source locations, see the |
1818 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#sources-dev-environment'>Sources</ulink>" | 1818 | "<ulink url='&YOCTO_DOCS_GS_URL;#sources-dev-environment'>Sources</ulink>" |
1819 | section in the Yocto Project Overview Manual. | 1819 | section in the Yocto Project Overview Manual. |
1820 | </para> | 1820 | </para> |
1821 | 1821 | ||
@@ -2128,7 +2128,7 @@ | |||
2128 | containing the current checksum. | 2128 | containing the current checksum. |
2129 | For more explanation and examples of how to set the | 2129 | For more explanation and examples of how to set the |
2130 | <filename>LIC_FILES_CHKSUM</filename> variable, see the | 2130 | <filename>LIC_FILES_CHKSUM</filename> variable, see the |
2131 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>" | 2131 | "<ulink url='&YOCTO_DOCS_GS_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>" |
2132 | section in the Yocto Project Overview Manual.</para> | 2132 | section in the Yocto Project Overview Manual.</para> |
2133 | <para>To determine the correct checksum string, you | 2133 | <para>To determine the correct checksum string, you |
2134 | can list the appropriate files in the | 2134 | can list the appropriate files in the |
@@ -2275,7 +2275,7 @@ | |||
2275 | automatically add a runtime dependency to "mypackage" on | 2275 | automatically add a runtime dependency to "mypackage" on |
2276 | "example"). | 2276 | "example"). |
2277 | See the | 2277 | See the |
2278 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" | 2278 | "<ulink url='&YOCTO_DOCS_GS_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" |
2279 | in the Yocto Project Overview Manual for further details. | 2279 | in the Yocto Project Overview Manual for further details. |
2280 | </para> | 2280 | </para> |
2281 | </section> | 2281 | </section> |
@@ -3211,7 +3211,7 @@ | |||
3211 | The variable | 3211 | The variable |
3212 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</ulink></filename> | 3212 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</ulink></filename> |
3213 | is used to track source license changes as described in the | 3213 | is used to track source license changes as described in the |
3214 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>" | 3214 | "<ulink url='&YOCTO_DOCS_GS_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>" |
3215 | section in the Yocto Project Overview Manual. | 3215 | section in the Yocto Project Overview Manual. |
3216 | You can quickly create Autotool-based recipes in a manner similar to the previous example. | 3216 | You can quickly create Autotool-based recipes in a manner similar to the previous example. |
3217 | </para> | 3217 | </para> |
@@ -3418,7 +3418,7 @@ | |||
3418 | allows runtime dependencies between packages | 3418 | allows runtime dependencies between packages |
3419 | to be added automatically. | 3419 | to be added automatically. |
3420 | See the | 3420 | See the |
3421 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" | 3421 | "<ulink url='&YOCTO_DOCS_GS_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" |
3422 | section in the Yocto Project Overview Manual | 3422 | section in the Yocto Project Overview Manual |
3423 | for more information. | 3423 | for more information. |
3424 | </para></listitem> | 3424 | </para></listitem> |
@@ -4543,7 +4543,7 @@ | |||
4543 | architectures. | 4543 | architectures. |
4544 | <note> | 4544 | <note> |
4545 | For more information on x32 psABI, see the | 4545 | For more information on x32 psABI, see the |
4546 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#x32'>x32 psABI</ulink>" | 4546 | "<ulink url='&YOCTO_DOCS_GS_URL;#x32'>x32 psABI</ulink>" |
4547 | section in the Yocto Project Overview Manual. | 4547 | section in the Yocto Project Overview Manual. |
4548 | </note> | 4548 | </note> |
4549 | To use the x32 psABI, you need to edit your | 4549 | To use the x32 psABI, you need to edit your |
@@ -5217,7 +5217,7 @@ | |||
5217 | can use an existing file provided by the Wic installation. | 5217 | can use an existing file provided by the Wic installation. |
5218 | As shipped, kickstart files can be found in the | 5218 | As shipped, kickstart files can be found in the |
5219 | Yocto Project | 5219 | Yocto Project |
5220 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink> | 5220 | <ulink url='&YOCTO_DOCS_GS_URL;#source-repositories'>Source Repositories</ulink> |
5221 | in the following two locations: | 5221 | in the following two locations: |
5222 | <literallayout class='monospaced'> | 5222 | <literallayout class='monospaced'> |
5223 | poky/meta-yocto-bsp/wic | 5223 | poky/meta-yocto-bsp/wic |
@@ -7347,7 +7347,7 @@ Some notes from Cal: | |||
7347 | 7347 | ||
7348 | <para> | 7348 | <para> |
7349 | Because the OpenEmbedded build system uses | 7349 | Because the OpenEmbedded build system uses |
7350 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#overview-checksums'>signatures</ulink>", | 7350 | "<ulink url='&YOCTO_DOCS_GS_URL;#overview-checksums'>signatures</ulink>", |
7351 | which are unique to a given build, the build system | 7351 | which are unique to a given build, the build system |
7352 | knows when to rebuild packages. | 7352 | knows when to rebuild packages. |
7353 | All the inputs into a given task are represented by a | 7353 | All the inputs into a given task are represented by a |
@@ -7451,7 +7451,7 @@ Some notes from Cal: | |||
7451 | 7451 | ||
7452 | <para> | 7452 | <para> |
7453 | For more information on shared state, see the | 7453 | For more information on shared state, see the |
7454 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#shared-state-cache'>Shared State Cache</ulink>" | 7454 | "<ulink url='&YOCTO_DOCS_GS_URL;#shared-state-cache'>Shared State Cache</ulink>" |
7455 | section in the Yocto Project Overview Manual. | 7455 | section in the Yocto Project Overview Manual. |
7456 | </para> | 7456 | </para> |
7457 | </note> | 7457 | </note> |
@@ -7696,7 +7696,7 @@ Some notes from Cal: | |||
7696 | <filename>connman.inc</filename> file in the | 7696 | <filename>connman.inc</filename> file in the |
7697 | <filename>meta/recipes-connectivity/connman/</filename> | 7697 | <filename>meta/recipes-connectivity/connman/</filename> |
7698 | directory of the <filename>poky</filename> | 7698 | directory of the <filename>poky</filename> |
7699 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#yocto-project-repositories'>source repository</ulink>. | 7699 | <ulink url='&YOCTO_DOCS_GS_URL;#yocto-project-repositories'>source repository</ulink>. |
7700 | You can also find examples in | 7700 | You can also find examples in |
7701 | <filename>meta/classes/kernel.bbclass</filename>. | 7701 | <filename>meta/classes/kernel.bbclass</filename>. |
7702 | </para> | 7702 | </para> |
@@ -9162,7 +9162,7 @@ Some notes from Cal: | |||
9162 | Enabling build history as previously described causes the | 9162 | Enabling build history as previously described causes the |
9163 | OpenEmbedded build system to collect build output information | 9163 | OpenEmbedded build system to collect build output information |
9164 | and commit it as a single commit to a local | 9164 | and commit it as a single commit to a local |
9165 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink> | 9165 | <ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink> |
9166 | repository. | 9166 | repository. |
9167 | <note> | 9167 | <note> |
9168 | Enabling build history increases your build times slightly, | 9168 | Enabling build history increases your build times slightly, |
@@ -11024,7 +11024,7 @@ Some notes from Cal: | |||
11024 | ${BUILDDIR}/tmp/stamps/i586-poky-linux/db/6.0.30-r1.do_fetch.sigdata.7c048c18222b16ff0bcee2000ef648b1 | 11024 | ${BUILDDIR}/tmp/stamps/i586-poky-linux/db/6.0.30-r1.do_fetch.sigdata.7c048c18222b16ff0bcee2000ef648b1 |
11025 | </literallayout> | 11025 | </literallayout> |
11026 | For tasks that are accelerated through the shared state | 11026 | For tasks that are accelerated through the shared state |
11027 | (<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#shared-state-cache'>sstate</ulink>) | 11027 | (<ulink url='&YOCTO_DOCS_GS_URL;#shared-state-cache'>sstate</ulink>) |
11028 | cache, an additional <filename>siginfo</filename> file | 11028 | cache, an additional <filename>siginfo</filename> file |
11029 | is written into | 11029 | is written into |
11030 | <ulink url='&YOCTO_DOCS_REF_URL;#var-SSTATE_DIR'><filename>SSTATE_DIR</filename></ulink> | 11030 | <ulink url='&YOCTO_DOCS_REF_URL;#var-SSTATE_DIR'><filename>SSTATE_DIR</filename></ulink> |
@@ -11133,7 +11133,7 @@ Some notes from Cal: | |||
11133 | <filename>-c</filename>, BitBake will only run the task if it | 11133 | <filename>-c</filename>, BitBake will only run the task if it |
11134 | considers it "out of date". | 11134 | considers it "out of date". |
11135 | See the | 11135 | See the |
11136 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>" | 11136 | "<ulink url='&YOCTO_DOCS_GS_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>" |
11137 | section in the Yocto Project Overview Manual for how BitBake | 11137 | section in the Yocto Project Overview Manual for how BitBake |
11138 | determines whether a task is "out of date". | 11138 | determines whether a task is "out of date". |
11139 | </para> | 11139 | </para> |