From 99308d64c6e0685f2862f39ca8f5e9e924cb77e6 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Wed, 26 Mar 2014 00:43:17 +0000
Subject: minor: Add some doc to Scene.Backup() detailing its direct invocation
 if the indepedent backup thread is not running (e.g. in a regression test)

---
 OpenSim/Region/Framework/Scenes/Scene.cs | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'OpenSim/Region/Framework/Scenes/Scene.cs')

diff --git a/OpenSim/Region/Framework/Scenes/Scene.cs b/OpenSim/Region/Framework/Scenes/Scene.cs
index 726d8e2..19d4e84 100644
--- a/OpenSim/Region/Framework/Scenes/Scene.cs
+++ b/OpenSim/Region/Framework/Scenes/Scene.cs
@@ -1703,8 +1703,12 @@ namespace OpenSim.Region.Framework.Scenes
         }
         
         /// <summary>
-        /// Backup the scene.  This acts as the main method of the backup thread.
+        /// Backup the scene.
         /// </summary>
+        /// <remarks>
+        /// This acts as the main method of the backup thread.  In a regression test whether the backup thread is not
+        /// running independently this can be invoked directly.
+        /// </remarks>
         /// <param name="forced">
         /// If true, then any changes that have not yet been persisted are persisted.  If false,
         /// then the persistence decision is left to the backup code (in some situations, such as object persistence,
-- 
cgit v1.1