Rename command safe::setAutoPathSync to safe::setSyncMode. Add a section TYPICAL USE to doc/safe.n.

1 files changed, 6 insertions, 6 deletions

diff --git a/library/safe.tcl b/library/safe.tcl
index 5a5ddb5..9a701a4 100644
--- a/library/safe.tcl
+++ b/library/safe.tcl
@@ -345,7 +345,7 @@ proc ::safe::InterpCreate {
 #
 #    It is the caller's responsibility, if it supplies a non-empty value for
 #    access_path, to make the first directory in the path suitable for use as
-#    tcl_library, and (if ![setAutoPathSync]), to set the slave's ::auto_path.
+#    tcl_library, and (if ![setSyncMode]), to set the slave's ::auto_path.
 
 proc ::safe::InterpSetConfig {slave access_path staticsok nestedok deletehook autoPath withAutoPath} {
     global auto_path
@@ -418,9 +418,9 @@ proc ::safe::InterpSetConfig {slave access_path staticsok nestedok deletehook au
 
     # Set the slave auto_path to a tokenized raw_auto_path.
     # Silently ignore any directories that are not in the access path.
-    # If [setAutoPathSync], SyncAccessPath will overwrite this value with the
+    # If [setSyncMode], SyncAccessPath will overwrite this value with the
     # full access path.
-    # If ![setAutoPathSync], Safe Base code will not change this value.
+    # If ![setSyncMode], Safe Base code will not change this value.
     set tokens_auto_path {}
     foreach dir $raw_auto_path {
 	if {[dict exists $remap_access_path $dir]} {
@@ -1360,7 +1360,7 @@ proc ::safe::Setup {} {
 }
 
 # Accessor method for ::safe::AutoPathSync
-# Usage: ::safe::setAutoPathSync ?newValue?
+# Usage: ::safe::setSyncMode ?newValue?
 # Respond to changes by calling Setup again, preserving any
 # caller-defined logging.  This allows complete equivalence with
 # prior Safe Base behavior if AutoPathSync is true.
@@ -1373,7 +1373,7 @@ proc ::safe::Setup {} {
 # (The initialization of AutoPathSync at the end of this file is acceptable
 #  because Setup has not yet been called.)
 
-proc ::safe::setAutoPathSync {args} {
+proc ::safe::setSyncMode {args} {
     variable AutoPathSync
 
     if {[llength $args] == 0} {
@@ -1396,7 +1396,7 @@ proc ::safe::setAutoPathSync {args} {
             setLogCmd $TmpLog
         }
     } else {
-        set msg {wrong # args: should be "safe::setAutoPathSync ?newValue?"}
+        set msg {wrong # args: should be "safe::setSyncMode ?newValue?"}
         return -code error $msg
     }