Autogenerated HTML docs for v1.4.0-rc1-g99b41
authorJunio C Hamano <junio@hera.kernel.org>
Thu, 8 Jun 2006 00:48:17 +0000 (00:48 +0000)
committerJunio C Hamano <junio@hera.kernel.org>
Thu, 8 Jun 2006 00:48:17 +0000 (00:48 +0000)
config.txt
git-cvsserver.html
git-cvsserver.txt
git-ls-tree.html
git-ls-tree.txt
git-repo-config.html

index 570b691..a04c5ad 100644 (file)
@@ -2,15 +2,15 @@ CONFIGURATION FILE
 ------------------
 
 The git configuration file contains a number of variables that affect
-the git commands behavior. They can be used by both the git plumbing
-and the porcelains. The variables are divided to sections, where
+the git command's behavior. They can be used by both the git plumbing
+and the porcelains. The variables are divided into sections, where
 in the fully qualified variable name the variable itself is the last
 dot-separated segment and the section name is everything before the last
 dot. The variable names are case-insensitive and only alphanumeric
 characters are allowed. Some variables may appear multiple times.
 
 The syntax is fairly flexible and permissive; whitespaces are mostly
-ignored. The '#' and ';' characters begin commends to the end of line,
+ignored. The '#' and ';' characters begin comments to the end of line,
 blank lines are ignored, lines containing strings enclosed in square
 brackets start sections and all the other lines are recognized
 as setting variables, in the form 'name = value'. If there is no equal
@@ -35,8 +35,8 @@ Variables
 ~~~~~~~~~
 
 Note that this list is non-comprehensive and not necessarily complete.
-For command-specific variables, you will find more detailed description
-in the appropriate manual page. You will find description of non-core
+For command-specific variables, you will find more detailed description
+in the appropriate manual page. You will find description of non-core
 porcelain configuration variables in the respective porcelain documentation.
 
 core.fileMode::
@@ -52,10 +52,10 @@ core.gitProxy::
        on hostnames ending with the specified domain string. This variable
        may be set multiple times and is matched in the given order;
        the first match wins.
-
-       Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
-       (which always applies universally, without the special "for"
-       handling).
++
+Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
+(which always applies universally, without the special "for"
+handling).
 
 core.ignoreStat::
        The working copy files are assumed to stay unchanged until you
@@ -95,9 +95,10 @@ alias.*::
        Command aliases for the gitlink:git[1] command wrapper - e.g.
        after defining "alias.last = cat-file commit HEAD", the invocation
        "git last" is equivalent to "git cat-file commit HEAD". To avoid
-       confusion, aliases that hide existing git commands are ignored.
-       Arguments are split at whitespaces, but single or double
-       quote pair can be used to quote them.
+       confusion and troubles with script usage, aliases that
+       hide existing git commands are ignored. Arguments are split by
+       spaces, the usual shell quoting and escaping is supported.
+       quote pair and a backslash can be used to quote them.
 
 apply.whitespace::
        Tells `git-apply` how to handle whitespaces, in the same way
index 1069033..12a21c8 100644 (file)
@@ -299,45 +299,39 @@ over pserver for anonymous CVS access.</p>
 If you are going to offer anonymous CVS access via pserver, add a line in\r
    /etc/inetd.conf like\r
 </p>\r
-<div class="literalblock">\r
+<div class="listingblock">\r
 <div class="content">\r
-<pre><tt>cvspserver stream tcp nowait nobody git-cvsserver pserver</tt></pre>\r
+<pre><tt>   cvspserver stream tcp nowait nobody git-cvsserver pserver\r
+</tt></pre>\r
 </div></div>\r
-<div class="literalblock">\r
+<p>Note: In some cases, you need to pass the <em>pserver</em> argument twice for\r
+git-cvsserver to see it. So the line would look like</p>\r
+<div class="listingblock">\r
 <div class="content">\r
-<pre><tt>Note: In some cases, you need to pass the 'pserver' argument twice for\r
-git-cvsserver to see it. So the line would look like</tt></pre>\r
+<pre><tt>   cvspserver stream tcp nowait nobody git-cvsserver pserver pserver\r
+</tt></pre>\r
 </div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>cvspserver stream tcp nowait nobody git-cvsserver pserver pserver</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>No special setup is needed for SSH access, other than having GIT tools\r
+<p>No special setup is needed for SSH access, other than having GIT tools\r
 in the PATH. If you have clients that do not accept the CVS_SERVER\r
-env variable, you can rename git-cvsserver to cvs.</tt></pre>\r
-</div></div>\r
+env variable, you can rename git-cvsserver to cvs.</p>\r
 </li>\r
 <li>\r
 <p>\r
 For each repo that you want accessible from CVS you need to edit config in\r
    the repo and add the following section.\r
 </p>\r
-<div class="literalblock">\r
+<div class="listingblock">\r
 <div class="content">\r
-<pre><tt>[gitcvs]\r
-     enabled=1\r
-     # optional for debugging\r
-     logfile=/path/to/logfile</tt></pre>\r
+<pre><tt>   [gitcvs]\r
+        enabled=1\r
+        # optional for debugging\r
+        logfile=/path/to/logfile\r
+</tt></pre>\r
 </div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>Note: you need to ensure each user that is going to invoke git-cvsserver has\r
+<p>Note: you need to ensure each user that is going to invoke git-cvsserver has\r
 write access to the log file and to the git repository. When offering anon\r
 access via pserver, this means that the nobody user should have write access\r
-to at least the sqlite database at the root of the repository.</tt></pre>\r
-</div></div>\r
+to at least the sqlite database at the root of the repository.</p>\r
 </li>\r
 <li>\r
 <p>\r
@@ -345,18 +339,12 @@ On the client machine you need to set the following variables.
    CVSROOT should be set as per normal, but the directory should point at the\r
    appropriate git repo. For example:\r
 </p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>For SSH access, CVS_SERVER should be set to git-cvsserver</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>Example:</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
+<p>For SSH access, CVS_SERVER should be set to git-cvsserver</p>\r
+<p>Example:</p>\r
+<div class="listingblock">\r
 <div class="content">\r
-<pre><tt>export CVSROOT=:ext:user@server:/var/git/project.git\r
-export CVS_SERVER=git-cvsserver</tt></pre>\r
+<pre><tt>     export CVSROOT=:ext:user@server:/var/git/project.git\r
+     export CVS_SERVER=git-cvsserver</tt></pre>\r
 </div></div>\r
 </li>\r
 <li>\r
@@ -370,9 +358,9 @@ For SSH clients that will make commits, make sure their .bashrc file
 Clients should now be able to check out the project. Use the CVS <em>module</em>\r
    name to indicate what GIT <em>head</em> you want to check out. Example:\r
 </p>\r
-<div class="literalblock">\r
+<div class="listingblock">\r
 <div class="content">\r
-<pre><tt>cvs co -d project-master master</tt></pre>\r
+<pre><tt>     cvs co -d project-master master</tt></pre>\r
 </div></div>\r
 </li>\r
 </ol>\r
@@ -454,7 +442,7 @@ No keyword expansion or newline munging is supported.</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 04-Jun-2006 07:24:23 UTC\r
+Last updated 08-Jun-2006 00:48:14 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 952635d..e328db3 100644 (file)
@@ -36,49 +36,62 @@ INSTALLATION
 
 1. If you are going to offer anonymous CVS access via pserver, add a line in
    /etc/inetd.conf like
-
++
+--
+------
    cvspserver stream tcp nowait nobody git-cvsserver pserver
 
-   Note: In some cases, you need to pass the 'pserver' argument twice for
-   git-cvsserver to see it. So the line would look like
+------
+Note: In some cases, you need to pass the 'pserver' argument twice for
+git-cvsserver to see it. So the line would look like
 
+------
    cvspserver stream tcp nowait nobody git-cvsserver pserver pserver
 
-   No special setup is needed for SSH access, other than having GIT tools
-   in the PATH. If you have clients that do not accept the CVS_SERVER
-   env variable, you can rename git-cvsserver to cvs.
-
+------
+No special setup is needed for SSH access, other than having GIT tools
+in the PATH. If you have clients that do not accept the CVS_SERVER
+env variable, you can rename git-cvsserver to cvs.
+--
 2. For each repo that you want accessible from CVS you need to edit config in
    the repo and add the following section.
-
++
+--
+------
    [gitcvs]
         enabled=1
         # optional for debugging
         logfile=/path/to/logfile
 
-   Note: you need to ensure each user that is going to invoke git-cvsserver has
-   write access to the log file and to the git repository. When offering anon
-   access via pserver, this means that the nobody user should have write access
-   to at least the sqlite database at the root of the repository.
-
+------
+Note: you need to ensure each user that is going to invoke git-cvsserver has
+write access to the log file and to the git repository. When offering anon
+access via pserver, this means that the nobody user should have write access
+to at least the sqlite database at the root of the repository.
+--
 3. On the client machine you need to set the following variables.
    CVSROOT should be set as per normal, but the directory should point at the
    appropriate git repo. For example:
++
+--
+For SSH access, CVS_SERVER should be set to git-cvsserver
 
-   For SSH access, CVS_SERVER should be set to git-cvsserver
-
-   Example:
+Example:
 
+------
      export CVSROOT=:ext:user@server:/var/git/project.git
      export CVS_SERVER=git-cvsserver
-
+------
+--
 4. For SSH clients that will make commits, make sure their .bashrc file
    sets the GIT_AUTHOR and GIT_COMMITTER variables.
 
 5. Clients should now be able to check out the project. Use the CVS 'module'
    name to indicate what GIT 'head' you want to check out. Example:
-
++
+------
      cvs co -d project-master master
+------
 
 Eclipse CVS Client Notes
 ------------------------
index caf41d2..e99a752 100644 (file)
@@ -355,7 +355,7 @@ arguments does not matter.</p>
 </dt>\r
 <dd>\r
 <p>\r
-        Instead of showing the path names relative the current working\r
+        Instead of showing the path names relative to the current working\r
         directory, show the full path names.\r
 </p>\r
 </dd>\r
@@ -397,7 +397,7 @@ another major rewrite by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 07-Jun-2006 19:51:30 UTC\r
+Last updated 08-Jun-2006 00:48:14 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 7e072b5..f283bac 100644 (file)
@@ -49,7 +49,7 @@ OPTIONS
        Non default number of digits can be specified with --abbrev=<n>.
 
 --full-name::
-       Instead of showing the path names relative the current working
+       Instead of showing the path names relative to the current working
        directory, show the full path names.
 
 paths::
index 2d69a87..e306688 100644 (file)
@@ -489,14 +489,14 @@ i.e. the one without a "for &#8230;" postfix, do something like this:</p>
 <h2>CONFIGURATION FILE</h2>\r
 <div class="sectionbody">\r
 <p>The git configuration file contains a number of variables that affect\r
-the git commands behavior. They can be used by both the git plumbing\r
-and the porcelains. The variables are divided to sections, where\r
+the git command's behavior. They can be used by both the git plumbing\r
+and the porcelains. The variables are divided into sections, where\r
 in the fully qualified variable name the variable itself is the last\r
 dot-separated segment and the section name is everything before the last\r
 dot. The variable names are case-insensitive and only alphanumeric\r
 characters are allowed. Some variables may appear multiple times.</p>\r
 <p>The syntax is fairly flexible and permissive; whitespaces are mostly\r
-ignored. The <em>#</em> and <em>;</em> characters begin commends to the end of line,\r
+ignored. The <em>#</em> and <em>;</em> characters begin comments to the end of line,\r
 blank lines are ignored, lines containing strings enclosed in square\r
 brackets start sections and all the other lines are recognized\r
 as setting variables, in the form <em>name = value</em>. If there is no equal\r
@@ -520,8 +520,8 @@ enclosed in double quotes; some variables may require special value format.</p>
 </div></div>\r
 <h3>Variables</h3>\r
 <p>Note that this list is non-comprehensive and not necessarily complete.\r
-For command-specific variables, you will find more detailed description\r
-in the appropriate manual page. You will find description of non-core\r
+For command-specific variables, you will find more detailed description\r
+in the appropriate manual page. You will find description of non-core\r
 porcelain configuration variables in the respective porcelain documentation.</p>\r
 <dl>\r
 <dt>\r
@@ -547,12 +547,9 @@ core.gitProxy
         may be set multiple times and is matched in the given order;\r
         the first match wins.\r
 </p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>Can be overridden by the 'GIT_PROXY_COMMAND' environment variable\r
+<p>Can be overridden by the <em>GIT_PROXY_COMMAND</em> environment variable\r
 (which always applies universally, without the special "for"\r
-handling).</tt></pre>\r
-</div></div>\r
+handling).</p>\r
 </dd>\r
 <dt>\r
 core.ignoreStat\r
@@ -626,9 +623,10 @@ alias.*
         Command aliases for the <a href="git.html">git(1)</a> command wrapper - e.g.\r
         after defining "alias.last = cat-file commit HEAD", the invocation\r
         "git last" is equivalent to "git cat-file commit HEAD". To avoid\r
-        confusion, aliases that hide existing git commands are ignored.\r
-        Arguments are split at whitespaces, but single or double\r
-        quote pair can be used to quote them.\r
+        confusion and troubles with script usage, aliases that\r
+        hide existing git commands are ignored. Arguments are split by\r
+        spaces, the usual shell quoting and escaping is supported.\r
+        quote pair and a backslash can be used to quote them.\r
 </p>\r
 </dd>\r
 <dt>\r
@@ -856,7 +854,7 @@ imap
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 07-Jun-2006 19:51:31 UTC\r
+Last updated 08-Jun-2006 00:48:14 UTC\r
 </div>\r
 </div>\r
 </body>\r