From d1df6afab2117e3e3381d79c514fea7ba63fcc03 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 1 Apr 2015 14:45:56 -0700 Subject: toaster-manual: Applied final review edits. This should be it unless there are late coming comments. (From yocto-docs rev: cb32e3330a6fe2d26425f8765689749afcd989e9) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../toaster-manual/toaster-manual-reference.xml | 90 ++++++++-------- .../toaster-manual-setup-and-use.xml | 117 +++++++++++---------- documentation/toaster-manual/toaster-manual.xml | 4 +- 3 files changed, 113 insertions(+), 98 deletions(-) (limited to 'documentation') diff --git a/documentation/toaster-manual/toaster-manual-reference.xml b/documentation/toaster-manual/toaster-manual-reference.xml index 05184fa1eb..cc118643cd 100644 --- a/documentation/toaster-manual/toaster-manual-reference.xml +++ b/documentation/toaster-manual/toaster-manual-reference.xml @@ -12,19 +12,18 @@ This final chapter provides conceptual information on layer sources, releases, and JSON configuration files. Also provided is a quick look at some useful - manage.py commands. + manage.py commands that are Toaster-specific. Information on manage.py commands does exist across the Web and the information in this manual by no means - attempts to provide a command reference. - However, having relevant command useful for the Toaster context - is helpful. + attempts to provide a command comprehensive reference.
Layer Source - In general, a layer source is some source of existing layers. + In general, a "layer source" is a source of information about + existing layers. In particular, we are concerned with layers that you can use with the Yocto Project and Toaster. This chapter describes a particular type of layer source called @@ -145,7 +144,7 @@
- Select the <filename>toasterconf.json</filename> File + Select for Use the <filename>toasterconf.json</filename> File If you do not want to use the Administration @@ -155,8 +154,8 @@ - When you set up Toaster in Build Mode, you are prompted to - select a Toaster configuration file. + When you set up Toaster in Build Mode, you are prompted + to select a Toaster configuration file. This configuration file is used to set up the initial configuration values within the Toaster database including the layer sources. @@ -309,9 +308,8 @@ $ bitbake/lib/toaster/manage.py loadconf /home/scottrif/poky/meta-yocto/conf/toasterconf.json After entering this command, you need to update the - information from the layer index to populate the - Toaster database with the information from your layer - index. + Toaster database with the information coming from your + new layer source. To do that, you should run the "lsupdates" command from the directory that contains the Toaster database. @@ -329,7 +327,7 @@ information is available by using the Toaster web interface. To do that, visit the "All compatible layers" page inside a Toaster project. - The layers from your layer index should be listed there. + The layers from your layer source should be listed there.
@@ -340,6 +338,8 @@ Releases + When you create a Toaster project using the web interface, + you are asked to choose a "Release." In the context of Toaster, the term "Release" refers to a set of layers and a BitBake version the OpenEmbedded build system uses to build something. @@ -347,8 +347,6 @@ correspond to Yocto Project release branches. However, you can modify, delete, and create new releases according to your needs. - When you create a Toaster project using the web interface, - you are asked to choose a "Release." This section provides some background information on releases. @@ -461,7 +459,7 @@ This name is never exposed through Toaster. Git URL: - The URL giturl + The URL (giturl) for the BitBake Git repository cloned for Toaster projects. @@ -493,9 +491,6 @@ (defaultlayers) automatically added to the project configuration when a project is created. - You can download the recommended configuration - for this case from - . Layer Source Priorities A specification of @@ -522,9 +517,11 @@ To summarize what comprises a release, consider the following example from a Toaster JSON file. - The configuration names the release "master" and sets it to - use the master branch of the - openembedded-core layer. + The configuration names the release "master" and uses the + "master" branch provided by the layer source of type + "layerindex", which is called "OpenEmbedded", and sets + the openembedded-core layer as the one + to be added by default to any projects created in Toaster. The BitBake version used would be defined as shown earlier in the previous list: @@ -548,13 +545,13 @@ JSON Files - If you are going to be using the Toaster in Build Mode, it must + If you are going to be using Toaster in Build Mode, it must be initially configured before use. Configuration customizes layer source settings and Toaster defaults for all users and is performed by the person responsible for Toaster Configuration (i.e the Toaster Administrator). The Toaster Administrator performs this configuration through the - admin web interface. + Django administration interface. @@ -575,10 +572,10 @@ toasterconf.json. The Toaster Administrator can customize the file prior to loading it into Toaster. - In the Local Toaster Build Mode, the system startup script - actively looks for compatible configuration files and prompts - you to select a file to load if it detects that the database has - not been configured. + When you set up Toaster locally to run in Build Mode, the system + startup script actively looks for compatible configuration files + and prompts you to select a file to load if it detects that the + database has not been configured.
@@ -630,7 +627,7 @@ The toasterconf.json file consists of easily readable areas: configuration, layer sources, BitBake, - default, and releases. + default release, and releases.
@@ -760,8 +757,13 @@ This area of the JSON file defines the version of BitBake Toaster uses. - As shipped, Toaster is configured to recognize three + As shipped, Toaster is configured to recognize four versions of BitBake: master, dizzy, and HEAD. + + HEAD is a special option that builds whatever is + available on disk, without checking out any remote + Git repositories. + @@ -937,14 +939,16 @@ using the builddelete command. - For example, assuming default repository and build directory - names, the following two commands put you in the - Build Directory - and then return a list of the current builds, which would - be one in this case: + Here is an example that assumes default repository and build + directory names: - $ cd $HOME/poky/build + $ cd ~/poky/build $ python ../bitbake/lib/toaster/manage.py buildslist + + If your Toaster database had only one build, the above + buildslist command would return something + like the following: + 1: qemux86 poky core-image-minimal @@ -1000,7 +1004,7 @@ $ bitbake/lib/toaster/manage.py checksettings - In Managed Mode, Toaster uses settings that are based on the + In Build Mode, Toaster uses settings that are based on the database to configure the building tasks. The checksettings command verifies that the database settings are valid in the sense that they have @@ -1026,8 +1030,8 @@ <filename>loadconf</filename> - The loadconf command loads a Toaster - configuration file (JSON file). + The loadconf command loads an + existing Toaster configuration file (JSON file). You must run this on a new database that does not have any data. Running this command on an existing database that has data @@ -1037,8 +1041,8 @@ $ bitbake/lib/toaster/manage.py loadconf filepath The loadconf command configures a database - based on the supplied toasterconf.json - file. + based on the supplied existing + toasterconf.json file. For information on the toasterconf.json, see the "JSON Files" @@ -1050,7 +1054,7 @@ <filename>runbuilds</filename> - The runbuilds command launched + The runbuilds command launches scheduled builds. Access the command as follows: @@ -1061,8 +1065,8 @@ per schedule. The command returns after the builds start but before they complete. - The "toasterui" build recorded updates the database when the - builds complete. + The Toaster Logging Interface records and updates the database + when the builds complete.
diff --git a/documentation/toaster-manual/toaster-manual-setup-and-use.xml b/documentation/toaster-manual/toaster-manual-setup-and-use.xml index bed38508ff..2a32912e38 100644 --- a/documentation/toaster-manual/toaster-manual-setup-and-use.xml +++ b/documentation/toaster-manual/toaster-manual-setup-and-use.xml @@ -209,7 +209,7 @@ you install and set up a front-end web server. This server allows for load balancing and multi-threading over Toaster and - django WSGI. + django WSGI. Here is an example that uses Apache web server. $ apt-get install apache2 libapache2-mod-wsgi @@ -282,19 +282,41 @@ Enable Build Logging to the Common SQL Server for Each Build Directory you are Using: In the Build Directory, create the required - conf/toaster.conf file as - described in - BitBake Extra Options. - Briefly, for each Build Directory, you need to inherit - the - toaster - class by setting the following in your - local.conf configuration file: - + conf/toaster.conf file by doing + the following: + + The following statements are automatically added + to the toaster.conf file + when Toaster starts through the + toaster start command. + + + + Be sure that Toaster inherits the + toaster + class and it is enabled in Bitbake in order to + record target image package information: + INHERIT += "toaster" + + + + Enable build history in BitBake. + Build history is needed to record target image + package information: + INHERIT += "buildhistory" BUILDHISTORY_COMMIT = "1" - + + This last command is not strictly needed. + However, without it build history will not + properly work. + For information on build history, see the + "Maintaining Build Output Quality" + section in the Yocto Project Development + Manual. + + You also need to point to the database. You can do this by exporting the DATABASE_URL variable as follows: @@ -434,8 +456,7 @@ Toaster configuration file. Toaster configurations are stored in JSON files called - toasterconf.json and supports - several types. + toasterconf.json. For information on JSON files, see the "JSON Files" section. @@ -498,27 +519,6 @@ MANAGED="True" - Configure the Build Environment: - Configure the build environment by running the - following: - - bitbake/lib/toaster/manage.py checksettings - - For reference information on Toaster-specific - manage.py commands, see the - "Useful Commands" - section. - - Load a Configuration File: - Load a configuration file by running the following: - - bitbake/lib/toaster/manage.py loadconf path-to-toasterconf.json-file - - For reference information on Toaster-specific - manage.py commands, see the - "Useful Commands" - section. - Set Up Toaster for Normal Usage: You need to configure each build environment, layer sources, and BitBake versions. @@ -675,7 +675,7 @@ build artifacts, downloading sources, and running builds. All three directories need to be writable by - the "poky" user. + the user, which is "poky" in this example. The build artifacts directory needs to readable by the apache user. You also need free disk space in the range of @@ -688,33 +688,42 @@ Set Up the toasterconf.json File: - Download the toasterconf.json file - from the - File:Toasterconf.json.txt.patch - wiki page and edit it to suit your environment. + Download the hosted toasterconf.json file + from the Yocto Project wiki and edit it to suit your + environment. For information on the relevant sections of the file, see the "JSON Files" + section. + After editing the file, load it by running + the following: + + $ bitbake/lib/toaster/manage.py loadconf path-to-toasterconf.json-file + + For reference information on Toaster-specific + manage.py, see the + "Useful Commands" section. Check the Toaster Settings: - You can check the Toaster settings by running this - command: + Configure the build environment by running the + following: $ bitbake/lib/toaster/manage.py checksettings When prompted, paste in the directory paths created - previously during Step 9. - Alternatively, you can select the edited - toasterconf.json file set up in - Step 5. + previously during Step 7. + For reference information on Toaster-specific + manage.py, see the + "Useful Commands" + section. Install and Set Up the Web Server: For a production environment, it is recommended that you install and set up a front-end web server. This server allows for load balancing and multi-threading over Toaster and - django WSGI. + django WSGI. Here is an example that uses Apache web server: $ apt-get install apache2 libapache2-mod-wsgi @@ -764,7 +773,7 @@ Start Toaster: - Synchronize the databases for toaster, and then start + Synchronize the databases for Toaster, and then start up the web server. Here is an example that continues with the assumed components from the previous steps: @@ -803,13 +812,13 @@ Open the Browser: Once the Apache server is running, connect to it with your favorite browser and verify that the Toaster - interface comes up. - You can track accesses and errors in the Apache - service logs: + interface comes up: http://localhost:8000/toastergui - You can now use the Toaster web interface. + You can now use the Toaster web interface to do thing + such as track accesses and errors in the Apache + service logs. @@ -823,8 +832,10 @@ The Toaster web interface allows you to do the following: - Browse all OpenEmbedded layers available for your - selected version of the build system + Browse published layers in the + OpenEmbedded Metadata Index + that are available for your selected version of the build + system. Import your own layers for building. diff --git a/documentation/toaster-manual/toaster-manual.xml b/documentation/toaster-manual/toaster-manual.xml index 7371ca2b8d..b53277fa69 100644 --- a/documentation/toaster-manual/toaster-manual.xml +++ b/documentation/toaster-manual/toaster-manual.xml @@ -33,7 +33,7 @@ 1.8 - Sometime in 2015 + October 2015 Released with the Yocto Project 1.8 Release. @@ -51,7 +51,7 @@ For the latest version of this manual associated with this Yocto Project release, see the - Toaster User Manual + Toaster User Manual from the Yocto Project website. -- cgit v1.2.3-54-g00ecf