diff options
Diffstat (limited to 'documentation/ref-manual/ref-development-environment.xml')
-rw-r--r-- | documentation/ref-manual/ref-development-environment.xml | 101 |
1 files changed, 101 insertions, 0 deletions
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 | ||