[Swift-commit] r2267 - trunk/docs

[noreply at svn.ci.uchicago.edu]

Author: benc
Date: 2008-10-04 05:01:35 -0500 (Sat, 04 Oct 2008)
New Revision: 2267

Modified:
   trunk/docs/quickstartguide.xml
   trunk/docs/userguide.xml
Log:
remove most references to $SWIFT_HOME as it was incorrectly suggestive that such variable should habitually be set.

Modified: trunk/docs/quickstartguide.xml
===================================================================
--- trunk/docs/quickstartguide.xml	2008-10-03 21:58:45 UTC (rev 2266)
+++ trunk/docs/quickstartguide.xml	2008-10-04 10:01:35 UTC (rev 2267)
@@ -78,10 +78,8 @@
 				build instructions are available on the <ulink
 				url="http://www.ci.uchicago.edu/swift/downloads/index.php#nightly">Swift
 				downloads page</ulink>. Once built, the <filename
-				class="directory">dist/vdsk-<version></filename> directory
-				will contain a self-contained build which can be moved to a
-				desired location. For simplicity this directory will be called
-				<filename class="directory"><envar>$SWIFT_HOME</envar></filename>.
+				class="directory">dist/vdsk-svn</filename> directory
+				will contain a self-contained build which can be used in place or moved to a different location.
 				You should then proceed to the <link
 				linkend="configure">configuration section</link>.
 			
@@ -105,9 +103,7 @@
 			
 			This will create a <filename
 			class="directory">vdsk-<version></filename> directory
-			containing the build. For simplicity this directory will be refered
-			to as <filename
-			class="directory"><envar>$SWIFT_HOME</envar></filename>.
+			containing the build.
 		
 		</para>
 	</sect1>
@@ -120,13 +116,13 @@
 			This section describes configuration steps that need to be taken in
 			order to get Swift running. Since all command line tools provided
 			with Swift can be found in the <filename
-			class="directory"><envar>$SWIFT_HOME</envar>/bin</filename> directory, it may
+			class="directory">bin/</filename> directory of the Swift distribution, it may
 			be a good idea to add this directory to your <envar>PATH</envar>
 			environment variable:
 			
 <programlisting>
 <prompt>></prompt> <command>export</command> <envar>PATH</envar>=<filename
-class="directory"><envar>$SWIFT_HOME</envar>/bin</filename>:<envar>$PATH</envar>
+class="directory">/path/to/swift/bin</filename>:<envar>$PATH</envar>
 </programlisting>
 			
 			If you are installing Swift on a machine with access to a graphical
@@ -202,7 +198,8 @@
 				class="file">swift.properties</filename>) can be used to
 				customize certain configuration aspects of Swift. A shared
 				version of this file, <filename
-				class="file"><envar>$SWIFT_HOME</envar>/etc/swift.properties</filename>
+				class="file">etc/swift.properties</filename>
+				in the installation directory
 				can be used to provide installation-wide defaults. A per-user
 				properties file, <filename
 				class="file">~/.swift/swift.properties</filename> can be used for
@@ -235,7 +232,7 @@
 		<para>
 		
 			The Swift examples can be found in the <filename
-			class="directory"><SWIFT_HOME>/examples</filename> directory.
+			class="directory">examples</filename> directory in the Swift distribution.
 			The examples are written in the <ulink
 			url="http://www.ci.uchicago.edu/swift/guides/languagespec.php">SwiftScript
 			Language</ulink>, and have <filename class="file">.swift</filename> as

Modified: trunk/docs/userguide.xml
===================================================================
--- trunk/docs/userguide.xml	2008-10-03 21:58:45 UTC (rev 2266)
+++ trunk/docs/userguide.xml	2008-10-04 10:01:35 UTC (rev 2267)
@@ -1009,7 +1009,7 @@
 			Various aspects of the behavior of the Swift Engine can be
 			configured through properties. The Swift Engine recognizes a global,
 			per installation properties file which can found in <filename
-			class="file">$SWIFT_HOME/etc/swift.properties</filename> and a user
+			class="file">etc/swift.properties</filename> in the Swift installation directory and a user
 			properties file which can be created by each user in <filename
 			class="file">~/.swift/swift.properties</filename>. The Swift Engine
 			will first load the global properties file. It will then try to load
@@ -1048,7 +1048,9 @@
 							
 								Points to the Swift installation directory
 								(<filename
-								class="directory"><envar>$SWIFT_HOME</envar></filename>).
+								class="directory"><envar>$SWIFT_HOME</envar></filename>). In general, this should not be set
+as Swift can find its own installation directory, and incorrectly setting it
+may impair the correct functionality of Swift.
 							
 							</para>
 						</listitem>