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)

0.8.0.3
Justin Clark-Casey (justincc) 2014-03-26 00:43:17 +00:00
parent 6d1d58b654
commit 99308d64c6
1 changed files with 5 additions and 1 deletions

View File

@ -1703,8 +1703,12 @@ namespace OpenSim.Region.Framework.Scenes
} }
/// <summary> /// <summary>
/// Backup the scene. This acts as the main method of the backup thread. /// Backup the scene.
/// </summary> /// </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"> /// <param name="forced">
/// If true, then any changes that have not yet been persisted are persisted. If false, /// 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, /// then the persistence decision is left to the backup code (in some situations, such as object persistence,