Re: [RFC] Git config file reader in Perl (WIP)

From: Johannes Schindelin <johannes.schindelin@gmx.de>
Date: Jan 20, 2007, 00:08 UTC
Message-ID: <Pine.LNX.4.63.0701200100530.12889@wbgn013.biozentrum.uni-wuerzburg.de>
In-Reply-To: <200701192344.11972.jnareb@gmail.com>

Hi,

On Fri, 19 Jan 2007, Jakub Narebski wrote:

> +Sections can be further divided into subsections.  To begin a subsection
> +put it name in double quotes, separated by space from the section name,

       ^ "its"

> +in the section header, like in example below
> +
> +	[section "subsection"]

I wonder if we should also mention the (case insensitive) alternative "[section.subsection]", to give a better idea to people why we actually check for "section.subsection" in the code.

> +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".
> +Variable names are case insensitive.

They cannot contain anything else than alphanumeric characters, in particular no whitespace.

>					 There can be more than one value
> +for a given variable; we say then that variable is multivalued.

Maybe give the example of "remote.<name>.fetch" to explain why? Or maybe not.

> +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 character escape codes, nor octal
> +char sequences are valid.

I did not even know about BS! Does it make sense to allow it, really?

> +Some variables may require special value format.

I think you can safely skip that; it should be evident that the format of the variables depends on the purpose.

Ciao, Dscho