diff options
Diffstat (limited to 'documentation/toaster-manual/toaster-manual-reference.xml')
-rw-r--r-- | documentation/toaster-manual/toaster-manual-reference.xml | 90 |
1 files changed, 47 insertions, 43 deletions
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 @@ | |||
12 | This final chapter provides conceptual information on layer sources, | 12 | This final chapter provides conceptual information on layer sources, |
13 | releases, and JSON configuration files. | 13 | releases, and JSON configuration files. |
14 | Also provided is a quick look at some useful | 14 | Also provided is a quick look at some useful |
15 | <filename>manage.py</filename> commands. | 15 | <filename>manage.py</filename> commands that are Toaster-specific. |
16 | Information on <filename>manage.py</filename> commands does exist | 16 | Information on <filename>manage.py</filename> commands does exist |
17 | across the Web and the information in this manual by no means | 17 | across the Web and the information in this manual by no means |
18 | attempts to provide a command reference. | 18 | attempts to provide a command comprehensive reference. |
19 | However, having relevant command useful for the Toaster context | ||
20 | is helpful. | ||
21 | </para> | 19 | </para> |
22 | 20 | ||
23 | <section id='layer-source'> | 21 | <section id='layer-source'> |
24 | <title>Layer Source</title> | 22 | <title>Layer Source</title> |
25 | 23 | ||
26 | <para> | 24 | <para> |
27 | In general, a layer source is some source of existing layers. | 25 | In general, a "layer source" is a source of information about |
26 | existing layers. | ||
28 | In particular, we are concerned with layers that you can use | 27 | In particular, we are concerned with layers that you can use |
29 | with the Yocto Project and Toaster. | 28 | with the Yocto Project and Toaster. |
30 | This chapter describes a particular type of layer source called | 29 | This chapter describes a particular type of layer source called |
@@ -145,7 +144,7 @@ | |||
145 | </section> | 144 | </section> |
146 | 145 | ||
147 | <section id='select-the-toasterconf-json-file'> | 146 | <section id='select-the-toasterconf-json-file'> |
148 | <title>Select the <filename>toasterconf.json</filename> File</title> | 147 | <title>Select for Use the <filename>toasterconf.json</filename> File</title> |
149 | 148 | ||
150 | <para> | 149 | <para> |
151 | If you do not want to use the Administration | 150 | If you do not want to use the Administration |
@@ -155,8 +154,8 @@ | |||
155 | </para> | 154 | </para> |
156 | 155 | ||
157 | <para> | 156 | <para> |
158 | When you set up Toaster in Build Mode, you are prompted to | 157 | When you set up Toaster in Build Mode, you are prompted |
159 | select a Toaster configuration file. | 158 | to select a Toaster configuration file. |
160 | This configuration file is used to set up the initial | 159 | This configuration file is used to set up the initial |
161 | configuration values within the Toaster database | 160 | configuration values within the Toaster database |
162 | including the layer sources. | 161 | including the layer sources. |
@@ -309,9 +308,8 @@ | |||
309 | $ bitbake/lib/toaster/manage.py loadconf /home/scottrif/poky/meta-yocto/conf/toasterconf.json | 308 | $ bitbake/lib/toaster/manage.py loadconf /home/scottrif/poky/meta-yocto/conf/toasterconf.json |
310 | </literallayout> | 309 | </literallayout> |
311 | After entering this command, you need to update the | 310 | After entering this command, you need to update the |
312 | information from the layer index to populate the | 311 | Toaster database with the information coming from your |
313 | Toaster database with the information from your layer | 312 | new layer source. |
314 | index. | ||
315 | To do that, you should run the | 313 | To do that, you should run the |
316 | "<filename>lsupdates</filename>" command from the directory | 314 | "<filename>lsupdates</filename>" command from the directory |
317 | that contains the Toaster database. | 315 | that contains the Toaster database. |
@@ -329,7 +327,7 @@ | |||
329 | information is available by using the Toaster web interface. | 327 | information is available by using the Toaster web interface. |
330 | To do that, visit the "All compatible layers" page inside a | 328 | To do that, visit the "All compatible layers" page inside a |
331 | Toaster project. | 329 | Toaster project. |
332 | The layers from your layer index should be listed there. | 330 | The layers from your layer source should be listed there. |
333 | </para> | 331 | </para> |
334 | </section> | 332 | </section> |
335 | </section> | 333 | </section> |
@@ -340,6 +338,8 @@ | |||
340 | <title>Releases</title> | 338 | <title>Releases</title> |
341 | 339 | ||
342 | <para> | 340 | <para> |
341 | When you create a Toaster project using the web interface, | ||
342 | you are asked to choose a "Release." | ||
343 | In the context of Toaster, the term "Release" refers to a set of | 343 | In the context of Toaster, the term "Release" refers to a set of |
344 | layers and a BitBake version the OpenEmbedded build system uses | 344 | layers and a BitBake version the OpenEmbedded build system uses |
345 | to build something. | 345 | to build something. |
@@ -347,8 +347,6 @@ | |||
347 | correspond to Yocto Project release branches. | 347 | correspond to Yocto Project release branches. |
348 | However, you can modify, delete, and create new releases | 348 | However, you can modify, delete, and create new releases |
349 | according to your needs. | 349 | according to your needs. |
350 | When you create a Toaster project using the web interface, | ||
351 | you are asked to choose a "Release." | ||
352 | This section provides some background information on releases. | 350 | This section provides some background information on releases. |
353 | </para> | 351 | </para> |
354 | 352 | ||
@@ -461,7 +459,7 @@ | |||
461 | This name is never exposed through Toaster. | 459 | This name is never exposed through Toaster. |
462 | </para></listitem> | 460 | </para></listitem> |
463 | <listitem><para><emphasis>Git URL:</emphasis> | 461 | <listitem><para><emphasis>Git URL:</emphasis> |
464 | The URL <filename>giturl</filename> | 462 | The URL (<filename>giturl</filename>) |
465 | for the BitBake Git repository cloned | 463 | for the BitBake Git repository cloned |
466 | for Toaster projects. | 464 | for Toaster projects. |
467 | </para></listitem> | 465 | </para></listitem> |
@@ -493,9 +491,6 @@ | |||
493 | (<filename>defaultlayers</filename>) automatically | 491 | (<filename>defaultlayers</filename>) automatically |
494 | added to the project configuration when a project is | 492 | added to the project configuration when a project is |
495 | created. | 493 | created. |
496 | You can download the recommended configuration | ||
497 | for this case from | ||
498 | <ulink url='&YOCTO_WIKI_URL;/wiki/File:Toasterconf.json.txt.patch'></ulink>. | ||
499 | </para></listitem> | 494 | </para></listitem> |
500 | <listitem><para><emphasis>Layer Source Priorities</emphasis> | 495 | <listitem><para><emphasis>Layer Source Priorities</emphasis> |
501 | A specification of | 496 | A specification of |
@@ -522,9 +517,11 @@ | |||
522 | <para> | 517 | <para> |
523 | To summarize what comprises a release, consider the following | 518 | To summarize what comprises a release, consider the following |
524 | example from a Toaster JSON file. | 519 | example from a Toaster JSON file. |
525 | The configuration names the release "master" and sets it to | 520 | The configuration names the release "master" and uses the |
526 | use the master branch of the | 521 | "master" branch provided by the layer source of type |
527 | <filename>openembedded-core</filename> layer. | 522 | "layerindex", which is called "OpenEmbedded", and sets |
523 | the <filename>openembedded-core</filename> layer as the one | ||
524 | to be added by default to any projects created in Toaster. | ||
528 | The BitBake version used would be defined as shown earlier | 525 | The BitBake version used would be defined as shown earlier |
529 | in the previous list: | 526 | in the previous list: |
530 | <literallayout class='monospaced'> | 527 | <literallayout class='monospaced'> |
@@ -548,13 +545,13 @@ | |||
548 | <title>JSON Files</title> | 545 | <title>JSON Files</title> |
549 | 546 | ||
550 | <para> | 547 | <para> |
551 | If you are going to be using the Toaster in Build Mode, it must | 548 | If you are going to be using Toaster in Build Mode, it must |
552 | be initially configured before use. | 549 | be initially configured before use. |
553 | Configuration customizes layer source settings and Toaster defaults | 550 | Configuration customizes layer source settings and Toaster defaults |
554 | for all users and is performed by the person responsible for | 551 | for all users and is performed by the person responsible for |
555 | Toaster Configuration (i.e the Toaster Administrator). | 552 | Toaster Configuration (i.e the Toaster Administrator). |
556 | The Toaster Administrator performs this configuration through the | 553 | The Toaster Administrator performs this configuration through the |
557 | admin web interface. | 554 | Django administration interface. |
558 | </para> | 555 | </para> |
559 | 556 | ||
560 | <para> | 557 | <para> |
@@ -575,10 +572,10 @@ | |||
575 | <filename>toasterconf.json</filename>. | 572 | <filename>toasterconf.json</filename>. |
576 | The Toaster Administrator can customize the file prior to loading | 573 | The Toaster Administrator can customize the file prior to loading |
577 | it into Toaster. | 574 | it into Toaster. |
578 | In the Local Toaster Build Mode, the system startup script | 575 | When you set up Toaster locally to run in Build Mode, the system |
579 | actively looks for compatible configuration files and prompts | 576 | startup script actively looks for compatible configuration files |
580 | you to select a file to load if it detects that the database has | 577 | and prompts you to select a file to load if it detects that the |
581 | not been configured. | 578 | database has not been configured. |
582 | </para> | 579 | </para> |
583 | 580 | ||
584 | <section id='json-file-choices'> | 581 | <section id='json-file-choices'> |
@@ -630,7 +627,7 @@ | |||
630 | <para> | 627 | <para> |
631 | The <filename>toasterconf.json</filename> file consists of | 628 | The <filename>toasterconf.json</filename> file consists of |
632 | easily readable areas: configuration, layer sources, BitBake, | 629 | easily readable areas: configuration, layer sources, BitBake, |
633 | default, and releases. | 630 | default release, and releases. |
634 | </para> | 631 | </para> |
635 | 632 | ||
636 | <section id='json-config-area'> | 633 | <section id='json-config-area'> |
@@ -760,8 +757,13 @@ | |||
760 | <para> | 757 | <para> |
761 | This area of the JSON file defines the version of | 758 | This area of the JSON file defines the version of |
762 | BitBake Toaster uses. | 759 | BitBake Toaster uses. |
763 | As shipped, Toaster is configured to recognize three | 760 | As shipped, Toaster is configured to recognize four |
764 | versions of BitBake: master, dizzy, and HEAD. | 761 | versions of BitBake: master, dizzy, and HEAD. |
762 | <note> | ||
763 | HEAD is a special option that builds whatever is | ||
764 | available on disk, without checking out any remote | ||
765 | Git repositories. | ||
766 | </note> | ||
765 | </para> | 767 | </para> |
766 | 768 | ||
767 | <para> | 769 | <para> |
@@ -937,14 +939,16 @@ | |||
937 | using the | 939 | using the |
938 | <link linkend='toaster-command-builddelete'><filename>builddelete</filename></link> | 940 | <link linkend='toaster-command-builddelete'><filename>builddelete</filename></link> |
939 | command. | 941 | command. |
940 | For example, assuming default repository and build directory | 942 | Here is an example that assumes default repository and build |
941 | names, the following two commands put you in the | 943 | directory names: |
942 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | ||
943 | and then return a list of the current builds, which would | ||
944 | be one in this case: | ||
945 | <literallayout class='monospaced'> | 944 | <literallayout class='monospaced'> |
946 | $ cd $HOME/poky/build | 945 | $ cd ~/poky/build |
947 | $ python ../bitbake/lib/toaster/manage.py buildslist | 946 | $ python ../bitbake/lib/toaster/manage.py buildslist |
947 | </literallayout> | ||
948 | If your Toaster database had only one build, the above | ||
949 | <filename>buildslist</filename> command would return something | ||
950 | like the following: | ||
951 | <literallayout class='monospaced'> | ||
948 | 1: qemux86 poky core-image-minimal | 952 | 1: qemux86 poky core-image-minimal |
949 | </literallayout> | 953 | </literallayout> |
950 | </para> | 954 | </para> |
@@ -1000,7 +1004,7 @@ | |||
1000 | <literallayout class='monospaced'> | 1004 | <literallayout class='monospaced'> |
1001 | $ bitbake/lib/toaster/manage.py checksettings | 1005 | $ bitbake/lib/toaster/manage.py checksettings |
1002 | </literallayout> | 1006 | </literallayout> |
1003 | In Managed Mode, Toaster uses settings that are based on the | 1007 | In Build Mode, Toaster uses settings that are based on the |
1004 | database to configure the building tasks. | 1008 | database to configure the building tasks. |
1005 | The <filename>checksettings</filename> command verifies that | 1009 | The <filename>checksettings</filename> command verifies that |
1006 | the database settings are valid in the sense that they have | 1010 | the database settings are valid in the sense that they have |
@@ -1026,8 +1030,8 @@ | |||
1026 | <title><filename>loadconf</filename></title> | 1030 | <title><filename>loadconf</filename></title> |
1027 | 1031 | ||
1028 | <para> | 1032 | <para> |
1029 | The <filename>loadconf</filename> command loads a Toaster | 1033 | The <filename>loadconf</filename> command loads an |
1030 | configuration file (JSON file). | 1034 | existing Toaster configuration file (JSON file). |
1031 | You must run this on a new database that does not have any | 1035 | You must run this on a new database that does not have any |
1032 | data. | 1036 | data. |
1033 | Running this command on an existing database that has data | 1037 | Running this command on an existing database that has data |
@@ -1037,8 +1041,8 @@ | |||
1037 | $ bitbake/lib/toaster/manage.py loadconf <replaceable>filepath</replaceable> | 1041 | $ bitbake/lib/toaster/manage.py loadconf <replaceable>filepath</replaceable> |
1038 | </literallayout> | 1042 | </literallayout> |
1039 | The <filename>loadconf</filename> command configures a database | 1043 | The <filename>loadconf</filename> command configures a database |
1040 | based on the supplied <filename>toasterconf.json</filename> | 1044 | based on the supplied existing |
1041 | file. | 1045 | <filename>toasterconf.json</filename> file. |
1042 | For information on the <filename>toasterconf.json</filename>, | 1046 | For information on the <filename>toasterconf.json</filename>, |
1043 | see the | 1047 | see the |
1044 | "<link linkend='toaster-json-files'>JSON Files</link>" | 1048 | "<link linkend='toaster-json-files'>JSON Files</link>" |
@@ -1050,7 +1054,7 @@ | |||
1050 | <title><filename>runbuilds</filename></title> | 1054 | <title><filename>runbuilds</filename></title> |
1051 | 1055 | ||
1052 | <para> | 1056 | <para> |
1053 | The <filename>runbuilds</filename> command launched | 1057 | The <filename>runbuilds</filename> command launches |
1054 | scheduled builds. | 1058 | scheduled builds. |
1055 | Access the command as follows: | 1059 | Access the command as follows: |
1056 | <literallayout class='monospaced'> | 1060 | <literallayout class='monospaced'> |
@@ -1061,8 +1065,8 @@ | |||
1061 | per schedule. | 1065 | per schedule. |
1062 | The command returns after the builds start but before they | 1066 | The command returns after the builds start but before they |
1063 | complete. | 1067 | complete. |
1064 | The "toasterui" build recorded updates the database when the | 1068 | The Toaster Logging Interface records and updates the database |
1065 | builds complete. | 1069 | when the builds complete. |
1066 | </para> | 1070 | </para> |
1067 | </section> | 1071 | </section> |
1068 | </section> | 1072 | </section> |