summaryrefslogtreecommitdiffstats
path: root/documentation/toaster-manual
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/toaster-manual')
-rw-r--r--documentation/toaster-manual/figures/add-variable.pngbin0 -> 110712 bytes
-rw-r--r--documentation/toaster-manual/figures/bash-oecore.pngbin0 -> 138198 bytes
-rw-r--r--documentation/toaster-manual/figures/set-variable.pngbin0 -> 111430 bytes
-rw-r--r--documentation/toaster-manual/figures/variable-added.pngbin0 -> 112163 bytes
-rw-r--r--documentation/toaster-manual/toaster-manual-setup-and-use.xml157
5 files changed, 106 insertions, 51 deletions
diff --git a/documentation/toaster-manual/figures/add-variable.png b/documentation/toaster-manual/figures/add-variable.png
new file mode 100644
index 0000000000..6bdcca705a
--- /dev/null
+++ b/documentation/toaster-manual/figures/add-variable.png
Binary files differ
diff --git a/documentation/toaster-manual/figures/bash-oecore.png b/documentation/toaster-manual/figures/bash-oecore.png
new file mode 100644
index 0000000000..801a5d911f
--- /dev/null
+++ b/documentation/toaster-manual/figures/bash-oecore.png
Binary files differ
diff --git a/documentation/toaster-manual/figures/set-variable.png b/documentation/toaster-manual/figures/set-variable.png
new file mode 100644
index 0000000000..d36b52754e
--- /dev/null
+++ b/documentation/toaster-manual/figures/set-variable.png
Binary files differ
diff --git a/documentation/toaster-manual/figures/variable-added.png b/documentation/toaster-manual/figures/variable-added.png
new file mode 100644
index 0000000000..518f25fa15
--- /dev/null
+++ b/documentation/toaster-manual/figures/variable-added.png
Binary files differ
diff --git a/documentation/toaster-manual/toaster-manual-setup-and-use.xml b/documentation/toaster-manual/toaster-manual-setup-and-use.xml
index 869d2490ef..57a4343bc4 100644
--- a/documentation/toaster-manual/toaster-manual-setup-and-use.xml
+++ b/documentation/toaster-manual/toaster-manual-setup-and-use.xml
@@ -867,58 +867,113 @@
867 CPU usage, and disk I/O. 867 CPU usage, and disk I/O.
868 </para></listitem> 868 </para></listitem>
869 </itemizedlist> 869 </itemizedlist>
870 Following are several videos that show how to use the Toaster GUI:
871 <itemizedlist>
872 <listitem><para><emphasis>Build Configuration:</emphasis>
873 This
874 <ulink url='https://www.youtube.com/watch?v=qYgDZ8YzV6w'>video</ulink>
875 overviews and demonstrates build configuration for Toaster.
876 </para></listitem>
877 <listitem><para><emphasis>Toaster Homepage and Table Controls:</emphasis>
878 This
879 <ulink url='https://www.youtube.com/watch?v=QEARDnrR1Xw'>video</ulink>
880 goes over the Toaster entry page, and provides
881 an overview of the data manipulation capabilities of
882 Toaster, which include search, sorting and filtering by
883 different criteria.
884 </para></listitem>
885 <listitem><para><emphasis>Build Dashboard:</emphasis>
886 This
887 <ulink url='https://www.youtube.com/watch?v=KKqHYcnp2gE'>video</ulink>
888 shows you the build dashboard, a page providing an
889 overview of the information available for a selected build.
890 </para></listitem>
891 <listitem><para><emphasis>Image Information:</emphasis>
892 This
893 <ulink url='https://www.youtube.com/watch?v=XqYGFsmA0Rw'>video</ulink>
894 walks through the information Toaster provides
895 about images: packages installed and root file system.
896 </para></listitem>
897 <listitem><para><emphasis>Configuration:</emphasis>
898 This
899 <ulink url='https://www.youtube.com/watch?v=UW-j-T2TzIg'>video</ulink>
900 provides Toaster build configuration information.
901 </para></listitem>
902 <listitem><para><emphasis>Tasks:</emphasis>
903 This
904 <ulink url='https://www.youtube.com/watch?v=D4-9vGSxQtw'>video</ulink>
905 shows the information Toaster provides about the
906 tasks run by the build system.
907 </para></listitem>
908 <listitem><para><emphasis>Recipes and Packages Built:</emphasis>
909 This
910 <ulink url='https://www.youtube.com/watch?v=x-6dx4huNnw'>video</ulink>
911 shows the information Toaster provides about recipes
912 and packages built.
913 </para></listitem>
914 <listitem><para><emphasis>Performance Data:</emphasis>
915 This
916 <ulink url='https://www.youtube.com/watch?v=qWGMrJoqusQ'>video</ulink>
917 shows the build performance data provided by
918 Toaster.
919 </para></listitem>
920 </itemizedlist>
921 </para> 870 </para>
871
872 <section id='web-interface-videos'>
873 <title>Toaster Web Interface Videos</title>
874
875 <para>
876 Following are several videos that show how to use the Toaster GUI:
877 <itemizedlist>
878 <listitem><para><emphasis>Build Configuration:</emphasis>
879 This
880 <ulink url='https://www.youtube.com/watch?v=qYgDZ8YzV6w'>video</ulink>
881 overviews and demonstrates build configuration for Toaster.
882 </para></listitem>
883 <listitem><para><emphasis>Toaster Homepage and Table Controls:</emphasis>
884 This
885 <ulink url='https://www.youtube.com/watch?v=QEARDnrR1Xw'>video</ulink>
886 goes over the Toaster entry page, and provides
887 an overview of the data manipulation capabilities of
888 Toaster, which include search, sorting and filtering by
889 different criteria.
890 </para></listitem>
891 <listitem><para><emphasis>Build Dashboard:</emphasis>
892 This
893 <ulink url='https://www.youtube.com/watch?v=KKqHYcnp2gE'>video</ulink>
894 shows you the build dashboard, a page providing an
895 overview of the information available for a selected build.
896 </para></listitem>
897 <listitem><para><emphasis>Image Information:</emphasis>
898 This
899 <ulink url='https://www.youtube.com/watch?v=XqYGFsmA0Rw'>video</ulink>
900 walks through the information Toaster provides
901 about images: packages installed and root file system.
902 </para></listitem>
903 <listitem><para><emphasis>Configuration:</emphasis>
904 This
905 <ulink url='https://www.youtube.com/watch?v=UW-j-T2TzIg'>video</ulink>
906 provides Toaster build configuration information.
907 </para></listitem>
908 <listitem><para><emphasis>Tasks:</emphasis>
909 This
910 <ulink url='https://www.youtube.com/watch?v=D4-9vGSxQtw'>video</ulink>
911 shows the information Toaster provides about the
912 tasks run by the build system.
913 </para></listitem>
914 <listitem><para><emphasis>Recipes and Packages Built:</emphasis>
915 This
916 <ulink url='https://www.youtube.com/watch?v=x-6dx4huNnw'>video</ulink>
917 shows the information Toaster provides about recipes
918 and packages built.
919 </para></listitem>
920 <listitem><para><emphasis>Performance Data:</emphasis>
921 This
922 <ulink url='https://www.youtube.com/watch?v=qWGMrJoqusQ'>video</ulink>
923 shows the build performance data provided by
924 Toaster.
925 </para></listitem>
926 </itemizedlist>
927 </para>
928 </section>
929
930 <section id='toaster-web-interface-preferred-version'>
931 <title>Building a Specific Recipe Given Multiple Versions</title>
932
933 <para>
934 Occasionally, a layer might provide more than one version of
935 the same recipe.
936 For example, the <filename>openembedded-core</filename> layer
937 provides two versions of the <filename>bash</filename> recipe
938 (i.e. 3.2.48 and 4.3.30-r0) and two versions of the
939 <filename>which</filename> recipe (i.e. 2.21 and 2.18).
940 The following figure shows this exact scenario:
941 <imagedata fileref="figures/bash-oecore.png" align="center" width="9in" depth="6in" />
942 </para>
943
944 <para>
945 By default, the OpenEmbedded build system builds one of the
946 two recipes.
947 For the <filename>bash</filename> case, version 4.3.30-r0 is
948 built by default.
949 Unfortunately, Toaster as it exists, is not able to override
950 the default recipe version.
951 If you would like to build bash 3.2.48, you need to set the
952 <ulink url='&YOCTO_DOCS_REF_URL;#var-PREFERRED_VERSION'><filename>PREFERRED_VERSION</filename></ulink>
953 variable.
954 You can do so from Toaster, using the "Add variable" form,
955 which is available in the "BitBake variables" page of the
956 project configuration section as shown in the following screen:
957 <imagedata fileref="figures/add-variable.png" align="center" width="9in" depth="6in" />
958 </para>
959
960 <para>
961 To specify <filename>bash</filename> 3.2.48 as the version to build,
962 enter "PREFERRED_VERSION_bash" in the "Variable" field, and "3.2.48"
963 in the "Value" field.
964 Next, click the "Add variable" button:
965 <imagedata fileref="figures/set-variable.png" align="center" width="9in" depth="6in" />
966 </para>
967
968 <para>
969 After clicking the "Add variable" button, the settings for
970 <filename>PREFERRED_VERSION</filename> are added to the bottom
971 of the BitBake variables list.
972 With these settings, the OpenEmbedded build system builds the
973 desired version of the recipe rather than the default version:
974 <imagedata fileref="figures/variable-added.png" align="center" width="9in" depth="6in" />
975 </para>
976 </section>
922 </section> 977 </section>
923 978
924<!-- 979<!--
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-18 17:42:11 +0000