diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-04-12 10:57:32 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-05-24 17:16:13 +0100 |
commit | 1b877bc9dd3e9048489e6868020876af812cfa5e (patch) | |
tree | fa48122df594b4477be6529f51cf5f9255ebaaef /documentation/dev-manual | |
parent | 7105c52799c506961ec59e28681d8d6b588ffb4a (diff) | |
download | poky-1b877bc9dd3e9048489e6868020876af812cfa5e.tar.gz |
documentation: Updated everything for new overview-manual
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>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 28 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-newbie.xml | 10 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-start.xml | 12 |
3 files changed, 25 insertions, 25 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index fd1734beec..85b3a4a8a2 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -24,7 +24,7 @@ | |||
24 | each other. | 24 | each other. |
25 | For introductory information on the Yocto Project Layer Model, | 25 | For introductory information on the Yocto Project Layer Model, |
26 | see the | 26 | see the |
27 | "<ulink url='&YOCTO_DOCS_GS_URL;#the-yocto-project-layer-model'>The Yocto Project Layer Model</ulink>" | 27 | "<ulink url='&YOCTO_DOCS_OM_URL;#the-yocto-project-layer-model'>The Yocto Project Layer Model</ulink>" |
28 | section in the Yocto Project Overview and Concepts Manual. | 28 | section in the Yocto Project Overview and Concepts Manual. |
29 | </para> | 29 | </para> |
30 | 30 | ||
@@ -1855,7 +1855,7 @@ | |||
1855 | 1855 | ||
1856 | <para> | 1856 | <para> |
1857 | You can find more information about the build process in | 1857 | You can find more information about the build process in |
1858 | "<ulink url='&YOCTO_DOCS_GS_URL;#overview-development-environment'>The Yocto Project Development Environment</ulink>" | 1858 | "<ulink url='&YOCTO_DOCS_OM_URL;#overview-development-environment'>The Yocto Project Development Environment</ulink>" |
1859 | chapter of the Yocto Project Overview and Concepts Manual. | 1859 | chapter of the Yocto Project Overview and Concepts Manual. |
1860 | </para> | 1860 | </para> |
1861 | </section> | 1861 | </section> |
@@ -1872,7 +1872,7 @@ | |||
1872 | Your recipe must have a <filename>SRC_URI</filename> variable | 1872 | Your recipe must have a <filename>SRC_URI</filename> variable |
1873 | that points to where the source is located. | 1873 | that points to where the source is located. |
1874 | For a graphical representation of source locations, see the | 1874 | For a graphical representation of source locations, see the |
1875 | "<ulink url='&YOCTO_DOCS_GS_URL;#sources-dev-environment'>Sources</ulink>" | 1875 | "<ulink url='&YOCTO_DOCS_OM_URL;#sources-dev-environment'>Sources</ulink>" |
1876 | section in the Yocto Project Overview and Concepts Manual. | 1876 | section in the Yocto Project Overview and Concepts Manual. |
1877 | </para> | 1877 | </para> |
1878 | 1878 | ||
@@ -2185,7 +2185,7 @@ | |||
2185 | containing the current checksum. | 2185 | containing the current checksum. |
2186 | For more explanation and examples of how to set the | 2186 | For more explanation and examples of how to set the |
2187 | <filename>LIC_FILES_CHKSUM</filename> variable, see the | 2187 | <filename>LIC_FILES_CHKSUM</filename> variable, see the |
2188 | "<ulink url='&YOCTO_DOCS_GS_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>" | 2188 | "<ulink url='&YOCTO_DOCS_OM_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>" |
2189 | section in the Yocto Project Overview and Concepts | 2189 | section in the Yocto Project Overview and Concepts |
2190 | Manual.</para> | 2190 | Manual.</para> |
2191 | 2191 | ||
@@ -2334,7 +2334,7 @@ | |||
2334 | automatically add a runtime dependency to "mypackage" on | 2334 | automatically add a runtime dependency to "mypackage" on |
2335 | "example"). | 2335 | "example"). |
2336 | See the | 2336 | See the |
2337 | "<ulink url='&YOCTO_DOCS_GS_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" | 2337 | "<ulink url='&YOCTO_DOCS_OM_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" |
2338 | section in the Yocto Project Overview and Concepts Manual for | 2338 | section in the Yocto Project Overview and Concepts Manual for |
2339 | further details. | 2339 | further details. |
2340 | </para> | 2340 | </para> |
@@ -3398,7 +3398,7 @@ | |||
3398 | The variable | 3398 | The variable |
3399 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</ulink></filename> | 3399 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</ulink></filename> |
3400 | is used to track source license changes as described in the | 3400 | is used to track source license changes as described in the |
3401 | "<ulink url='&YOCTO_DOCS_GS_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>" | 3401 | "<ulink url='&YOCTO_DOCS_OM_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>" |
3402 | section in the Yocto Project Overview and Concepts Manual. | 3402 | section in the Yocto Project Overview and Concepts Manual. |
3403 | You can quickly create Autotool-based recipes in a manner | 3403 | You can quickly create Autotool-based recipes in a manner |
3404 | similar to the previous example. | 3404 | similar to the previous example. |
@@ -3606,7 +3606,7 @@ | |||
3606 | allows runtime dependencies between packages | 3606 | allows runtime dependencies between packages |
3607 | to be added automatically. | 3607 | to be added automatically. |
3608 | See the | 3608 | See the |
3609 | "<ulink url='&YOCTO_DOCS_GS_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" | 3609 | "<ulink url='&YOCTO_DOCS_OM_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" |
3610 | section in the Yocto Project Overview and | 3610 | section in the Yocto Project Overview and |
3611 | Concepts Manual for more information. | 3611 | Concepts Manual for more information. |
3612 | </para></listitem> | 3612 | </para></listitem> |
@@ -6347,7 +6347,7 @@ | |||
6347 | can use an existing file provided by the Wic installation. | 6347 | can use an existing file provided by the Wic installation. |
6348 | As shipped, kickstart files can be found in the | 6348 | As shipped, kickstart files can be found in the |
6349 | Yocto Project | 6349 | Yocto Project |
6350 | <ulink url='&YOCTO_DOCS_GS_URL;#source-repositories'>Source Repositories</ulink> | 6350 | <ulink url='&YOCTO_DOCS_OM_URL;#source-repositories'>Source Repositories</ulink> |
6351 | in the following two locations: | 6351 | in the following two locations: |
6352 | <literallayout class='monospaced'> | 6352 | <literallayout class='monospaced'> |
6353 | poky/meta-yocto-bsp/wic | 6353 | poky/meta-yocto-bsp/wic |
@@ -8506,7 +8506,7 @@ Some notes from Cal: | |||
8506 | 8506 | ||
8507 | <para> | 8507 | <para> |
8508 | Because the OpenEmbedded build system uses | 8508 | Because the OpenEmbedded build system uses |
8509 | "<ulink url='&YOCTO_DOCS_GS_URL;#overview-checksums'>signatures</ulink>", | 8509 | "<ulink url='&YOCTO_DOCS_OM_URL;#overview-checksums'>signatures</ulink>", |
8510 | which are unique to a given build, the build system | 8510 | which are unique to a given build, the build system |
8511 | knows when to rebuild packages. | 8511 | knows when to rebuild packages. |
8512 | All the inputs into a given task are represented by a | 8512 | All the inputs into a given task are represented by a |
@@ -8610,7 +8610,7 @@ Some notes from Cal: | |||
8610 | 8610 | ||
8611 | <para> | 8611 | <para> |
8612 | For more information on shared state, see the | 8612 | For more information on shared state, see the |
8613 | "<ulink url='&YOCTO_DOCS_GS_URL;#shared-state-cache'>Shared State Cache</ulink>" | 8613 | "<ulink url='&YOCTO_DOCS_OM_URL;#shared-state-cache'>Shared State Cache</ulink>" |
8614 | section in the Yocto Project Overview and Concepts | 8614 | section in the Yocto Project Overview and Concepts |
8615 | Manual. | 8615 | Manual. |
8616 | </para> | 8616 | </para> |
@@ -8856,7 +8856,7 @@ Some notes from Cal: | |||
8856 | <filename>connman.inc</filename> file in the | 8856 | <filename>connman.inc</filename> file in the |
8857 | <filename>meta/recipes-connectivity/connman/</filename> | 8857 | <filename>meta/recipes-connectivity/connman/</filename> |
8858 | directory of the <filename>poky</filename> | 8858 | directory of the <filename>poky</filename> |
8859 | <ulink url='&YOCTO_DOCS_GS_URL;#yocto-project-repositories'>source repository</ulink>. | 8859 | <ulink url='&YOCTO_DOCS_OM_URL;#yocto-project-repositories'>source repository</ulink>. |
8860 | You can also find examples in | 8860 | You can also find examples in |
8861 | <filename>meta/classes/kernel.bbclass</filename>. | 8861 | <filename>meta/classes/kernel.bbclass</filename>. |
8862 | </para> | 8862 | </para> |
@@ -10399,7 +10399,7 @@ Some notes from Cal: | |||
10399 | Enabling build history as previously described causes the | 10399 | Enabling build history as previously described causes the |
10400 | OpenEmbedded build system to collect build output information | 10400 | OpenEmbedded build system to collect build output information |
10401 | and commit it as a single commit to a local | 10401 | and commit it as a single commit to a local |
10402 | <ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink> | 10402 | <ulink url='&YOCTO_DOCS_OM_URL;#git'>Git</ulink> |
10403 | repository. | 10403 | repository. |
10404 | <note> | 10404 | <note> |
10405 | Enabling build history increases your build times slightly, | 10405 | Enabling build history increases your build times slightly, |
@@ -12261,7 +12261,7 @@ Some notes from Cal: | |||
12261 | ${BUILDDIR}/tmp/stamps/i586-poky-linux/db/6.0.30-r1.do_fetch.sigdata.7c048c18222b16ff0bcee2000ef648b1 | 12261 | ${BUILDDIR}/tmp/stamps/i586-poky-linux/db/6.0.30-r1.do_fetch.sigdata.7c048c18222b16ff0bcee2000ef648b1 |
12262 | </literallayout> | 12262 | </literallayout> |
12263 | For tasks that are accelerated through the shared state | 12263 | For tasks that are accelerated through the shared state |
12264 | (<ulink url='&YOCTO_DOCS_GS_URL;#shared-state-cache'>sstate</ulink>) | 12264 | (<ulink url='&YOCTO_DOCS_OM_URL;#shared-state-cache'>sstate</ulink>) |
12265 | cache, an additional <filename>siginfo</filename> file | 12265 | cache, an additional <filename>siginfo</filename> file |
12266 | is written into | 12266 | is written into |
12267 | <ulink url='&YOCTO_DOCS_REF_URL;#var-SSTATE_DIR'><filename>SSTATE_DIR</filename></ulink> | 12267 | <ulink url='&YOCTO_DOCS_REF_URL;#var-SSTATE_DIR'><filename>SSTATE_DIR</filename></ulink> |
@@ -12370,7 +12370,7 @@ Some notes from Cal: | |||
12370 | <filename>-c</filename>, BitBake will only run the task if it | 12370 | <filename>-c</filename>, BitBake will only run the task if it |
12371 | considers it "out of date". | 12371 | considers it "out of date". |
12372 | See the | 12372 | See the |
12373 | "<ulink url='&YOCTO_DOCS_GS_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>" | 12373 | "<ulink url='&YOCTO_DOCS_OM_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>" |
12374 | section in the Yocto Project Overview and Concepts Manual for | 12374 | section in the Yocto Project Overview and Concepts Manual for |
12375 | how BitBake determines whether a task is "out of date". | 12375 | how BitBake determines whether a task is "out of date". |
12376 | </para> | 12376 | </para> |
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 1579a4e89e..6ccf21882b 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml | |||
@@ -99,7 +99,7 @@ | |||
99 | with the OpenEmbedded build system is advisable. | 99 | with the OpenEmbedded build system is advisable. |
100 | Of the SCMs BitBake supports, the | 100 | Of the SCMs BitBake supports, the |
101 | Yocto Project team strongly recommends using | 101 | Yocto Project team strongly recommends using |
102 | <ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink>. | 102 | <ulink url='&YOCTO_DOCS_OM_URL;#git'>Git</ulink>. |
103 | Git is a distributed system that is easy to backup, | 103 | Git is a distributed system that is easy to backup, |
104 | allows you to work remotely, and then connects back to the | 104 | allows you to work remotely, and then connects back to the |
105 | infrastructure. | 105 | infrastructure. |
@@ -311,7 +311,7 @@ | |||
311 | <itemizedlist> | 311 | <itemizedlist> |
312 | <listitem><para> | 312 | <listitem><para> |
313 | Use | 313 | Use |
314 | <ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink> | 314 | <ulink url='&YOCTO_DOCS_OM_URL;#git'>Git</ulink> |
315 | as the source control system. | 315 | as the source control system. |
316 | </para></listitem> | 316 | </para></listitem> |
317 | <listitem><para> | 317 | <listitem><para> |
@@ -325,7 +325,7 @@ | |||
325 | Separate the project's Metadata and code by using | 325 | Separate the project's Metadata and code by using |
326 | separate Git repositories. | 326 | separate Git repositories. |
327 | See the | 327 | See the |
328 | "<ulink url='&YOCTO_DOCS_GS_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>" | 328 | "<ulink url='&YOCTO_DOCS_OM_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>" |
329 | section for information on these repositories. | 329 | section for information on these repositories. |
330 | See the | 330 | See the |
331 | "<link linkend='working-with-yocto-project-source-files'>Working With Yocto Project Source Files</link>" | 331 | "<link linkend='working-with-yocto-project-source-files'>Working With Yocto Project Source Files</link>" |
@@ -549,7 +549,7 @@ | |||
549 | pull the change into the component's upstream repository. | 549 | pull the change into the component's upstream repository. |
550 | You do this by pushing to a contribution repository that is upstream. | 550 | You do this by pushing to a contribution repository that is upstream. |
551 | See the | 551 | See the |
552 | "<ulink url='&YOCTO_DOCS_GS_URL;#gs-git-workflows-and-the-yocto-project'>Git Workflows and the Yocto Project</ulink>" | 552 | "<ulink url='&YOCTO_DOCS_OM_URL;#gs-git-workflows-and-the-yocto-project'>Git Workflows and the Yocto Project</ulink>" |
553 | section in the Yocto Project Overview and Concepts Manual for additional | 553 | section in the Yocto Project Overview and Concepts Manual for additional |
554 | concepts on working in the Yocto Project development environment. | 554 | concepts on working in the Yocto Project development environment. |
555 | </para> | 555 | </para> |
@@ -749,7 +749,7 @@ | |||
749 | </para></listitem> | 749 | </para></listitem> |
750 | <listitem><para> | 750 | <listitem><para> |
751 | <emphasis>Search by File:</emphasis> | 751 | <emphasis>Search by File:</emphasis> |
752 | Using <ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink>, | 752 | Using <ulink url='&YOCTO_DOCS_OM_URL;#git'>Git</ulink>, |
753 | you can enter the following command to bring up a | 753 | you can enter the following command to bring up a |
754 | short list of all commits against a specific file: | 754 | short list of all commits against a specific file: |
755 | <literallayout class='monospaced'> | 755 | <literallayout class='monospaced'> |
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index f7f274bc8d..87d8757a09 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml | |||
@@ -260,12 +260,12 @@ | |||
260 | <listitem><para> | 260 | <listitem><para> |
261 | For concepts and introductory information about Git as it | 261 | For concepts and introductory information about Git as it |
262 | is used in the Yocto Project, see the | 262 | is used in the Yocto Project, see the |
263 | "<ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink>" | 263 | "<ulink url='&YOCTO_DOCS_OM_URL;#git'>Git</ulink>" |
264 | section in the Yocto Project Overview and Concepts Manual. | 264 | section in the Yocto Project Overview and Concepts Manual. |
265 | </para></listitem> | 265 | </para></listitem> |
266 | <listitem><para> | 266 | <listitem><para> |
267 | For concepts on Yocto Project source repositories, see the | 267 | For concepts on Yocto Project source repositories, see the |
268 | "<ulink url='&YOCTO_DOCS_GS_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>" | 268 | "<ulink url='&YOCTO_DOCS_OM_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>" |
269 | section in the Yocto Project Overview and Concepts Manual." | 269 | section in the Yocto Project Overview and Concepts Manual." |
270 | </para></listitem> | 270 | </para></listitem> |
271 | </itemizedlist> | 271 | </itemizedlist> |
@@ -277,7 +277,7 @@ | |||
277 | 277 | ||
278 | <para> | 278 | <para> |
279 | Working from a copy of the upstream Yocto Project | 279 | Working from a copy of the upstream Yocto Project |
280 | <ulink url='&YOCTO_DOCS_GS_URL;#source-repositories'>Source Repositories</ulink> | 280 | <ulink url='&YOCTO_DOCS_OM_URL;#source-repositories'>Source Repositories</ulink> |
281 | is the preferred method for obtaining and using a Yocto Project | 281 | is the preferred method for obtaining and using a Yocto Project |
282 | release. | 282 | release. |
283 | You can view the Yocto Project Source Repositories at | 283 | You can view the Yocto Project Source Repositories at |
@@ -306,7 +306,7 @@ | |||
306 | <listitem><para> | 306 | <listitem><para> |
307 | <emphasis>Find the URL Used to Clone the Repository:</emphasis> | 307 | <emphasis>Find the URL Used to Clone the Repository:</emphasis> |
308 | At the bottom of the page, note the URL used to | 308 | At the bottom of the page, note the URL used to |
309 | <ulink url='&YOCTO_DOCS_GS_URL;#git-commands-clone'>clone</ulink> | 309 | <ulink url='&YOCTO_DOCS_OM_URL;#git-commands-clone'>clone</ulink> |
310 | that repository (e.g. | 310 | that repository (e.g. |
311 | <filename>&YOCTO_GIT_URL;/poky</filename>). | 311 | <filename>&YOCTO_GIT_URL;/poky</filename>). |
312 | <note> | 312 | <note> |
@@ -473,7 +473,7 @@ | |||
473 | 473 | ||
474 | <para> | 474 | <para> |
475 | You create your Source Directory by using | 475 | You create your Source Directory by using |
476 | <ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink> to clone a local | 476 | <ulink url='&YOCTO_DOCS_OM_URL;#git'>Git</ulink> to clone a local |
477 | copy of the upstream <filename>poky</filename> repository. | 477 | copy of the upstream <filename>poky</filename> repository. |
478 | <note><title>Tip</title> | 478 | <note><title>Tip</title> |
479 | The preferred method of getting the Yocto Project Source | 479 | The preferred method of getting the Yocto Project Source |
@@ -748,7 +748,7 @@ | |||
748 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> | 748 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> |
749 | under <filename>tmp/deploy/images</filename>. | 749 | under <filename>tmp/deploy/images</filename>. |
750 | For detailed information on the build process using BitBake, see the | 750 | For detailed information on the build process using BitBake, see the |
751 | "<ulink url='&YOCTO_DOCS_GS_URL;#images-dev-environment'>Images</ulink>" | 751 | "<ulink url='&YOCTO_DOCS_OM_URL;#images-dev-environment'>Images</ulink>" |
752 | section in the Yocto Project Overview and Concepts Manual. | 752 | section in the Yocto Project Overview and Concepts Manual. |
753 | </para> | 753 | </para> |
754 | 754 | ||