diff options
Diffstat (limited to 'bitbake/doc/user-manual/user-manual-metadata.xml')
-rw-r--r-- | bitbake/doc/user-manual/user-manual-metadata.xml | 63 |
1 files changed, 61 insertions, 2 deletions
diff --git a/bitbake/doc/user-manual/user-manual-metadata.xml b/bitbake/doc/user-manual/user-manual-metadata.xml index cabf25fb6f..9cd8bf0e68 100644 --- a/bitbake/doc/user-manual/user-manual-metadata.xml +++ b/bitbake/doc/user-manual/user-manual-metadata.xml | |||
@@ -819,6 +819,20 @@ | |||
819 | </para> | 819 | </para> |
820 | </section> | 820 | </section> |
821 | 821 | ||
822 | <section id='deleting-a-task'> | ||
823 | <title>Deleting a Task</title> | ||
824 | |||
825 | <para> | ||
826 | As well as being able to add tasks, tasks can also be deleted. | ||
827 | This is done simply with <filename>deltask</filename> command. | ||
828 | For example, to delete the example task used in the previous | ||
829 | sections, you would use: | ||
830 | <literallayout class='monospaced'> | ||
831 | deltask printdate | ||
832 | </literallayout> | ||
833 | </para> | ||
834 | </section> | ||
835 | |||
822 | <section id='passing-information-into-the-build-task-environment'> | 836 | <section id='passing-information-into-the-build-task-environment'> |
823 | <title>Passing Information Into the Build Task Environment</title> | 837 | <title>Passing Information Into the Build Task Environment</title> |
824 | 838 | ||
@@ -867,6 +881,28 @@ | |||
867 | </note></para></listitem> | 881 | </note></para></listitem> |
868 | </orderedlist> | 882 | </orderedlist> |
869 | </para> | 883 | </para> |
884 | |||
885 | <para> | ||
886 | Sometimes, its useful to be able to obtain information | ||
887 | from the original execution environment. | ||
888 | Bitbake saves a copy of the original environment into | ||
889 | a special variable named | ||
890 | <link linkend='var-BB_ORIGENV'><filename>BB_ORIGENV</filename></link>. | ||
891 | </para> | ||
892 | |||
893 | <para> | ||
894 | The <filename>BB_ORIGENV</filename> variable returns a datastore | ||
895 | object that can be queried using the standard datastore operators | ||
896 | such as <filename>getVar()</filename>. | ||
897 | The datastore object is useful, for example, to find the original | ||
898 | <filename>DISPLAY</filename> variable. | ||
899 | </para> | ||
900 | |||
901 | <para> | ||
902 | By default, BitBake cleans the environment to include only those | ||
903 | things exported or listed in its whitelist to ensure that the build | ||
904 | environment is reproducible and consistent. | ||
905 | </para> | ||
870 | </section> | 906 | </section> |
871 | </section> | 907 | </section> |
872 | 908 | ||
@@ -975,6 +1011,17 @@ | |||
975 | "<link linkend='inter-task-dependencies'>Inter-Task Dependencies</link>" | 1011 | "<link linkend='inter-task-dependencies'>Inter-Task Dependencies</link>" |
976 | section for more information. | 1012 | section for more information. |
977 | </para></listitem> | 1013 | </para></listitem> |
1014 | <listitem><para><emphasis>postfuncs:</emphasis> | ||
1015 | List of functions to call after the completion of the task. | ||
1016 | </para></listitem> | ||
1017 | <listitem><para><emphasis>prefuncs:</emphasis> | ||
1018 | List of functions to call before the task executes. | ||
1019 | </para></listitem> | ||
1020 | <listitem><para><emphasis>stamp-extra-info:</emphasis> | ||
1021 | Extra stamp information to append to the task's stamp | ||
1022 | As an example, OpenEmbedded uses this flag to allow | ||
1023 | machine-specific tasks. | ||
1024 | </para></listitem> | ||
978 | </itemizedlist> | 1025 | </itemizedlist> |
979 | </para> | 1026 | </para> |
980 | </section> | 1027 | </section> |
@@ -1016,7 +1063,7 @@ | |||
1016 | </para> | 1063 | </para> |
1017 | 1064 | ||
1018 | <para> | 1065 | <para> |
1019 | During all builds, the following common events occur: | 1066 | During a standard build, the following common events might occur: |
1020 | <itemizedlist> | 1067 | <itemizedlist> |
1021 | <listitem><para> | 1068 | <listitem><para> |
1022 | <filename>bb.event.ConfigParsed()</filename> | 1069 | <filename>bb.event.ConfigParsed()</filename> |
@@ -1100,7 +1147,19 @@ | |||
1100 | <link linkend='var-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></link> | 1147 | <link linkend='var-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></link> |
1101 | and | 1148 | and |
1102 | <link linkend='var-BBVERSIONS'><filename>BBVERSIONS</filename></link> | 1149 | <link linkend='var-BBVERSIONS'><filename>BBVERSIONS</filename></link> |
1103 | variables: | 1150 | variables. |
1151 | <note> | ||
1152 | The mechanism for this class extension is extremely | ||
1153 | specific to the implementation. | ||
1154 | Usually, the recipe's | ||
1155 | <link linkend='var-PROVIDES'><filename>PROVIDES</filename></link>, | ||
1156 | <link linkend='var-PN'><filename>PN</filename></link>, and | ||
1157 | <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link> | ||
1158 | variables would need to be modified by the extension class. | ||
1159 | For specific examples, see the OE-Core | ||
1160 | <filename>native</filename>, <filename>nativesdk</filename>, | ||
1161 | and <filename>multilib</filename> classes. | ||
1162 | </note> | ||
1104 | <itemizedlist> | 1163 | <itemizedlist> |
1105 | <listitem><para><emphasis><filename>BBCLASSEXTEND</filename>:</emphasis> | 1164 | <listitem><para><emphasis><filename>BBCLASSEXTEND</filename>:</emphasis> |
1106 | This variable is a space separated list of classes used to "extend" the | 1165 | This variable is a space separated list of classes used to "extend" the |