summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-01-29 15:18:03 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-02-14 15:25:29 +0000
commitae06e04cd225d2c2147ca355e2dd39b4f6cf6775 (patch)
treec920e85262a91e7626279e7dcbbd56a299919f49 /documentation/dev-manual
parentebc7de094881dd8f2450aa4fdf548f2e9c835df1 (diff)
downloadpoky-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')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml30
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml10
-rw-r--r--documentation/dev-manual/dev-manual-start.xml12
3 files changed, 26 insertions, 26 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>
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml
index 638d9112c7..acbdc280a4 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_OVERVIEW_URL;#git'>Git</ulink>. 102 <ulink url='&YOCTO_DOCS_GS_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_OVERVIEW_URL;#git'>Git</ulink> 314 <ulink url='&YOCTO_DOCS_GS_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_OVERVIEW_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>" 328 "<ulink url='&YOCTO_DOCS_GS_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_OVERVIEW_URL;#workflows'>Workflows</ulink>" 552 "<ulink url='&YOCTO_DOCS_GS_URL;#workflows'>Workflows</ulink>"
553 section in the Yocto Project Overview Manual for additional 553 section in the Yocto Project Overview 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_OVERVIEW_URL;#git'>Git</ulink>, 752 Using <ulink url='&YOCTO_DOCS_GS_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 27237c0d20..356abdf0a8 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_OVERVIEW_URL;#git'>Git</ulink>" 263 "<ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink>"
264 section in the Yocto Project Overview Manual. 264 section in the Yocto Project Overview 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_OVERVIEW_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>" 268 "<ulink url='&YOCTO_DOCS_GS_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>"
269 section in the Yocto Project Overview Manual." 269 section in the Yocto Project Overview 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_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink> 280 <ulink url='&YOCTO_DOCS_GS_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_OVERVIEW_URL;#git-commands-clone'>clone</ulink> 309 <ulink url='&YOCTO_DOCS_GS_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>
@@ -466,7 +466,7 @@
466 466
467 <para> 467 <para>
468 You create your Source Directory by using 468 You create your Source Directory by using
469 <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink> to clone a local 469 <ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink> to clone a local
470 copy of the upstream <filename>poky</filename> repository. 470 copy of the upstream <filename>poky</filename> repository.
471 <note><title>Tip</title> 471 <note><title>Tip</title>
472 The preferred method of getting the Yocto Project Source 472 The preferred method of getting the Yocto Project Source
@@ -741,7 +741,7 @@
741 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> 741 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
742 under <filename>tmp/deploy/images</filename>. 742 under <filename>tmp/deploy/images</filename>.
743 For detailed information on the build process using BitBake, see the 743 For detailed information on the build process using BitBake, see the
744 "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#images-dev-environment'>Images</ulink>" 744 "<ulink url='&YOCTO_DOCS_GS_URL;#images-dev-environment'>Images</ulink>"
745 section in the Yocto Project Overview Manual. 745 section in the Yocto Project Overview Manual.
746 </para> 746 </para>
747 747