minor: Make log message when Scene.IncomingChildAgentDateUpdate() more explicit that there is a problem if it still finds the agent to be a child if the sender wanted to wait till it became root

Add some comments about the mssage sequence, though much more data is at
http://opensimulator.org/wiki/Teleports

1 files changed, 4 insertions, 1 deletions

diff --git a/OpenSim/Region/Framework/Scenes/ScenePresence.cs b/OpenSim/Region/Framework/Scenes/ScenePresence.cs
index b4e8f09..d542e47 100644
--- a/OpenSim/Region/Framework/Scenes/ScenePresence.cs
+++ b/OpenSim/Region/Framework/Scenes/ScenePresence.cs
@@ -1354,7 +1354,10 @@ namespace OpenSim.Region.Framework.Scenes
 
         private bool WaitForUpdateAgent(IClientAPI client)
         {
-            // Before UpdateAgent, m_originRegionID is UUID.Zero; after, it's non-Zero
+            // Before the source region executes UpdateAgent
+            // (which triggers Scene.IncomingChildAgentDataUpdate(AgentData cAgentData) here in the destination, 
+            // m_originRegionID is UUID.Zero; after, it's non-Zero.  The CompleteMovement sequence initiated from the
+            // viewer (in turn triggered by the source region sending it a TeleportFinish event) waits until it's non-zero
             int count = 50;
             while (m_originRegionID.Equals(UUID.Zero) && count-- > 0)
             {