Autogenerated HTML docs for v1.5.0-rc2-gc9a89

diff --git a/config.txt b/config.txt
index f1f409d24b518a0e98865d94319735160bb9555b..77a2b164162aa6b55f41c74019d0527b8f47e590 100644 (file)
--- a/config.txt
+++ b/config.txt
@@ -14,14 +14,72 @@ 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.
 
+Syntax
+~~~~~~
+
 The syntax is fairly flexible and permissive; whitespaces are mostly
-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
-sign on the line, the entire line is taken as 'name' and the variable
-is recognized as boolean "true". String values may be entirely or partially
-enclosed in double quotes; some variables may require special value format.
+ignored.  The '#' and ';' characters begin comments to the end of line,
+blank lines are ignored.
+
+The file consists of sections and variables.  A section begins with
+the name of the section in square brackets and continues until the next
+section begins.  Section names are not case sensitive.  Only alphanumeric
+characters, '`-`' and '`.`' are allowed in section names.  Each variable
+must belong to some section, which means that there must be section
+header before first setting of a variable.
+
+Sections can be further divided into subsections.  To begin a subsection
+put its name in double quotes, separated by space from the section name,
+in the section header, like in example below:
+
+--------
+       [section "subsection"]
+
+--------
+
+Subsection names can contain any characters (doublequote '`"`', backslash
+'`\`' and newline have to be entered escaped as '`\"`', '`\\`' and '`\n`',
+respecitvely) and are case sensitive.  Section header cannot span multiple
+lines.  Variables may belong directly to a section or to a given subsection.
+You can have `[section]` if you have `[section "subsection"]`, but you
+don't need to.
+
+There is also (case insensitive) alternative `[section.subsection]` syntax.
+In this syntax subsection names follow the same restrictions as for section
+name.
+
+All the other lines are recognized as setting variables, in the form
+'name = value'.  If there is no equal sign on the line, the entire line
+is taken as 'name' and the variable is recognized as boolean "true".
+The variable names are case-insensitive and only alphanumeric
+characters and '`-`' are allowed.  There can be more than one value
+for a given variable; we say then that variable is multivalued.
+
+Leading and trailing whitespace in a variable value is discarded.
+Internal whitespace within a variable value is retained verbatim.
+
+The values following the equals sign in variable assign are all either
+a string, an integer, or a boolean.  Boolean values may be given as yes/no,
+0/1 or true/false.  Case is not significant in boolean values, when
+converting value to the canonical form using '--bool' type specifier;
+`git-repo-config` will ensure that the output is "true" or "false".
+
+String values may be entirely or partially enclosed in double quotes.
+You need to enclose variable value in double quotes if you want to
+preserve leading or trailing whitespace, or if variable value contains
+beginning of comment characters (if it contains '#' or ';').
+Double quote '`"`' and backslash '`\`' characters in variable value must
+be escaped: use '`\"`' for '`"`' and '`\\`' for '`\`'.
+
+The following escape sequences (beside '`\"`' and '`\\`') are recognized:
+'`\n`' for newline character (NL), '`\t`' for horizontal tabulation (HT, TAB)
+and '`\b`' for backspace (BS).  No other char escape sequence, nor octal
+char sequences are valid.
+
+Variable value ending in a '`\`' is continued on the next line in the
+customary UNIX fashion.
+
+Some variables may require special value format.
 
 Example
 ~~~~~~~
@@ -40,6 +98,10 @@ Example
                remote = origin
                merge = refs/heads/devel
 
+       # Proxy settings
+       [core]
+               gitProxy="ssh" for "ssh://kernel.org/"
+               gitProxy=default-proxy ; for the rest
 
 Variables
 ~~~~~~~~~

diff --git a/git-repo-config.html b/git-repo-config.html
index 58f8f4baff0b7240cbae9a83750bda9ab6351f81..57ffc56f5c10b80cd56d5759f4faa9155b6b69ae 100644 (file)
--- a/git-repo-config.html
+++ b/git-repo-config.html
@@ -572,14 +572,59 @@ in the fully qualified variable name the variable itself is the last
 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
+<h3>Syntax</h3>\r
 <p>The syntax is fairly flexible and permissive; whitespaces are mostly\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
-sign on the line, the entire line is taken as <em>name</em> and the variable\r
-is recognized as boolean "true". String values may be entirely or partially\r
-enclosed in double quotes; some variables may require special value format.</p>\r
+ignored.  The <em>#</em> and <em>;</em> characters begin comments to the end of line,\r
+blank lines are ignored.</p>\r
+<p>The file consists of sections and variables.  A section begins with\r
+the name of the section in square brackets and continues until the next\r
+section begins.  Section names are not case sensitive.  Only alphanumeric\r
+characters, <em><tt>-</tt></em> and <em><tt>.</tt></em> are allowed in section names.  Each variable\r
+must belong to some section, which means that there must be section\r
+header before first setting of a variable.</p>\r
+<p>Sections can be further divided into subsections.  To begin a subsection\r
+put its name in double quotes, separated by space from the section name,\r
+in the section header, like in example below:</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>        [section "subsection"]\r
+</tt></pre>\r
+</div></div>\r
+<p>Subsection names can contain any characters (doublequote <em><tt>"</tt></em>, backslash\r
+<em><tt>\</tt></em> and newline have to be entered escaped as <em><tt>\"</tt></em>, <em><tt>\\</tt></em> and <em><tt>\n</tt></em>,\r
+respecitvely) and are case sensitive.  Section header cannot span multiple\r
+lines.  Variables may belong directly to a section or to a given subsection.\r
+You can have <tt>[section]</tt> if you have <tt>[section "subsection"]</tt>, but you\r
+don't need to.</p>\r
+<p>There is also (case insensitive) alternative <tt>[section.subsection]</tt> syntax.\r
+In this syntax subsection names follow the same restrictions as for section\r
+name.</p>\r
+<p>All the other lines are recognized as setting variables, in the form\r
+<em>name = value</em>.  If there is no equal sign on the line, the entire line\r
+is taken as <em>name</em> and the variable is recognized as boolean "true".\r
+The variable names are case-insensitive and only alphanumeric\r
+characters and <em><tt>-</tt></em> are allowed.  There can be more than one value\r
+for a given variable; we say then that variable is multivalued.</p>\r
+<p>Leading and trailing whitespace in a variable value is discarded.\r
+Internal whitespace within a variable value is retained verbatim.</p>\r
+<p>The values following the equals sign in variable assign are all either\r
+a string, an integer, or a boolean.  Boolean values may be given as yes/no,\r
+0/1 or true/false.  Case is not significant in boolean values, when\r
+converting value to the canonical form using <em>--bool</em> type specifier;\r
+<tt>git-repo-config</tt> will ensure that the output is "true" or "false".</p>\r
+<p>String values may be entirely or partially enclosed in double quotes.\r
+You need to enclose variable value in double quotes if you want to\r
+preserve leading or trailing whitespace, or if variable value contains\r
+beginning of comment characters (if it contains <em>#</em> or <em>;</em>).\r
+Double quote <em><tt>"</tt></em> and backslash <em><tt>\</tt></em> characters in variable value must\r
+be escaped: use <em><tt>\"</tt></em> for <em><tt>"</tt></em> and <em><tt>\\</tt></em> for <em><tt>\</tt></em>.</p>\r
+<p>The following escape sequences (beside <em><tt>\"</tt></em> and <em><tt>\\</tt></em>) are recognized:\r
+<em><tt>\n</tt></em> for newline character (NL), <em><tt>\t</tt></em> for horizontal tabulation (HT, TAB)\r
+and <em><tt>\b</tt></em> for backspace (BS).  No other char escape sequence, nor octal\r
+char sequences are valid.</p>\r
+<p>Variable value ending in a <em><tt>\</tt></em> is continued on the next line in the\r
+customary UNIX fashion.</p>\r
+<p>Some variables may require special value format.</p>\r
 <h3>Example</h3>\r
 <div class="literalblock">\r
 <div class="content">\r
@@ -601,6 +646,13 @@ enclosed in double quotes; some variables may require special value format.</p>
         remote = origin\r
         merge = refs/heads/devel</tt></pre>\r
 </div></div>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt># Proxy settings\r
+[core]\r
+        gitProxy="ssh" for "ssh://kernel.org/"\r
+        gitProxy=default-proxy ; for the rest</tt></pre>\r
+</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 a more detailed description\r
@@ -1293,7 +1345,7 @@ receive.denyNonFastForwards
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 20-Jan-2007 02:22:39 UTC\r
+Last updated 23-Jan-2007 08:44:10 UTC\r
 </div>\r
 </div>\r
 </body>\r