[svnbook commit] r1332 - in trunk/src/en: . book

sussman svnbook-dev at RED-BEAN.COM
Tue May 24 21:37:51 CDT 2005


Author: sussman
Date: Tue May 24 21:37:49 2005
New Revision: 1332

Modified:
   trunk/src/en/TODO
   trunk/src/en/book/ch02.xml
   trunk/src/en/book/ch07.xml
Log:
Re-org docs on how URLs are parsed.

* src/en/book/ch02.xml (Repository Access URLs):  shrink sidebar to
     just a table of URL schemes, with a link to new ch07 section.

* src/en/book/ch07.xml (URL Construction): new section;  absorb the
     text from the ch02 sidebar and also mention URL autoescaping.

* src/en/book/TODO:  remove TO-DO.


Modified: trunk/src/en/TODO
==============================================================================
--- trunk/src/en/TODO	(original)
+++ trunk/src/en/TODO	Tue May 24 21:37:49 2005
@@ -5,14 +5,6 @@
 NEEDED FOR 1.1 COMPLETION
 ============================================================================
 
-  * Chapter 2's "Repository URLs" sidebar should shrink back to
-    nothing but the schema-table, with a xref to a new Chapter 7
-    section.  The new chapter 7 section is all about repository URL
-    trivia: file://localhost/, how to name drive letters, and how URL
-    autoescaping works on whitespaces and i18n characters.  Should
-    also mention that svn+FOO:// allows users to define their own
-    schemas (xref to appropriate part of ch06).   [MIKE]
-
   * Chapter 5 section "Repository Cleanup" documents the
     pre-"transactionless reporter" (pre-1.1) state of affairs regarding stale
     repository transactions.

Modified: trunk/src/en/book/ch02.xml
==============================================================================
--- trunk/src/en/book/ch02.xml	(original)
+++ trunk/src/en/book/ch02.xml	Tue May 24 21:37:49 2005
@@ -379,47 +379,12 @@
             </tbody>
           </tgroup>
         </table>
- 
-        <para>For the most part, Subversion's URLs use the standard
-          syntax, allowing for server names and port numbers to be
-          specified as part of the URL.  Remember that the
-          <literal>file:</literal> access method is valid only for
-          local repositories—in fact, in
-          accordance with convention, the server name portion of the
-          URL is required to be either absent or
-          <literal>localhost</literal>:</para>
- 
-        <screen>
-$ svn checkout file:///path/to/repos
-…
-$ svn checkout file://localhost/path/to/repos
-…
-</screen>
-
-        <para>Also, users of the <literal>file:</literal> scheme on
-          Windows platforms will need to use an unofficially
-          <quote>standard</quote> syntax for accessing repositories
-          that are on the same machine, but on a different drive than
-          the client's current working drive.  Either of the two
-          following URL path syntaxes will work where
-          <literal>X</literal> is the drive on which the repository
-          resides:</para>
-
-        <screen>
-C:\> svn checkout file:///X:/path/to/repos
-…
-C:\> svn checkout "file:///X|/path/to/repos"
-…
-</screen>
- 
-        <para>In the second syntax, you need to quote the URL so that
-          the vertical bar character is not interpreted as a pipe.</para>
 
-        <para>Note that a URL uses ordinary slashes even though the native
-          (non-URL) form of a path on Windows uses backslashes.</para>
+        <para>For more information on how Subversion parses URLs, see
+        <xref linkend="svn-ch-7-sect-6"/>.</para>
 
       </sidebar>
-
+ 
       <para>Suppose you make changes to <filename>button.c</filename>.
         Since the <filename>.svn</filename> directory remembers the
         file's modification date and original contents, Subversion can

Modified: trunk/src/en/book/ch07.xml
==============================================================================
--- trunk/src/en/book/ch07.xml	(original)
+++ trunk/src/en/book/ch07.xml	Tue May 24 21:37:49 2005
@@ -2477,7 +2477,7 @@
   </sect1>
 
   <!-- ******************************************************************* -->
-  <!-- *** SECTION 5:  LOCALIZATION                                 *** -->
+  <!-- *** SECTION 5:  LOCALIZATION                                    *** -->
   <!-- ******************************************************************* -->
   <sect1 id="svn-ch-7-sect-5">
     <title>Localization</title>
@@ -2554,7 +2554,7 @@
 $ svn help cat
 cat: Ausgabe des Inhaltes der angegebenen Dateien oder URLs
 Aufruf: cat ZIEL...
-[...]
+…
 </screen>
 
       <para>This behavior works identically on both Unix and Windows
@@ -2635,6 +2635,82 @@
 
   </sect1>
 
+  <!-- ******************************************************************* -->
+  <!-- *** SECTION 6:  URL Construction                                *** -->
+  <!-- ******************************************************************* -->
+  <sect1 id="svn-ch-7-sect-6">
+    <title>URL Construction</title>
+
+    <para>In Chapter 2, you saw a table that listed the different URL
+      schemes available to a Subversion client.  That wasn't the
+      entire story.  Complex setups or server locations sometimes
+      demand more complex URLs.  Here we explain a few important
+      edge-cases in the way Subversion parses URLs.</para>
+
+    <para>For the most part, Subversion's URLs use the standard
+      syntax, allowing for server names and port numbers to be
+      specified as part of the URL:</para>
+
+    <screen>
+$ svn checkout http://svn.example.com:9834/repos
+…
+</screen>
+
+    <para>Remember that the <literal>file:</literal> access method is
+      valid only for local repositories—in fact, in accordance
+      with convention, the server name portion of the URL is required
+      to be either absent or <literal>localhost</literal>:</para>
+ 
+    <screen>
+$ svn checkout file:///path/to/repos
+…
+$ svn checkout file://localhost/path/to/repos
+…
+</screen>
+
+    <para>Also, users of the <literal>file:</literal> scheme on
+      Windows platforms will need to use an unofficially
+      <quote>standard</quote> syntax for accessing repositories
+      that are on the same machine, but on a different drive than
+      the client's current working drive.  Either of the two
+      following URL path syntaxes will work where
+      <literal>X</literal> is the drive on which the repository
+      resides:</para>
+
+    <screen>
+C:\> svn checkout file:///X:/path/to/repos
+…
+C:\> svn checkout "file:///X|/path/to/repos"
+…
+</screen>
+ 
+    <para>In the second syntax, you need to quote the URL so that the
+      vertical bar character is not interpreted as a pipe.  Also, note
+      that a URL uses ordinary slashes even though the native
+      (non-URL) form of a path on Windows uses backslashes.</para>
+    
+    <para>Finally, it should be noted that the Subverison client will
+      automatically encode URLs as necessary, just like a web browser
+      does.  For example, if a URL contains a space or upper-ASCII
+      character:</para>
+
+    <screen>
+$ svn checkout "http://host/path with space/project/españa"
+</screen>
+    
+    <para>…then Subversion will escape the unsafe characters
+      and behave as if you had typed:</para>
+
+    <screen>
+$ svn checkout http://host/path%20with%20space/project/espa%C3%B1a
+</screen>
+
+    <para>If the URL contains spaces, be sure to place it within quote
+      marks, so that your shell treats the whole thing as a single
+      argument to the <command>svn</command> program.</para>
+
+  </sect1>
+  
 </chapter>
 
 <!--



More information about the svnbook-dev mailing list