summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
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 /documentation/ref-manual
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>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/figures/index-downloads.pngbin0 -> 100374 bytes
-rw-r--r--documentation/ref-manual/figures/source-repos.pngbin0 -> 188986 bytes
-rw-r--r--documentation/ref-manual/figures/yp-download.pngbin0 -> 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
6 files changed, 105 insertions, 4 deletions
diff --git a/documentation/ref-manual/figures/index-downloads.png b/documentation/ref-manual/figures/index-downloads.png
new file mode 100644
index 0000000000..41251d5d18
--- /dev/null
+++ b/documentation/ref-manual/figures/index-downloads.png
Binary files differ
diff --git a/documentation/ref-manual/figures/source-repos.png b/documentation/ref-manual/figures/source-repos.png
new file mode 100644
index 0000000000..65c5f29a43
--- /dev/null
+++ b/documentation/ref-manual/figures/source-repos.png
Binary files differ
diff --git a/documentation/ref-manual/figures/yp-download.png b/documentation/ref-manual/figures/yp-download.png
new file mode 100644
index 0000000000..5770be6883
--- /dev/null
+++ 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