From 0af907d85a16ad4515a1d5e2df1123123155e4e1 Mon Sep 17 00:00:00 2001
From: Bill Traynor <wmat@alphatroop.com>
Date: Mon, 15 Apr 2013 21:14:30 -0400
Subject: 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>
---
 doc/user-manual/user-manual-metadata.xml | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/doc/user-manual/user-manual-metadata.xml b/doc/user-manual/user-manual-metadata.xml
index 99bbf4952..be6a9800f 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:
-- 
cgit 1.2.3-korg