aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBill Traynor <wmat@alphatroop.com>2013-04-15 21:14:30 -0400
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-13 22:00:27 +0000
commit0af907d85a16ad4515a1d5e2df1123123155e4e1 (patch)
treee60c3c8865d74927ba9c3109a3b814f95ea80d4a
parent3f1510d32bd7240216b7afa152f6e078d394e63e (diff)
downloadbitbake-0af907d85a16ad4515a1d5e2df1123123155e4e1.tar.gz
bitbake-0af907d85a16ad4515a1d5e2df1123123155e4e1.tar.bz2
bitbake-0af907d85a16ad4515a1d5e2df1123123155e4e1.zip
user-manual-metadata: Seeding the events section.
Added the list of events to the section in order to provide placeholders to be completed later. Signed-off-by: Bill Traynor <wmat@alphatroop.com>
-rw-r--r--doc/user-manual/user-manual-metadata.xml32
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/user-manual/user-manual-metadata.xml b/doc/user-manual/user-manual-metadata.xml
index 99bbf495..be6a9800 100644
--- a/doc/user-manual/user-manual-metadata.xml
+++ b/doc/user-manual/user-manual-metadata.xml
@@ -702,6 +702,37 @@ need to import them.</para>
<varname>FILE</varname>
variable.
</para>
+
+ <para>
+ During a Build, the following common events occur:
+
+bb.event.ConfigParsed()
+bb.event.ParseStarted()
+bb.event.ParseProgress()
+bb.event.ParseCompleted()
+bb.event.BuildStarted()
+bb.build.TaskStarted()
+bb.build.TaskInvalid()
+bb.build.TaskFailedSilent()
+bb.build.TaskFailed()
+bb.build.TaskSucceeded()
+bb.event.BuildCompleted()
+bb.cooker.CookerExit()
+</para>
+
+<para>
+There are also other events that occur based on specific requests to the server:
+
+bb.event.TreeDataPreparationStarted()
+bb.event.TreeDataPreparationProgress
+bb.event.TreeDataPreparationCompleted
+bb.event.DepTreeGenerated
+bb.event.CoreBaseFilesFound
+bb.event.ConfigFilePathFound
+bb.event.FilesMatchingFound
+bb.event.ConfigFilesFound
+bb.event.TargetsTreeGenerated
+</para>
</section>
<section>
@@ -852,6 +883,7 @@ need to import them.</para>
<para>
<emphasis>NOTE: This section is in draft.</emphasis>
+
It is often necessary to manipulate variables within python functions
and the Bitbake data store has an API which allows this.
The operations available are: