Re: [PATCH] config doc: indent descriptions of feature.* variables

[Felipe Contreras <felipe.contreras@gmail.com>]

Ævar Arnfjörð Bjarmason wrote:
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -299,9 +299,8 @@ pathname::
>  	is expanded to the value of `$HOME`, and `~user/` to the
>  	specified user's home directory.
>  
> -
> -Variables
> -~~~~~~~~~
> +CONFIGURATION VARIABLES
> +-----------------------
>  
>  Note that this list is non-comprehensive and not necessarily complete.
>  For command-specific variables, you will find a more detailed description
> @@ -312,10 +311,24 @@ inventing new variables for use in your own tool, make sure their
>  names do not conflict with those that are used by Git itself and
>  other popular tools, and describe them in your documentation.
>  
> +
> +advice.*
> +~~~~~~~~
> +
> +These variables control various optional help messages designed to aid
> +new users. All 'advice.*' variables default to 'true', and you can
> +tell Git that you do not need help by setting these to 'false':
> +
>  include::config/advice.txt[]
>  
> +core.*
> +~~~~~~
> +
>  include::config/core.txt[]
>  
> +add.*
> +~~~~~
> +
>  include::config/add.txt[]

This looks much better to me. +1

>  include::config/alias.txt[]
> diff --git a/Documentation/config/advice.txt b/Documentation/config/advice.txt
> index 8b2849ff7b3..35d6b0e20ff 100644
> --- a/Documentation/config/advice.txt
> +++ b/Documentation/config/advice.txt
> @@ -1,126 +1,119 @@
> -advice.*::
> -	These variables control various optional help messages designed to
> -	aid new users. All 'advice.*' variables default to 'true', and you
> -	can tell Git that you do not need help by setting these to 'false':
> -+
> ---

...

> ---
> +advice.*fetchShowForcedUpdates::
> +	Advice shown when linkgit:git-fetch[1] takes a long time
> +	to calculate forced updates after ref updates, or to warn
> +	that the check is disabled.
> +advice.pushUpdateRejected::
> +	Set this variable to 'false' if you want to disable
> +	'pushNonFFCurrent', 'pushNonFFMatching', 'pushAlreadyExists',
> +	'pushFetchFirst', 'pushNeedsForce', and 'pushRefNeedsUpdate'
> +	simultaneously.
> +advice.pushNonFFCurrent::
> +	Advice shown when linkgit:git-push[1] fails due to a
> +	non-fast-forward update to the current branch.
> +advice.pushNonFFMatching::
> +	Advice shown when you ran linkgit:git-push[1] and pushed
> +	'matching refs' explicitly (i.e. you used ':', or
> +	specified a refspec that isn't your current branch) and
> +	it resulted in a non-fast-forward error.
> +advice.pushAlreadyExists::
> +	Shown when linkgit:git-push[1] rejects an update that
> +	does not qualify for fast-forwarding (e.g., a tag.)
> +pushFetchFirst::

I presume this also has the 'advice.' prefix added (and so do the rest),
it was just an example patch.

Cheers.

-- 
Felipe Contreras