summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-06-14 11:17:21 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-06-22 09:16:43 +0100
commit216ee69227fe97c19d5da4c3d828b7cc5d8a437f (patch)
tree468474516f0450c7c79c5c8d22589a4b5c52739a
parent12cc5f7ab27ae9ed4e9131e81b91de7606faa278 (diff)
downloadpoky-216ee69227fe97c19d5da4c3d828b7cc5d8a437f.tar.gz
documentation: Moved "Yocto Project Source Repositories" section
Fixes [YOCTO #11630] The "Yocto Project Source Repositories" section is purely conceptual and thus does not belong in the reconstituted dev-manual, which is converting to a "how-to" manual. I have moved this section to the ref-manual under "The Yocto Project Development Environment" section. Moving the section affected several things. Three figures that where in the dev-manual were copied and moved to the figures folder of the ref-manual. This required deleting them from the dev-manual and adding them to the ref-manual. The makefile had to be edited to move those figures into the ref-manual and delete them from the latest version of the dev-manual in order for the tarball of files to be correct when the manuals are made. Links to anchors within the moved section had to be fixed in various manuals. Links to the main section "id" had to be fixed to point to the ref-manual manual. (From yocto-docs rev: c619ae2bbc6be93cb0324ca44e936eefec12b28c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/Makefile6
-rw-r--r--documentation/bsp-guide/bsp.xml2
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml2
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml90
-rw-r--r--documentation/kernel-dev/kernel-dev-advanced.xml2
-rw-r--r--documentation/ref-manual/figures/index-downloads.png (renamed from documentation/dev-manual/figures/index-downloads.png)bin100374 -> 100374 bytes
-rw-r--r--documentation/ref-manual/figures/source-repos.png (renamed from documentation/dev-manual/figures/source-repos.png)bin188986 -> 188986 bytes
-rw-r--r--documentation/ref-manual/figures/yp-download.png (renamed from documentation/dev-manual/figures/yp-download.png)bin230971 -> 230971 bytes
-rw-r--r--documentation/ref-manual/migration.xml4
-rw-r--r--documentation/ref-manual/ref-development-environment.xml101
-rw-r--r--documentation/ref-manual/ref-release-process.xml4
11 files changed, 113 insertions, 98 deletions
diff --git a/documentation/Makefile b/documentation/Makefile
index 9077c81215..131c0b7f33 100644
--- a/documentation/Makefile
+++ b/documentation/Makefile
@@ -130,9 +130,8 @@ TARFILES = dev-style.css dev-manual.html \
130TARFILES = dev-style.css dev-manual.html \ 130TARFILES = dev-style.css dev-manual.html \
131 figures/bsp-dev-flow.png \ 131 figures/bsp-dev-flow.png \
132 figures/dev-title.png figures/git-workflow.png \ 132 figures/dev-title.png figures/git-workflow.png \
133 figures/index-downloads.png figures/kernel-dev-flow.png \ 133 figures/kernel-dev-flow.png \
134 figures/kernel-overview-1.png figures/kernel-overview-2-generic.png \ 134 figures/kernel-overview-1.png figures/kernel-overview-2-generic.png \
135 figures/source-repos.png figures/yp-download.png \
136 figures/recipe-workflow.png \ 135 figures/recipe-workflow.png \
137 figures/devtool-add-flow.png figures/devtool-modify-flow.png \ 136 figures/devtool-add-flow.png figures/devtool-modify-flow.png \
138 figures/devtool-upgrade-flow.png \ 137 figures/devtool-upgrade-flow.png \
@@ -271,7 +270,8 @@ TARFILES = ref-manual.html ref-style.css figures/poky-title.png \
271 figures/patching.png figures/configuration-compile-autoreconf.png \ 270 figures/patching.png figures/configuration-compile-autoreconf.png \
272 figures/analysis-for-package-splitting.png figures/image-generation.png \ 271 figures/analysis-for-package-splitting.png figures/image-generation.png \
273 figures/sdk-generation.png figures/building-an-image.png \ 272 figures/sdk-generation.png figures/building-an-image.png \
274 figures/build-workspace-directory.png 273 figures/build-workspace-directory.png figures/source-repos.png \
274 figures/index-downloads.png figures/yp-download.png
275MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse 275MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse
276FIGURES = figures 276FIGURES = figures
277STYLESHEET = $(DOC)/*.css 277STYLESHEET = $(DOC)/*.css
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index 40c2a7dd27..7dc7ad37d9 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -55,7 +55,7 @@
55 To help understand the BSP layer concept, consider the BSPs that the 55 To help understand the BSP layer concept, consider the BSPs that the
56 Yocto Project supports and provides with each release. 56 Yocto Project supports and provides with each release.
57 You can see the layers in the 57 You can see the layers in the
58 <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink> 58 <ulink url='&YOCTO_DOCS_REF_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>
59 through a web interface at 59 through a web interface at
60 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'></ulink>. 60 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'></ulink>.
61 If you go to that interface, you will find near the bottom of the list 61 If you go to that interface, you will find near the bottom of the list
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 0a9c1800e3..1d5859ddc9 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -8335,7 +8335,7 @@
8335 <filename>connman.inc</filename> file in the 8335 <filename>connman.inc</filename> file in the
8336 <filename>meta/recipes-connectivity/connman/</filename> 8336 <filename>meta/recipes-connectivity/connman/</filename>
8337 directory of the <filename>poky</filename> 8337 directory of the <filename>poky</filename>
8338 <link linkend='yocto-project-repositories'>source repository</link>. 8338 <ulink url='&YOCTO_DOCS_REF_URL;#yocto-project-repositories'>source repository</ulink>.
8339 You can also find examples in 8339 You can also find examples in
8340 <filename>meta/classes/kernel.bbclass</filename>. 8340 <filename>meta/classes/kernel.bbclass</filename>.
8341 </para> 8341 </para>
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml
index 4fae151432..a881295ce0 100644
--- a/documentation/dev-manual/dev-manual-newbie.xml
+++ b/documentation/dev-manual/dev-manual-newbie.xml
@@ -317,7 +317,7 @@
317 Separate the project's Metadata and code by using 317 Separate the project's Metadata and code by using
318 separate Git repositories. 318 separate Git repositories.
319 See the 319 See the
320 "<link linkend='yocto-project-repositories'>Yocto Project Source Repositories</link>" 320 "<ulink url='&YOCTO_DOC_REF_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>"
321 section for information on these repositories. 321 section for information on these repositories.
322 See the 322 See the
323 "<link linkend='getting-setup'>Getting Set Up</link>" 323 "<link linkend='getting-setup'>Getting Set Up</link>"
@@ -354,92 +354,6 @@
354 </section> 354 </section>
355</section> 355</section>
356 356
357<section id='yocto-project-repositories'>
358 <title>Yocto Project Source Repositories</title>
359
360 <para>
361 The Yocto Project team maintains complete source repositories for all
362 Yocto Project files at
363 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'></ulink>.
364 This web-based source code browser is organized into categories by
365 function such as IDE Plugins, Matchbox, Poky, Yocto Linux Kernel, and
366 so forth.
367 From the interface, you can click on any particular item in the "Name"
368 column and see the URL at the bottom of the page that you need to clone
369 a Git repository for that particular item.
370 Having a local Git repository of the
371 <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>, which is
372 usually named "poky", allows
373 you to make changes, contribute to the history, and ultimately enhance
374 the Yocto Project's tools, Board Support Packages, and so forth.
375 </para>
376
377 <para>
378 For any supported release of Yocto Project, you can also go to the
379 <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink> and
380 select the "Downloads" tab and get a released tarball of the
381 <filename>poky</filename> repository or any supported BSP tarballs.
382 Unpacking these tarballs gives you a snapshot of the released
383 files.
384 <note><title>Notes</title>
385 <itemizedlist>
386 <listitem><para>
387 The recommended method for setting up the Yocto Project
388 <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>
389 and the files for supported BSPs
390 (e.g., <filename>meta-intel</filename>) is to use
391 <link linkend='git'>Git</link> to create a local copy of
392 the upstream repositories.
393 </para></listitem>
394 <listitem><para>
395 Be sure to always work in matching branches for both
396 the selected BSP repository and the
397 <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>
398 (i.e. <filename>poky</filename>) repository.
399 For example, if you have checked out the "master" branch
400 of <filename>poky</filename> and you are going to use
401 <filename>meta-intel</filename>, be sure to checkout the
402 "master" branch of <filename>meta-intel</filename>.
403 </para></listitem>
404 </itemizedlist>
405 </note>
406 </para>
407
408 <para>
409 In summary, here is where you can get the project files needed for development:
410 <itemizedlist>
411 <listitem><para id='source-repositories'><emphasis><ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'>Source Repositories:</ulink></emphasis>
412 This area contains IDE Plugins, Matchbox, Poky, Poky Support, Tools, Yocto Linux Kernel, and Yocto
413 Metadata Layers.
414 You can create local copies of Git repositories for each of these areas.</para>
415 <para>
416 <imagedata fileref="figures/source-repos.png" align="center" width="6in" depth="4in" />
417 </para></listitem>
418 <listitem><para><anchor id='index-downloads' /><emphasis><ulink url='&YOCTO_DL_URL;/releases/'>Index of /releases:</ulink></emphasis>
419 This is an index of releases such as
420 the <trademark class='trade'>Eclipse</trademark>
421 Yocto Plug-in, miscellaneous support, Poky, Pseudo, installers for cross-development toolchains,
422 and all released versions of Yocto Project in the form of images or tarballs.
423 Downloading and extracting these files does not produce a local copy of the
424 Git repository but rather a snapshot of a particular release or image.</para>
425 <para>
426 <imagedata fileref="figures/index-downloads.png" align="center" width="6in" depth="3.5in" />
427 </para></listitem>
428 <listitem><para><emphasis>"Downloads" page for the
429 <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>:</emphasis>
430 Access this page by going to the website and then selecting
431 the "Downloads" tab.
432 This page allows you to download any Yocto Project
433 release or Board Support Package (BSP) in tarball form.
434 The tarballs are similar to those found in the
435 <ulink url='&YOCTO_DL_URL;/releases/'>Index of /releases:</ulink> area.</para>
436 <para>
437 <imagedata fileref="figures/yp-download.png" align="center" width="6in" depth="4in" />
438 </para></listitem>
439 </itemizedlist>
440 </para>
441</section>
442
443<section id='licensing'> 357<section id='licensing'>
444 <title>Licensing</title> 358 <title>Licensing</title>
445 359
@@ -540,7 +454,7 @@
540 454
541 <para> 455 <para>
542 As mentioned earlier in the section 456 As mentioned earlier in the section
543 "<link linkend='yocto-project-repositories'>Yocto Project Source Repositories</link>", 457 "<ulink url='&YOCTO_DOCS_REF_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>",
544 the Yocto Project maintains source repositories at 458 the Yocto Project maintains source repositories at
545 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>. 459 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.
546 If you look at this web-interface of the repositories, each item is a separate 460 If you look at this web-interface of the repositories, each item is a separate
diff --git a/documentation/kernel-dev/kernel-dev-advanced.xml b/documentation/kernel-dev/kernel-dev-advanced.xml
index 22afc66587..0394e08444 100644
--- a/documentation/kernel-dev/kernel-dev-advanced.xml
+++ b/documentation/kernel-dev/kernel-dev-advanced.xml
@@ -658,7 +658,7 @@
658 Consider the Minnow BSP definition from the 658 Consider the Minnow BSP definition from the
659 <filename>linux-yocto-4.4</filename> in the 659 <filename>linux-yocto-4.4</filename> in the
660 Yocto Project 660 Yocto Project
661 <ulink url='&YOCTO_DOCS_DEV_URL;#source-repositories'>Source Repositories</ulink> 661 <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink>
662 (i.e. 662 (i.e.
663 <filename>yocto-kernel-cache/bsp/minnow</filename>): 663 <filename>yocto-kernel-cache/bsp/minnow</filename>):
664 <literallayout class='monospaced'> 664 <literallayout class='monospaced'>
diff --git a/documentation/dev-manual/figures/index-downloads.png b/documentation/ref-manual/figures/index-downloads.png
index 41251d5d18..41251d5d18 100644
--- a/documentation/dev-manual/figures/index-downloads.png
+++ b/documentation/ref-manual/figures/index-downloads.png
Binary files differ
diff --git a/documentation/dev-manual/figures/source-repos.png b/documentation/ref-manual/figures/source-repos.png
index 65c5f29a43..65c5f29a43 100644
--- a/documentation/dev-manual/figures/source-repos.png
+++ b/documentation/ref-manual/figures/source-repos.png
Binary files differ
diff --git a/documentation/dev-manual/figures/yp-download.png b/documentation/ref-manual/figures/yp-download.png
index 5770be6883..5770be6883 100644
--- a/documentation/dev-manual/figures/yp-download.png
+++ b/documentation/ref-manual/figures/yp-download.png
Binary files differ
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml
index b6b067b910..a3dc1ee1f6 100644
--- a/documentation/ref-manual/migration.xml
+++ b/documentation/ref-manual/migration.xml
@@ -293,7 +293,7 @@
293 For the remainder, you can now find them in the 293 For the remainder, you can now find them in the
294 <filename>meta-extras</filename> repository, which is in the 294 <filename>meta-extras</filename> repository, which is in the
295 Yocto Project 295 Yocto Project
296 <ulink url='&YOCTO_DOCS_DEV_URL;#source-repositories'>Source Repositories</ulink>. 296 <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink>.
297 </para> 297 </para>
298 </section> 298 </section>
299 </section> 299 </section>
@@ -4035,7 +4035,7 @@ $ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.
4035 <para>For an example, see the 4035 <para>For an example, see the
4036 <filename>pixbufcache</filename> class in 4036 <filename>pixbufcache</filename> class in
4037 <filename>meta/classes/</filename> in the Yocto Project 4037 <filename>meta/classes/</filename> in the Yocto Project
4038 <ulink url='&YOCTO_DOCS_DEV_URL;#source-repositories'>Source Repositories</ulink>. 4038 <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink>.
4039 <note> 4039 <note>
4040 The <filename>SSTATEPOSTINSTFUNCS</filename> variable 4040 The <filename>SSTATEPOSTINSTFUNCS</filename> variable
4041 itself is now deprecated in favor of the 4041 itself is now deprecated in favor of the
diff --git a/documentation/ref-manual/ref-development-environment.xml b/documentation/ref-manual/ref-development-environment.xml
index b19058ed03..6d4a76792e 100644
--- a/documentation/ref-manual/ref-development-environment.xml
+++ b/documentation/ref-manual/ref-development-environment.xml
@@ -65,6 +65,107 @@
65 </para> 65 </para>
66</section> 66</section>
67 67
68<section id='yocto-project-repositories'>
69 <title>Yocto Project Source Repositories</title>
70
71 <para>
72 The Yocto Project team maintains complete source repositories for all
73 Yocto Project files at
74 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'></ulink>.
75 This web-based source code browser is organized into categories by
76 function such as IDE Plugins, Matchbox, Poky, Yocto Linux Kernel, and
77 so forth.
78 From the interface, you can click on any particular item in the "Name"
79 column and see the URL at the bottom of the page that you need to clone
80 a Git repository for that particular item.
81 Having a local Git repository of the
82 <link linkend='source-directory'>Source Directory</link>, which is
83 usually named "poky", allows
84 you to make changes, contribute to the history, and ultimately enhance
85 the Yocto Project's tools, Board Support Packages, and so forth.
86 </para>
87
88 <para>
89 For any supported release of Yocto Project, you can also go to the
90 <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink> and
91 select the "Downloads" tab and get a released tarball of the
92 <filename>poky</filename> repository or any supported BSP tarballs.
93 Unpacking these tarballs gives you a snapshot of the released
94 files.
95 <note><title>Notes</title>
96 <itemizedlist>
97 <listitem><para>
98 The recommended method for setting up the Yocto Project
99 <link linkend='source-directory'>Source Directory</link>
100 and the files for supported BSPs
101 (e.g., <filename>meta-intel</filename>) is to use
102 <link linkend='git'>Git</link> to create a local copy of
103 the upstream repositories.
104 </para></listitem>
105 <listitem><para>
106 Be sure to always work in matching branches for both
107 the selected BSP repository and the
108 <link linkend='source-directory'>Source Directory</link>
109 (i.e. <filename>poky</filename>) repository.
110 For example, if you have checked out the "master" branch
111 of <filename>poky</filename> and you are going to use
112 <filename>meta-intel</filename>, be sure to checkout the
113 "master" branch of <filename>meta-intel</filename>.
114 </para></listitem>
115 </itemizedlist>
116 </note>
117 </para>
118
119 <para>
120 In summary, here is where you can get the project files needed for
121 development:
122 <itemizedlist>
123 <listitem><para id='source-repositories'>
124 <emphasis>
125 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'>Source Repositories:</ulink>
126 </emphasis>
127 This area contains IDE Plugins, Matchbox, Poky, Poky Support,
128 Tools, Yocto Linux Kernel, and Yocto Metadata Layers.
129 You can create local copies of Git repositories for each of
130 these areas.</para>
131
132 <para>
133 <imagedata fileref="figures/source-repos.png" align="center" width="6in" depth="4in" />
134 </para></listitem>
135 <listitem><para><anchor id='index-downloads' />
136 <emphasis>
137 <ulink url='&YOCTO_DL_URL;/releases/'>Index of /releases:</ulink>
138 </emphasis>
139 This is an index of releases such as
140 the <trademark class='trade'>Eclipse</trademark>
141 Yocto Plug-in, miscellaneous support, Poky, Pseudo, installers
142 for cross-development toolchains, and all released versions of
143 Yocto Project in the form of images or tarballs.
144 Downloading and extracting these files does not produce a local
145 copy of the Git repository but rather a snapshot of a
146 particular release or image.</para>
147
148 <para>
149 <imagedata fileref="figures/index-downloads.png" align="center" width="6in" depth="3.5in" />
150 </para></listitem>
151 <listitem><para>
152 <emphasis>"Downloads" page for the
153 <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>:
154 </emphasis>
155 Access this page by going to the website and then selecting
156 the "Downloads" tab.
157 This page allows you to download any Yocto Project
158 release or Board Support Package (BSP) in tarball form.
159 The tarballs are similar to those found in the
160 <ulink url='&YOCTO_DL_URL;/releases/'>Index of /releases:</ulink> area.</para>
161
162 <para>
163 <imagedata fileref="figures/yp-download.png" align="center" width="6in" depth="4in" />
164 </para></listitem>
165 </itemizedlist>
166 </para>
167</section>
168
68<section id="development-concepts"> 169<section id="development-concepts">
69 <title>Development Concepts</title> 170 <title>Development Concepts</title>
70 171
diff --git a/documentation/ref-manual/ref-release-process.xml b/documentation/ref-manual/ref-release-process.xml
index aa1ff89a7d..6f5b1784e3 100644
--- a/documentation/ref-manual/ref-release-process.xml
+++ b/documentation/ref-manual/ref-release-process.xml
@@ -61,7 +61,7 @@
61 <para> 61 <para>
62 Each major release receives a codename that identifies the release in 62 Each major release receives a codename that identifies the release in
63 the 63 the
64 <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>. 64 <ulink url='&YOCTO_DOCS_REF_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>.
65 The concept is that branches of 65 The concept is that branches of
66 <ulink url='&YOCTO_DOCS_REF_URL;#metadata'>Metadata</ulink> 66 <ulink url='&YOCTO_DOCS_REF_URL;#metadata'>Metadata</ulink>
67 with the same codename are likely to be compatible and thus 67 with the same codename are likely to be compatible and thus
@@ -216,7 +216,7 @@
216 in the <filename>poky</filename> repository. 216 in the <filename>poky</filename> repository.
217 <note> 217 <note>
218 You can find all these branches in the Yocto Project 218 You can find all these branches in the Yocto Project
219 <ulink url='&YOCTO_DOCS_DEV_URL;#source-repositories'>Source Repositories</ulink>. 219 <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink>.
220 </note> 220 </note>
221 Testing within these public branches ensures in a publicly visible way 221 Testing within these public branches ensures in a publicly visible way
222 that all of the main supposed architectures and recipes in OE-Core 222 that all of the main supposed architectures and recipes in OE-Core