summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKristi Rifenbark <kristi.rifenbark@gmail.com>2017-09-28 16:38:29 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-10-16 23:46:52 +0100
commit0b85ab45df495d9c81a41abed650c833758b09c7 (patch)
tree994e1ef62194c15dd78fbe6b54428ee3280c97db
parentaabfda24156042af6dfb609de94ae9ccad0309a2 (diff)
downloadpoky-0b85ab45df495d9c81a41abed650c833758b09c7.tar.gz
toaster-manual: Added "Use the Fixture Feature" section
Removed two outdated sections, "Use the toasterconf.json File" and "Edit the Configuration File" and replaced them with "Use the Fixture Feature" section. (From yocto-docs rev: 8a247836a958449836effac3600f6923c5289bb6) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/toaster-manual/toaster-manual-reference.xml185
1 files changed, 27 insertions, 158 deletions
diff --git a/documentation/toaster-manual/toaster-manual-reference.xml b/documentation/toaster-manual/toaster-manual-reference.xml
index 78febce358..d4cb04e6b0 100644
--- a/documentation/toaster-manual/toaster-manual-reference.xml
+++ b/documentation/toaster-manual/toaster-manual-reference.xml
@@ -148,177 +148,46 @@
148 </para> 148 </para>
149 </section> 149 </section>
150 150
151 <section id='select-the-toasterconf-json-file'> 151 <section id='use-the-fixture-feature'>
152 <title>Use the <filename>toasterconf.json</filename> File</title> 152 <title>Use the Fixture Feature</title>
153 153
154 <para> 154 <para>
155 If you do not want to use the Administration 155 The Django fixture feature overrides the default layer
156 Interface, you can edit the 156 server when you use it to specify a custom URL. To use
157 <link linkend='toaster-json-files'><filename>toasterconf.json</filename></link> 157 the fixture feature, create (or edit) the file
158 file and reload it to Toaster. 158 <filename>bitbake/lib/toaster.orm/fixtures/custom.xml</filename>,
159 </para> 159 and then set the following Toaster setting to your
160 160 custom URL:
161 <para>
162 The Toaster startup script in
163 <filename>/bitbake/bin/toaster</filename> specifies
164 the location of a Toaster configuration file
165 <filename>toasterconf.json</filename> as the value of
166 the <filename>TOASTER_CONF</filename> variable.
167 This configuration file is used to set up the initial
168 configuration values within the Toaster database
169 including the layer sources.
170 Two versions of the configuration file exist:
171 <itemizedlist>
172 <listitem><para>
173 The first version of the file is found in the
174 <filename>conf</filename> directory of the
175 <filename>meta-poky</filename> layer
176 (i.e.
177 <filename>meta-poky/conf/toasterconf.json</filename>).
178 This version contains the default Yocto Project
179 configuration for Toaster.
180 </para></listitem>
181 <listitem><para>
182 The second version of the file is in the
183 <filename>conf</filename> directory of the
184 <filename>openembedded-core</filename> layer
185 (i.e. <filename>meta/conf/toasterconf.json</filename>).
186 This version contains the default OpenEmbedded
187 configuration for Toaster.
188 </para></listitem>
189 </itemizedlist>
190 </para>
191 </section>
192
193 <section id='edit-the-configuration-file'>
194 <title>Edit the Configuration File</title>
195
196 <para>
197 Edit the version of the
198 <filename>toasterconf.json</filename> file you
199 used to set up your Toaster instance.
200 In the file, you will find a section for layer sources
201 such as the following:
202 <literallayout class='monospaced'> 161 <literallayout class='monospaced'>
203 "layersources": [ 162 &lt;?xml version="1.0" ?&gt;
204 { 163 &lt;django-objects version="1.0"&gt;
205 "name": "Local Yocto Project", 164 &lt;object model="orm.toastersetting" pk="100"&gt;
206 "sourcetype": "local", 165 &lt;field name="name" type="CharField"&gt;CUSTOM_LAYERINDEX_SERVER&lt;/field&gt;
207 "apiurl": "../../", 166 &lt;field name="value" type="CharField"&gt;https://layers.my_organization.org/layerindex/branch/master/layers/&lt;/field&gt;
208 "branches": ["HEAD" ], 167 &lt;/object&gt;
209 "layers": [ 168 &lt;django-objects&gt;
210 {
211 "name": "openembedded-core",
212 "local_path": "meta",
213 "vcs_url": "remote:origin",
214 "dirpath": "meta"
215 },
216 {
217 "name": "meta-poky",
218 "local_path": "meta-poky",
219 "vcs_url": "remote:origin",
220 "dirpath": "meta-poky"
221 },
222 {
223 "name": "meta-yocto-bsp",
224 "local_path": "meta-yocto-bsp",
225 "vcs_url": "remote:origin",
226 "dirpath": "meta-yocto-bsp"
227 }
228
229 ]
230 },
231 {
232 "name": "OpenEmbedded",
233 "sourcetype": "layerindex",
234 "apiurl": "http://layers.openembedded.org/layerindex/api/",
235 "branches": ["master", "jethro" ,"fido"]
236 },
237 {
238 "name": "Imported layers",
239 "sourcetype": "imported",
240 "apiurl": "",
241 "branches": ["master", "jethro","fido", "HEAD"]
242
243 }
244 ],
245 </literallayout> 169 </literallayout>
246 You should add your own layer source to this section by 170 When you start Toaster for the first time, or if you
247 following the same format used for the "OpenEmbedded" 171 delete the file <filename>toaster.sqlite</filename> and restart,
248 layer source shown above. 172 the database will populate from this layer index server.
249 </para> 173 </para>
250 174
251 <para> 175 <para>
252 Give your layer source a name, provide the URL of your 176 Once the information has been updated, verify the new layer
253 layer source API, use the source type "layerindex", and 177 information is available by using the Toaster web interface.
254 indicate which branches from your layer source you want 178 To do that, visit the "All compatible layers" page inside a
255 to make available through Toaster. 179 Toaster project. The layers from your layer source should be
256 For example, the OpenEmbedded layer source makes 180 listed there.
257 available only its "master", "fido", and "jethro"
258 branches.
259 </para>
260
261 <para>
262 The branches must match the branch you
263 set when configuring your releases.
264 For example, if you configure one release in Toaster
265 by setting its branch to "branch-one" and you configure
266 another release in Toaster by setting its branch to
267 "branch-two", the branches in your layer source should
268 be "branch-one" and "branch-two" as well.
269 Doing so creates a connection between the releases
270 and the layer information from your layer source.
271 Thus, when users create a project with a given
272 release, they will see the appropriate layers from
273 your layer source.
274 This connection ensures that only layers that are
275 compatible with the selected project release can be
276 selected for building.
277 </para>
278
279 <para>
280 Once you have added this information to the
281 <filename>toasterconf.json</filename> file, save your
282 changes.
283 </para> 181 </para>
284 182
285 <para> 183 <para>
286 In a terminal window, navigate to the directory that 184 If you change the information in your layer index server,
287 contains the Toaster database, which by default is the 185 refresh the Toaster database by running the following command:
288 root of the Yocto Project
289 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
290 Once you are located in that directory, run the
291 "<filename>loadconf</filename>" command, which takes as
292 an argument the full path to the
293 <filename>toasterconf.json</filename> file you just edited.
294 For example, if you cloned the
295 <filename>poky</filename> repository and you edited the
296 <filename>meta-poky/conf/toasterconf.json</filename> file,
297 you would type something like the following:
298 <literallayout class='monospaced'>
299 $ bitbake/lib/toaster/manage.py loadconf /home/scottrif/poky/meta-poky/conf/toasterconf.json
300 </literallayout>
301 After entering this command, you need to update the
302 Toaster database with the information coming from your
303 new layer source.
304 To do that, you should run the
305 "<filename>lsupdates</filename>" command from the directory
306 that contains the Toaster database.
307 Here is an example:
308 <literallayout class='monospaced'> 186 <literallayout class='monospaced'>
309 $ bitbake/lib/toaster/manage.py lsupdates 187 $ bitbake/lib/toaster/manage.py lsupdates
310 </literallayout> 188 </literallayout>
311 If Toaster can reach the API URL, you should see a message 189 If Toaster can reach the API URL, you should see a message
312 telling you that Toaster is updating the layer source 190 telling you that Toaster is updating the layer source information.
313 information.
314 </para>
315
316 <para>
317 Once the information has been updated, verify the new layer
318 information is available by using the Toaster web interface.
319 To do that, visit the "All compatible layers" page inside a
320 Toaster project.
321 The layers from your layer source should be listed there.
322 </para> 191 </para>
323 </section> 192 </section>
324 </section> 193 </section>
@@ -364,7 +233,7 @@
364 This release causes your Toaster projects to build 233 This release causes your Toaster projects to build
365 against the head of the &DISTRO_NAME_NO_CAP; branch at 234 against the head of the &DISTRO_NAME_NO_CAP; branch at
366 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/log/?h=rocko'></ulink> 235 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/log/?h=rocko'></ulink>
367 or <ulink url='http://git.openembedded.org/openembedded-core/commit/?h=rocko'></ulink>. 236 or <ulink url='http://git.openembedded.org/openembedded-core/commit/?h=rocko'></ulink>.
368 </para></listitem> 237 </para></listitem>
369 <listitem><para><emphasis>Yocto Project "Master" or OpenEmbedded "Master":</emphasis> 238 <listitem><para><emphasis>Yocto Project "Master" or OpenEmbedded "Master":</emphasis>
370 This release causes your Toaster Projects to 239 This release causes your Toaster Projects to