summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-01-05 11:00:59 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-02-14 15:25:27 +0000
commitb797db0db4b472edbee96cd891c9523818d13346 (patch)
tree219fa940ca3407006357c3fc90acb5c252906235 /documentation/dev-manual
parent64c37b5400b489a3b52bbffac59689b392e0e1f0 (diff)
downloadpoky-b797db0db4b472edbee96cd891c9523818d13346.tar.gz
documentation: Created new YP Overview Manual
Fixes [YOCTO #12370] Added a new chapter to the newly created Yocto Project Overview Manual. This chapter originated from the YP Reference Manual and was the old chapter 3, which talked a lot about various concepts. This information is better suited for the new overview manual. The change involved moving the entire chapter and renaming it. This move of the content affected many, many external references and links into the old area. Consequently, I had to recast all these links from the different manual. Changes also included fixing the mega-manual.xml file so that it would include the new overview manual as part of it. Many figures had to be relocated as part of the move as well. This meant deleting them from the ref-manual/figures folder and putting them into the overview-manual/figures folder. (From yocto-docs rev: 87b81358f2bbd02b4a0d966d86c4d7b006d4d78f) 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.xml16
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml13
-rw-r--r--documentation/dev-manual/dev-manual-start.xml18
3 files changed, 24 insertions, 23 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index dd74e7cd65..f04846ae36 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -1507,8 +1507,8 @@
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_REF_URL;#recipe-syntax'>Recipe Syntax</ulink>" 1510 "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#recipe-syntax'>Recipe Syntax</ulink>"
1511 section in the Yocto Project Reference Manual. 1511 section in the Yocto Project Overview Manual.
1512 </note> 1512 </note>
1513 </para> 1513 </para>
1514 1514
@@ -1798,8 +1798,8 @@
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_REF_URL;#ref-development-environment'>The Yocto Project Development Environment</ulink>" 1801 "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#overview-development-environment'>The Yocto Project Development Environment</ulink>"
1802 chapter of the Yocto Project Reference Manual. 1802 chapter of the Yocto Project Overview Manual.
1803 </para> 1803 </para>
1804 </section> 1804 </section>
1805 1805
@@ -1815,8 +1815,8 @@
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_REF_URL;#sources-dev-environment'>Sources</ulink>" 1818 "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#sources-dev-environment'>Sources</ulink>"
1819 section in the Yocto Project Reference Manual. 1819 section in the Yocto Project Overview Manual.
1820 </para> 1820 </para>
1821 1821
1822 <para> 1822 <para>
@@ -5183,7 +5183,7 @@
5183 can use an existing file provided by the Wic installation. 5183 can use an existing file provided by the Wic installation.
5184 As shipped, kickstart files can be found in the 5184 As shipped, kickstart files can be found in the
5185 Yocto Project 5185 Yocto Project
5186 <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink> 5186 <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink>
5187 in the following two locations: 5187 in the following two locations:
5188 <literallayout class='monospaced'> 5188 <literallayout class='monospaced'>
5189 poky/meta-yocto-bsp/wic 5189 poky/meta-yocto-bsp/wic
@@ -7458,7 +7458,7 @@ Some notes from Cal:
7458 <filename>connman.inc</filename> file in the 7458 <filename>connman.inc</filename> file in the
7459 <filename>meta/recipes-connectivity/connman/</filename> 7459 <filename>meta/recipes-connectivity/connman/</filename>
7460 directory of the <filename>poky</filename> 7460 directory of the <filename>poky</filename>
7461 <ulink url='&YOCTO_DOCS_REF_URL;#yocto-project-repositories'>source repository</ulink>. 7461 <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#yocto-project-repositories'>source repository</ulink>.
7462 You can also find examples in 7462 You can also find examples in
7463 <filename>meta/classes/kernel.bbclass</filename>. 7463 <filename>meta/classes/kernel.bbclass</filename>.
7464 </para> 7464 </para>
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml
index a0fbb4bfd1..638d9112c7 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_REF_URL;#git'>Git</ulink>. 102 <ulink url='&YOCTO_DOCS_OVERVIEW_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.
@@ -310,7 +310,8 @@
310 Consider the following: 310 Consider the following:
311 <itemizedlist> 311 <itemizedlist>
312 <listitem><para> 312 <listitem><para>
313 Use <ulink url='&YOCTO_DOCS_REF_URL;#git'>Git</ulink> 313 Use
314 <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink>
314 as the source control system. 315 as the source control system.
315 </para></listitem> 316 </para></listitem>
316 <listitem><para> 317 <listitem><para>
@@ -324,7 +325,7 @@
324 Separate the project's Metadata and code by using 325 Separate the project's Metadata and code by using
325 separate Git repositories. 326 separate Git repositories.
326 See the 327 See the
327 "<ulink url='&YOCTO_DOCS_REF_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>" 328 "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>"
328 section for information on these repositories. 329 section for information on these repositories.
329 See the 330 See the
330 "<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>"
@@ -548,8 +549,8 @@
548 pull the change into the component's upstream repository. 549 pull the change into the component's upstream repository.
549 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.
550 See the 551 See the
551 "<ulink url='&YOCTO_DOCS_REF_URL;#workflows'>Workflows</ulink>" 552 "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#workflows'>Workflows</ulink>"
552 section in the Yocto Project Reference Manual for additional 553 section in the Yocto Project Overview Manual for additional
553 concepts on working in the Yocto Project development environment. 554 concepts on working in the Yocto Project development environment.
554 </para> 555 </para>
555 556
@@ -748,7 +749,7 @@
748 </para></listitem> 749 </para></listitem>
749 <listitem><para> 750 <listitem><para>
750 <emphasis>Search by File:</emphasis> 751 <emphasis>Search by File:</emphasis>
751 Using <ulink url='&YOCTO_DOCS_REF_URL;#git'>Git</ulink>, 752 Using <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink>,
752 you can enter the following command to bring up a 753 you can enter the following command to bring up a
753 short list of all commits against a specific file: 754 short list of all commits against a specific file:
754 <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 ff8b56e62b..64d048d240 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -262,13 +262,13 @@
262 <listitem><para> 262 <listitem><para>
263 For concepts and introductory information about Git as it 263 For concepts and introductory information about Git as it
264 is used in the Yocto Project, see the 264 is used in the Yocto Project, see the
265 "<ulink url='&YOCTO_DOCS_REF_URL;#git'>Git</ulink>" 265 "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink>"
266 section in the Yocto Project Reference Manual. 266 section in the Yocto Project Overview Manual.
267 </para></listitem> 267 </para></listitem>
268 <listitem><para> 268 <listitem><para>
269 For concepts on Yocto Project source repositories, see the 269 For concepts on Yocto Project source repositories, see the
270 "<ulink url='&YOCTO_DOCS_REF_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>" 270 "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>"
271 section in the Yocto Project Reference Manual." 271 section in the Yocto Project Overview Manual."
272 </para></listitem> 272 </para></listitem>
273 </itemizedlist> 273 </itemizedlist>
274 </note> 274 </note>
@@ -279,7 +279,7 @@
279 279
280 <para> 280 <para>
281 Working from a copy of the upstream Yocto Project 281 Working from a copy of the upstream Yocto Project
282 <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink> 282 <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink>
283 is the preferred method for obtaining and using a Yocto Project 283 is the preferred method for obtaining and using a Yocto Project
284 release. 284 release.
285 You can view the Yocto Project Source Repositories at 285 You can view the Yocto Project Source Repositories at
@@ -308,7 +308,7 @@
308 <listitem><para> 308 <listitem><para>
309 <emphasis>Find the URL Used to Clone the Repository:</emphasis> 309 <emphasis>Find the URL Used to Clone the Repository:</emphasis>
310 At the bottom of the page, note the URL used to 310 At the bottom of the page, note the URL used to
311 <ulink url='&YOCTO_DOCS_REF_URL;#git-commands-clone'>clone</ulink> 311 <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git-commands-clone'>clone</ulink>
312 that repository (e.g. 312 that repository (e.g.
313 <filename>&YOCTO_GIT_URL;/poky</filename>). 313 <filename>&YOCTO_GIT_URL;/poky</filename>).
314 <note> 314 <note>
@@ -468,7 +468,7 @@
468 468
469 <para> 469 <para>
470 You create your Source Directory by using 470 You create your Source Directory by using
471 <ulink url='&YOCTO_DOCS_REF_URL;#git'>Git</ulink> to clone a local 471 <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink> to clone a local
472 copy of the upstream <filename>poky</filename> repository. 472 copy of the upstream <filename>poky</filename> repository.
473 <note><title>Tip</title> 473 <note><title>Tip</title>
474 The preferred method of getting the Yocto Project Source 474 The preferred method of getting the Yocto Project Source
@@ -734,8 +734,8 @@
734 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> 734 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
735 under <filename>tmp/deploy/images</filename>. 735 under <filename>tmp/deploy/images</filename>.
736 For detailed information on the build process using BitBake, see the 736 For detailed information on the build process using BitBake, see the
737 "<ulink url='&YOCTO_DOCS_REF_URL;#images-dev-environment'>Images</ulink>" 737 "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#images-dev-environment'>Images</ulink>"
738 section in the Yocto Project Reference Manual. 738 section in the Yocto Project Overview Manual.
739 You can also reference the 739 You can also reference the
740 "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" 740 "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>"
741 section in the Yocto Project Quick Start. 741 section in the Yocto Project Quick Start.