summaryrefslogtreecommitdiffstats
path: root/documentation/toaster-manual/toaster-manual-reference.xml
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/toaster-manual/toaster-manual-reference.xml')
-rw-r--r--documentation/toaster-manual/toaster-manual-reference.xml40
1 files changed, 12 insertions, 28 deletions
diff --git a/documentation/toaster-manual/toaster-manual-reference.xml b/documentation/toaster-manual/toaster-manual-reference.xml
index faca4ca73a..715f2915c8 100644
--- a/documentation/toaster-manual/toaster-manual-reference.xml
+++ b/documentation/toaster-manual/toaster-manual-reference.xml
@@ -159,12 +159,15 @@
159 </para> 159 </para>
160 160
161 <para> 161 <para>
162 When you set up Toaster in Build Mode, you are prompted 162 The Toaster startup script in
163 to select a Toaster configuration file. 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.
164 This configuration file is used to set up the initial 167 This configuration file is used to set up the initial
165 configuration values within the Toaster database 168 configuration values within the Toaster database
166 including the layer sources. 169 including the layer sources.
167 Three versions of the configuration file exist: 170 Two versions of the configuration file exist:
168 <itemizedlist> 171 <itemizedlist>
169 <listitem><para> 172 <listitem><para>
170 The first version of the file is found in the 173 The first version of the file is found in the
@@ -192,14 +195,6 @@
192 (i.e. 195 (i.e.
193 <filename>git://git.openembedded.org/openembedded-core</filename>). 196 <filename>git://git.openembedded.org/openembedded-core</filename>).
194 </para></listitem> 197 </para></listitem>
195 <listitem><para>
196 The third version is a sample configuration
197 useful for when you want to set up a hosted
198 service in Build Mode.
199 You can find this version on the
200 <ulink url='https://wiki.yoctoproject.org/wiki/File:Toasterconf.json.txt.patch'>File:Toasterconf.json.txt.patch</ulink>
201 wiki page.
202 </para></listitem>
203 </itemizedlist> 198 </itemizedlist>
204 </para> 199 </para>
205 </section> 200 </section>
@@ -550,8 +545,7 @@
550 <title>JSON Files</title> 545 <title>JSON Files</title>
551 546
552 <para> 547 <para>
553 If you are going to be using Toaster in Build Mode, it must 548 You must configure Toaster before using it.
554 be initially configured before use.
555 Configuration customizes layer source settings and Toaster defaults 549 Configuration customizes layer source settings and Toaster defaults
556 for all users and is performed by the person responsible for 550 for all users and is performed by the person responsible for
557 Toaster Configuration (i.e the Toaster Administrator). 551 Toaster Configuration (i.e the Toaster Administrator).
@@ -577,17 +571,16 @@
577 <filename>toasterconf.json</filename>. 571 <filename>toasterconf.json</filename>.
578 The Toaster Administrator can customize the file prior to loading 572 The Toaster Administrator can customize the file prior to loading
579 it into Toaster. 573 it into Toaster.
580 When you set up Toaster locally to run in Build Mode, the system 574 The <filename>TOASTER_CONF</filename> variable in the
581 startup script actively looks for compatible configuration files 575 Toaster startup script at <filename>bitbake/bin/toaster</filename>
582 and prompts you to select a file to load if it detects that the 576 specifies the location of the <filename>toasterconf.json</filename> file.
583 database has not been configured.
584 </para> 577 </para>
585 578
586 <section id='json-file-choices'> 579 <section id='json-file-choices'>
587 <title>Configuration File Choices</title> 580 <title>Configuration File Choices</title>
588 581
589 <para> 582 <para>
590 Three versions of the configuration file exist: 583 Two versions of the configuration file exist:
591 <itemizedlist> 584 <itemizedlist>
592 <listitem><para> 585 <listitem><para>
593 The 586 The
@@ -613,15 +606,6 @@
613 <filename>openembedded-core</filename> repository (i.e. 606 <filename>openembedded-core</filename> repository (i.e.
614 <filename>git://git.openembedded.org/openembedded-core</filename>). 607 <filename>git://git.openembedded.org/openembedded-core</filename>).
615 </para></listitem> 608 </para></listitem>
616 <listitem><para>
617 The <filename>Toasterconf.json.txt.patch</filename>
618 located on the
619 <ulink url='https://wiki.yoctoproject.org/wiki/File:Toasterconf.json.txt.patch'>File:Toasterconf.json.txt.patch</ulink>
620 wiki page.
621 This version of the file is useful as a sample
622 configuration for when you want to set up Toaster as a
623 hosted service in Build Mode.
624 </para></listitem>
625 </itemizedlist> 609 </itemizedlist>
626 </para> 610 </para>
627 </section> 611 </section>
@@ -1008,7 +992,7 @@
1008 <literallayout class='monospaced'> 992 <literallayout class='monospaced'>
1009 $ bitbake/lib/toaster/manage.py checksettings 993 $ bitbake/lib/toaster/manage.py checksettings
1010 </literallayout> 994 </literallayout>
1011 In Build Mode, Toaster uses settings that are based on the 995 Toaster uses settings that are based on the
1012 database to configure the building tasks. 996 database to configure the building tasks.
1013 The <filename>checksettings</filename> command verifies that 997 The <filename>checksettings</filename> command verifies that
1014 the database settings are valid in the sense that they have 998 the database settings are valid in the sense that they have