diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 7a5a375c0e..a4b1c824dc 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -5275,9 +5275,8 @@ This release of Toaster provides you with information about a BitBake run. The tool does not allow you to configure and launch a build. - Future development includes plans to integrate the data examination - features of Toaster with the configuration and build launching - capabilities of + However, future development includes plans to integrate the + configuration and build launching capabilities of Hob. For more information on using Hob to build an image, @@ -5294,14 +5293,19 @@ First, be sure you have met the following requirements: You have set up your - Source Directory. + Source Directory + by cloning the upstream poky + repository. See the Yocto Project Release item for information on how to set up the Source Directory. Be sure your build machine has Django - version 1.4 or greater installed. + version 1.4.5 or greater installed. + Make sure that port 8000 and 8200 are + free (i.e. they have no servers on them). + @@ -5309,12 +5313,30 @@ Once you have met the requirements, follow these steps to start Toaster running in the background of your shell: - Set up your build environment by sourcing - the oe-init-build-env script. + Set up your build environment: + Source a build environment script (i.e. + oe-init-build-env or + oe-init-build-env-memres). - Edit your local.conf - configuration file as needed. - Start the Toaster service using this + Prepare your local configuration file: + Toaster needs the Toaster class enabled + in Bitbake in order to record target image package + information. + You can enable it by adding the following line to your + conf/local.conf file: + + INHERIT += "toaster" + + Toaster also needs Build History enabled in Bitbake in + order to record target image package information. + You can enable this by adding the following two lines + to your conf/local.conf file: + + INHERIT += "buildhistory" + BUILDHISTORY_COMMIT = "1" + + Start Toaster: + Start the Toaster service using this command from within your build directory: $ source toaster start @@ -5334,12 +5356,15 @@ toaster.sqlite: Toaster's database file. - tstmain.log: - Toaster's log file. - tstmain.pid: - Contains the PID of the web server. - dsi.pid: - Contains the PID of th bridge. + toaster_web.log: + The log file of the web server. + toaster_ui.log: + The log file of the user interface component. + + toastermain.pid: + The PID of the web server. + toasterui.pid: + The PID of the DSI data bridge. bitbake-cookerdaemon.log: The BitBake server's log file.