hgbook

diff en/ch06-collab.xml @ 580:8366882f67f2

Fix up more formatting goop
author Bryan O'Sullivan <bos@serpentine.com>
date Wed Mar 18 00:00:58 2009 -0700 (2009-03-18)
parents 80928ea6e7ae
children d0160b0b1a9e
line diff
     1.1 --- a/en/ch06-collab.xml	Tue Mar 17 21:47:12 2009 -0700
     1.2 +++ b/en/ch06-collab.xml	Wed Mar 18 00:00:58 2009 -0700
     1.3 @@ -592,7 +592,8 @@
     1.4  	<listitem><para>If you have a high tolerance for pain, you can
     1.5  	    use the Cygwin port of OpenSSH.</para>
     1.6  	</listitem></itemizedlist>
     1.7 -      <para>In either case, you'll need to edit your \hgini\ file to
     1.8 +      <para>In either case, you'll need to edit your <filename
     1.9 +      role="special">hg.ini</filename> file to
    1.10  	tell Mercurial where to find the actual client command.  For
    1.11  	example, if you're using PuTTY, you'll need to use the
    1.12  	<command>plink</command> command as a command-line ssh
    1.13 @@ -604,7 +605,7 @@
    1.14  	<para>  The path to <command>plink</command> shouldn't contain
    1.15  	  any whitespace characters, or Mercurial may not be able to
    1.16  	  run it correctly (so putting it in <filename
    1.17 -	    class="directory">C:\\Program Files</filename> is probably
    1.18 +	    class="directory">C:\Program Files</filename> is probably
    1.19  	  not a good idea).</para>
    1.20        </note>
    1.21  
    1.22 @@ -781,7 +782,9 @@
    1.23  	your server, the next step is to ensure that Mercurial runs on
    1.24  	the server.  The following command should run
    1.25  	successfully:</para>
    1.26 +
    1.27        <programlisting>ssh myserver hg version</programlisting>
    1.28 +
    1.29        <para>If you see an error message instead of normal <command
    1.30  	  role="hg-cmd">hg version</command> output, this is usually
    1.31  	because you haven't installed Mercurial to <filename
    1.32 @@ -838,7 +841,7 @@
    1.33        <para>Both <command>ssh</command> and <command>plink</command>
    1.34  	accept a <option role="cmd-opt-ssh">-C</option> option which
    1.35  	turns on compression.  You can easily edit your <filename
    1.36 -	  role="special"> /.hgrc</filename>\ to enable compression for
    1.37 +	  role="special">~/.hgrc</filename> to enable compression for
    1.38  	all of Mercurial's uses of the ssh protocol.</para>
    1.39        <programlisting>[ui]
    1.40  ssh = ssh -C</programlisting>
    1.41 @@ -925,8 +928,7 @@
    1.42  	directory, from which they can serve up web pages.  A file
    1.43  	named <filename>foo</filename> in this directory will be
    1.44  	accessible at a URL of the form
    1.45 -	<literal>http://www.example.com/\
    1.46 -	  {</literal>username/foo}.</para>
    1.47 +	<literal>http://www.example.com/username/foo</literal>.</para>
    1.48  
    1.49        <para>To get started, find the <filename
    1.50  	  role="special">hgweb.cgi</filename> script that should be
    1.51 @@ -1006,13 +1008,6 @@
    1.52  
    1.53  	&ch06-apache-config.lst;
    1.54  
    1.55 -	<programlisting>&lt;Directory /home/*/public_html&gt;
    1.56 -	  AllowOverride FileInfo AuthConfig Limit Options MultiViews
    1.57 -	  Indexes SymLinksIfOwnerMatch IncludesNoExec &lt;Limit GET
    1.58 -	  POST OPTIONS&gt; Order allow,deny Allow from all
    1.59 -	  &lt;/Limit&gt; &lt;LimitExcept GET POST OPTIONS&gt; Order
    1.60 -	  deny,allow Deny from all &lt;/LimitExcept&gt;
    1.61 -	  &lt;/Directory&gt;</programlisting>
    1.62  	<para>If you find a similar-looking
    1.63  	  <literal>Directory</literal> group in your Apache
    1.64  	  configuration, the directive to look at inside it is
    1.65 @@ -1078,8 +1073,8 @@
    1.66  	  <literal>mod_userdir</literal>, both of which were disabled
    1.67  	  by default on my system.  I then added a few lines to the
    1.68  	  end of the config file, to configure these modules.</para>
    1.69 -	<programlisting>userdir.path = "public_html" cgi.assign = (
    1.70 -	  ".cgi" =&gt; "" )</programlisting>
    1.71 +	<programlisting>userdir.path = "public_html"
    1.72 +cgi.assign = (".cgi" =&gt; "" )</programlisting>
    1.73  	<para>With this done, <literal>lighttpd</literal> ran
    1.74  	  immediately for me.  If I had configured
    1.75  	  <literal>lighttpd</literal> before Apache, I'd almost
    1.76 @@ -1114,8 +1109,8 @@
    1.77        <para>You'll need to copy this script into your <filename
    1.78  	  class="directory">public_html</filename> directory, and
    1.79  	ensure that it's executable.</para>
    1.80 -      <programlisting>cp .../hgwebdir.cgi ~/public_html chmod 755
    1.81 -	~/public_html ~/public_html/hgwebdir.cgi</programlisting>
    1.82 +      <programlisting>cp .../hgwebdir.cgi ~/public_html
    1.83 +chmod 755 ~/public_html ~/public_html/hgwebdir.cgi</programlisting>
    1.84        <para>With basic configuration out of the way, try to visit
    1.85  	<ulink url="http://myhostname/
    1.86  	  myuser/hgwebdir.cgi">http://myhostname/
    1.87 @@ -1141,8 +1136,8 @@
    1.88  	publish <emphasis>every</emphasis> repository under the
    1.89  	directories you name.  The section should look like
    1.90  	this:</para>
    1.91 -      <programlisting>[collections] /my/root =
    1.92 -	/my/root</programlisting>
    1.93 +      <programlisting>[collections]
    1.94 +/my/root = /my/root</programlisting>
    1.95        <para>Mercurial interprets this by looking at the directory name
    1.96  	on the <emphasis>right</emphasis> hand side of the
    1.97  	<quote><literal>=</literal></quote> sign; finding repositories
    1.98 @@ -1201,8 +1196,9 @@
    1.99  	  to publish a specific list of repositories.  To do so,
   1.100  	  create a <literal>paths</literal> section, with contents of
   1.101  	  the following form.</para>
   1.102 -	<programlisting>[paths] repo1 = /my/path/to/some/repo repo2 =
   1.103 -	  /some/path/to/another</programlisting>
   1.104 +	<programlisting>[paths]
   1.105 +repo1 = /my/path/to/some/repo
   1.106 +repo2 = /some/path/to/another</programlisting>
   1.107  	<para>In this case, the virtual path (the component that will
   1.108  	  appear in a URL) is on the left hand side of each
   1.109  	  definition, while the path to the repository is on the
   1.110 @@ -1236,7 +1232,7 @@
   1.111  	you'll need to add an <envar
   1.112  	  role="rc-item-web">allow_archive</envar> item to the
   1.113  	<literal role="rc-web">web</literal> section of your <filename
   1.114 -	  role="special"> /.hgrc</filename>.</para>
   1.115 +	  role="special">~/.hgrc</filename>.</para>
   1.116  
   1.117      </sect2>
   1.118      <sect2>
   1.119 @@ -1279,8 +1275,8 @@
   1.120  	    <envar role="rc-item-web">allow_archive</envar> entry at
   1.121  	    all, this feature will be disabled.  Here is an example of
   1.122  	    how to enable all three supported formats.</para>
   1.123 -	  <programlisting>[web] allow_archive = bz2 gz
   1.124 -	    zip</programlisting>
   1.125 +	  <programlisting>[web]
   1.126 +allow_archive = bz2 gz zip</programlisting>
   1.127  	</listitem>
   1.128  	<listitem><para><envar role="rc-item-web">allowpull</envar>:
   1.129  	    Boolean.  Determines whether the web interface allows
   1.130 @@ -1298,9 +1294,9 @@
   1.131  	    address of a person or mailing list.  It often makes sense
   1.132  	    to place this entry in a repository's own <filename
   1.133  	      role="special">.hg/hgrc</filename> file, but it can make
   1.134 -	    sense to use in a global <filename role="special">
   1.135 -	      /.hgrc</filename>\ if every repository has a single
   1.136 -	    maintainer.</para>
   1.137 +	    sense to use in a global <filename
   1.138 +	      role="special">~/.hgrc</filename> if every repository
   1.139 +	    has a single maintainer.</para>
   1.140  	</listitem>
   1.141  	<listitem><para><envar role="rc-item-web">maxchanges</envar>:
   1.142  	    Integer.  The default maximum number of changesets to
   1.143 @@ -1325,7 +1321,8 @@
   1.144  	    <xref linkend="chap:template"/> for details.
   1.145  	    Here, you can see how to enable the
   1.146  	    <literal>gitweb</literal> style.</para>
   1.147 -	  <programlisting>[web] style = gitweb</programlisting>
   1.148 +	  <programlisting>[web]
   1.149 +style = gitweb</programlisting>
   1.150  	</listitem>
   1.151  	<listitem><para><envar role="rc-item-web">templates</envar>:
   1.152  	    Path.  The directory in which to search for template
   1.153 @@ -1337,7 +1334,7 @@
   1.154  	configuration items in a <literal role="rc-web">web</literal>
   1.155  	section of the <filename
   1.156  	  role="special">hgweb.config</filename> file instead of a
   1.157 -	<filename role="special"> /.hgrc</filename>\ file, for
   1.158 +	<filename role="special">~/.hgrc</filename> file, for
   1.159  	convenience.  These items are <envar
   1.160  	  role="rc-item-web">motd</envar> and <envar
   1.161  	  role="rc-item-web">style</envar>.</para>
   1.162 @@ -1348,8 +1345,7 @@
   1.163  	<para>A few <literal role="rc-web">web</literal> configuration
   1.164  	  items ought to be placed in a repository's local <filename
   1.165  	    role="special">.hg/hgrc</filename>, rather than a user's
   1.166 -	  or global <filename role="special">
   1.167 -	    /.hgrc</filename>.</para>
   1.168 +	  or global <filename role="special">~/.hgrc</filename>.</para>
   1.169  	<itemizedlist>
   1.170  	  <listitem><para><envar
   1.171  		role="rc-item-web">description</envar>: String.  A
   1.172 @@ -1369,7 +1365,7 @@
   1.173  
   1.174  	<para>Some of the items in the <literal
   1.175  	    role="rc-web">web</literal> section of a <filename
   1.176 -	    role="special"> /.hgrc</filename>\ file are only for use
   1.177 +	    role="special">~/.hgrc</filename> file are only for use
   1.178  	  with the <command role="hg-cmd">hg serve</command>
   1.179  	  command.</para>
   1.180  	<itemizedlist>
   1.181 @@ -1403,8 +1399,8 @@
   1.182  
   1.183        </sect3>
   1.184        <sect3>
   1.185 -	<title>Choosing the right <filename role="special">
   1.186 -	    /.hgrc</filename>\ file to add <literal
   1.187 +	<title>Choosing the right <filename
   1.188 +	    role="special">~/.hgrc</filename> file to add <literal
   1.189  	    role="rc-web">web</literal> items to</title>
   1.190  
   1.191  	<para>It is important to remember that a web server like
   1.192 @@ -1415,16 +1411,15 @@
   1.193  	  under that user ID.</para>
   1.194  
   1.195  	<para>If you add <literal role="rc-web">web</literal> items to
   1.196 -	  your own personal <filename role="special">
   1.197 -	    /.hgrc</filename>\ file, CGI scripts won't read that
   1.198 -	  <filename role="special"> /.hgrc</filename>\ file.  Those
   1.199 +	  your own personal <filename role="special">~/.hgrc</filename> file, CGI scripts won't read that
   1.200 +	  <filename role="special">~/.hgrc</filename> file.  Those
   1.201  	  settings will thus only affect the behaviour of the <command
   1.202  	    role="hg-cmd">hg serve</command> command when you run it.
   1.203  	  To cause CGI scripts to see your settings, either create a
   1.204 -	  <filename role="special"> /.hgrc</filename>\ file in the
   1.205 +	  <filename role="special">~/.hgrc</filename> file in the
   1.206  	  home directory of the user ID that runs your web server, or
   1.207  	  add those settings to a system-wide <filename
   1.208 -	    role="special"> /.hgrc</filename>\ file.</para>
   1.209 +	    role="special">~/.hgrc</filename> file.</para>
   1.210  
   1.211  
   1.212        </sect3>