summaryrefslogtreecommitdiffstats
path: root/documentation/toaster-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2015-04-02 09:30:41 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-04-02 20:31:31 +0100
commitd691916ef8f1cb9ca71d9b4a9a97bb7de2cc8920 (patch)
tree912c986e1295349d1a2317babd166c97f75dbdef /documentation/toaster-manual
parent2f6a0659fe8417d6fefd31fd1e083265db55f57b (diff)
downloadpoky-d691916ef8f1cb9ca71d9b4a9a97bb7de2cc8920.tar.gz
toaster-manual: Review edits applied.
Some steps updated according to Belen and a video link fixed to not point to Belen's Youtube area. (From yocto-docs rev: 557c22fdd287160f6aabac0928ce6bd8d6af3394) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/toaster-manual')
-rw-r--r--documentation/toaster-manual/toaster-manual-reference.xml4
-rw-r--r--documentation/toaster-manual/toaster-manual-setup-and-use.xml79
2 files changed, 34 insertions, 49 deletions
diff --git a/documentation/toaster-manual/toaster-manual-reference.xml b/documentation/toaster-manual/toaster-manual-reference.xml
index cc118643cd..fede4529a2 100644
--- a/documentation/toaster-manual/toaster-manual-reference.xml
+++ b/documentation/toaster-manual/toaster-manual-reference.xml
@@ -144,7 +144,7 @@
144 </section> 144 </section>
145 145
146 <section id='select-the-toasterconf-json-file'> 146 <section id='select-the-toasterconf-json-file'>
147 <title>Select for Use the <filename>toasterconf.json</filename> File</title> 147 <title>Use the <filename>toasterconf.json</filename> File</title>
148 148
149 <para> 149 <para>
150 If you do not want to use the Administration 150 If you do not want to use the Administration
@@ -758,7 +758,7 @@
758 This area of the JSON file defines the version of 758 This area of the JSON file defines the version of
759 BitBake Toaster uses. 759 BitBake Toaster uses.
760 As shipped, Toaster is configured to recognize four 760 As shipped, Toaster is configured to recognize four
761 versions of BitBake: master, dizzy, and HEAD. 761 versions of BitBake: master, fido, dizzy, and HEAD.
762 <note> 762 <note>
763 HEAD is a special option that builds whatever is 763 HEAD is a special option that builds whatever is
764 available on disk, without checking out any remote 764 available on disk, without checking out any remote
diff --git a/documentation/toaster-manual/toaster-manual-setup-and-use.xml b/documentation/toaster-manual/toaster-manual-setup-and-use.xml
index 2a32912e38..a98e3945c6 100644
--- a/documentation/toaster-manual/toaster-manual-setup-and-use.xml
+++ b/documentation/toaster-manual/toaster-manual-setup-and-use.xml
@@ -281,48 +281,35 @@
281 section. 281 section.
282 </para></listitem> 282 </para></listitem>
283 <listitem><para><emphasis>Enable Build Logging to the Common SQL Server for Each Build Directory you are Using:</emphasis> 283 <listitem><para><emphasis>Enable Build Logging to the Common SQL Server for Each Build Directory you are Using:</emphasis>
284 In the Build Directory, create the required 284 You need to make sure that the
285 <filename>conf/toaster.conf</filename> file by doing 285 <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-toaster'><filename>toaster</filename></ulink>
286 the following: 286 class and build history are enabled.
287 <note> 287 This is done in a
288 The following statements are automatically added 288 <filename>toaster.conf</filename> file that is
289 to the <filename>toaster.conf</filename> file 289 created automatically by the toaster
290 when Toaster starts through the 290 <filename>start</filename> command,
291 <filename>toaster start</filename> command. 291 and that lives inside the
292 </note> 292 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
293 <itemizedlist> 293 in <filename>/conf/toaster.conf</filename>.</para>
294 <listitem><para> 294 <para>That file should include the following line:
295 Be sure that Toaster inherits the
296 <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-toaster'><filename>toaster</filename></ulink>
297 class and it is enabled in Bitbake in order to
298 record target image package information:
299 <literallayout class='monospaced'>
300 INHERIT += "toaster"
301 </literallayout>
302 </para></listitem>
303 <listitem><para>
304 Enable build history in BitBake.
305 Build history is needed to record target image
306 package information:
307 <literallayout class='monospaced'>
308 INHERIT += "buildhistory"
309 BUILDHISTORY_COMMIT = "1"
310 </literallayout>
311 This last command is not strictly needed.
312 However, without it build history will not
313 properly work.
314 For information on build history, see the
315 "<ulink url='&YOCTO_DOCS_REF_URL;#maintaining-build-output-quality'>Maintaining Build Output Quality</ulink>"
316 section in the Yocto Project Development
317 Manual.
318 </para></listitem>
319 </itemizedlist>
320 You also need to point to the database.
321 You can do this by exporting the
322 <filename>DATABASE_URL</filename> variable as follows:
323 <literallayout class='monospaced'> 295 <literallayout class='monospaced'>
324 export DATABASE_URL=mysql://<replaceable>newuser</replaceable>:<replaceable>password</replaceable>@192.168.0.25:3306/toaster 296 INHERIT += "toaster buildhistory"
325 </literallayout> 297 </literallayout>
298 For information on build history, see the
299 "<ulink url='&YOCTO_DOCS_REF_URL;#maintaining-build-output-quality'>Maintaining Build Output Quality</ulink>"
300 section in the Yocto Project Development
301 Manual.</para>
302 <para>You also need to point to the database that you set
303 up in step 3.
304 You can do this by exporting the <filename>DATABASE_URL</filename>
305 variable as follows:
306 <literallayout class='monospaced'>
307 export DATABASE_URL=mysql://newuser:password@192.168.0.25:3306/toaster
308 </literallayout>
309 This example assumes that you are using
310 <filename>mysql-server</filename>.
311 The IP address should be the IP address of your
312 database server.
326 </para></listitem> 313 </para></listitem>
327 <listitem><para><emphasis>Source your Build Environment Setup Script:</emphasis> 314 <listitem><para><emphasis>Source your Build Environment Setup Script:</emphasis>
328 From your 315 From your
@@ -572,7 +559,7 @@
572 # Save your changes and exit 559 # Save your changes and exit
573 560
574 # Go to Home, Bitbake Versions, Add bitbake version; 561 # Go to Home, Bitbake Versions, Add bitbake version;
575 # take version infor from : http://git.openembedded.org/bitbake/refs/heads, 562 # take version information from : http://git.openembedded.org/bitbake/refs/heads,
576 # this manual assumes the master version 563 # this manual assumes the master version
577 # set Name: master, Giturl git://git.openembedded.org/bitbake 564 # set Name: master, Giturl git://git.openembedded.org/bitbake
578 # branch master, dirpath / 565 # branch master, dirpath /
@@ -816,8 +803,7 @@
816 <literallayout class='monospaced'> 803 <literallayout class='monospaced'>
817 http://localhost:8000/toastergui 804 http://localhost:8000/toastergui
818 </literallayout> 805 </literallayout>
819 You can now use the Toaster web interface to do thing 806 You can track accesses and errors in the Apache
820 such as track accesses and errors in the Apache
821 service logs. 807 service logs.
822 </para></listitem> 808 </para></listitem>
823 </orderedlist> 809 </orderedlist>
@@ -885,7 +871,7 @@
885 <itemizedlist> 871 <itemizedlist>
886 <listitem><para><emphasis>New Toaster Functionality:</emphasis> 872 <listitem><para><emphasis>New Toaster Functionality:</emphasis>
887 This 873 This
888 <ulink url='https://www.youtube.com/watch?v=f3gDg75FwFo'>video</ulink> 874 <ulink url='https://www.youtube.com/watch?v=qYgDZ8YzV6w'>video</ulink>
889 introduces the new Toaster functionality for this release. 875 introduces the new Toaster functionality for this release.
890 </para></listitem> 876 </para></listitem>
891 <listitem><para><emphasis>Toaster Homepage and Table Controls:</emphasis> 877 <listitem><para><emphasis>Toaster Homepage and Table Controls:</emphasis>
@@ -911,8 +897,7 @@
911 <listitem><para><emphasis>Configuration:</emphasis> 897 <listitem><para><emphasis>Configuration:</emphasis>
912 This 898 This
913 <ulink url='https://www.youtube.com/watch?v=UW-j-T2TzIg'>video</ulink> 899 <ulink url='https://www.youtube.com/watch?v=UW-j-T2TzIg'>video</ulink>
914 shows the information Toaster provides about build 900 provides Toaster build configuration information.
915 configuration.
916 </para></listitem> 901 </para></listitem>
917 <listitem><para><emphasis>Tasks:</emphasis> 902 <listitem><para><emphasis>Tasks:</emphasis>
918 This 903 This
@@ -1019,7 +1004,7 @@
1019 <videoobject> 1004 <videoobject>
1020 <videodata width="640px" height="480px" fileref="http://www.youtube.com/v/x-6dx4huNnw"></videodata> 1005 <videodata width="640px" height="480px" fileref="http://www.youtube.com/v/x-6dx4huNnw"></videodata>
1021 </videoobject> 1006 </videoobject>
1022 </mediaobject> 1007 </mediaobject>qYgDZ8YzV6w
1023 </para> 1008 </para>
1024 </section> 1009 </section>
1025 <section id='toaster-gui-vids-7'> 1010 <section id='toaster-gui-vids-7'>