From: Richard Purdie <richard.purdie@linuxfoundation.org>
Date: Sat, 18 Jan 2014 14:22:41 +0000 (+0000)
Subject: user-manual-metadata: Add lists of common events
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=240d3f0439e7c1f12e06fa738acc20fbcac8ae65;p=thirdparty%2Fopenembedded%2Fopenembedded-core-contrib.git

user-manual-metadata: Add lists of common events

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---

diff --git a/doc/user-manual/user-manual-metadata.xml b/doc/user-manual/user-manual-metadata.xml
index c6b9005cd75..53f677e2f3e 100644
--- a/doc/user-manual/user-manual-metadata.xml
+++ b/doc/user-manual/user-manual-metadata.xml
@@ -562,6 +562,33 @@ python do_printdate () {
         <para>
             The above event handler prints the name of the event
             and the content of the <filename>FILE</filename> variable.
+            During a Build, the following common events occur:
+            <itemizedlist>
+                <listitem><para><filename>bb.event.ConfigParsed()</filename></para></listitem>
+                <listitem><para><filename>bb.event.ParseStarted()</filename></para></listitem>
+                <listitem><para><filename>bb.event.ParseProgress()</filename></para></listitem>
+                <listitem><para><filename>bb.event.ParseCompleted()</filename></para></listitem>
+                <listitem><para><filename>bb.event.BuildStarted()</filename></para></listitem>
+                <listitem><para><filename>bb.build.TaskStarted()</filename></para></listitem>
+                <listitem><para><filename>bb.build.TaskInvalid()</filename></para></listitem>
+                <listitem><para><filename>bb.build.TaskFailedSilent()</filename></para></listitem>
+                <listitem><para><filename>bb.build.TaskFailed()</filename></para></listitem>
+                <listitem><para><filename>bb.build.TaskSucceeded()</filename></para></listitem>
+                <listitem><para><filename>bb.event.BuildCompleted()</filename></para></listitem>
+                <listitem><para><filename>bb.cooker.CookerExit()</filename></para></listitem>
+            </itemizedlist>
+            Other events that occur based on specific requests to the server:
+            <itemizedlist>
+                <listitem><para><filename>bb.event.TreeDataPreparationStarted()</filename></para></listitem>
+                <listitem><para><filename>bb.event.TreeDataPreparationProgress</filename></para></listitem>
+                <listitem><para><filename>bb.event.TreeDataPreparationCompleted</filename></para></listitem>
+                <listitem><para><filename>bb.event.DepTreeGenerated</filename></para></listitem>
+                <listitem><para><filename>bb.event.CoreBaseFilesFound</filename></para></listitem>
+                <listitem><para><filename>bb.event.ConfigFilePathFound</filename></para></listitem>
+                <listitem><para><filename>bb.event.FilesMatchingFound</filename></para></listitem>
+                <listitem><para><filename>bb.event.ConfigFilesFound</filename></para></listitem>
+                <listitem><para><filename>bb.event.TargetsTreeGenerated</filename></para></listitem>
+            </itemizedlist>
         </para>
     </section>