[PATCH] column doc: rewrite documentation for column.ui

[PATCH] column doc: rewrite documentation for column.ui

[Ramkumar Ramachandra]

The configuration option column.ui is very poorly documented, and it is
unclear what the defaults are, and what option can be combined with
what.  Rewrite it by splitting up the options into three sections
clearly showing how COL_ENABLED, COL_LAYOUT_MASK, and COL_DENSE work.

Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
---
 Documentation/config.txt | 20 +++++++++++++++++---
 1 file changed, 17 insertions(+), 3 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 1153585..5a10169 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -934,6 +934,9 @@ column.ui::
 	This variable consists of a list of tokens separated by spaces
 	or commas:
 +
+These three options control when the feature should be enabled
+(defaults to 'never'):
++
 --
 `always`;;
 	always show in columns
@@ -941,19 +944,30 @@ column.ui::
 	never show in columns
 `auto`;;
 	show in columns if the output is to the terminal
+--
++
+These three options control layout (defaults to 'column').  Setting
+layout implies 'always' if none of 'always', 'never', or 'auto' are
+specified.
++
+--
 `column`;;
-	fill columns before rows (default)
+	fill columns before rows
 `row`;;
 	fill rows before columns
 `plain`;;
 	show in one column
+--
++
+Finally, these options can be combined with a layout option (defaults
+to 'nodense'):
++
+--
 `dense`;;
 	make unequal size columns to utilize more space
 `nodense`;;
 	make equal size columns
 --
-+
-This option defaults to 'never'.
 
 column.branch::
 	Specify whether to output branch listing in `git branch` in columns.
-- 
1.8.3.1.585.g9832cb9

Re: [PATCH] column doc: rewrite documentation for column.ui

[Junio C Hamano]

Ramkumar Ramachandra <artagnon@gmail.com> writes:

> The configuration option column.ui is very poorly documented, and it is
> unclear what the defaults are, and what option can be combined with
> what.  Rewrite it by splitting up the options into three sections
> clearly showing how COL_ENABLED, COL_LAYOUT_MASK, and COL_DENSE work.
>
> Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
> ---

Thanks.

One micronit (read: if you think the suggested change is a good
idea, I could just locally amend it) is that it would read better
and also easier to maintain to say

	These options control

without "three".  Both 'man' and 'html' output looked good.


>  Documentation/config.txt | 20 +++++++++++++++++---
>  1 file changed, 17 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index 1153585..5a10169 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -934,6 +934,9 @@ column.ui::
>  	This variable consists of a list of tokens separated by spaces
>  	or commas:
>  +
> +These three options control when the feature should be enabled
> +(defaults to 'never'):
> ++
>  --
>  `always`;;
>  	always show in columns
> @@ -941,19 +944,30 @@ column.ui::
>  	never show in columns
>  `auto`;;
>  	show in columns if the output is to the terminal
> +--
> ++
> +These three options control layout (defaults to 'column').  Setting
> +layout implies 'always' if none of 'always', 'never', or 'auto' are
> +specified.
> ++
> +--
>  `column`;;
> -	fill columns before rows (default)
> +	fill columns before rows
>  `row`;;
>  	fill rows before columns
>  `plain`;;
>  	show in one column
> +--
> ++
> +Finally, these options can be combined with a layout option (defaults
> +to 'nodense'):
> ++
> +--
>  `dense`;;
>  	make unequal size columns to utilize more space
>  `nodense`;;
>  	make equal size columns
>  --
> -+
> -This option defaults to 'never'.
>  
>  column.branch::
>  	Specify whether to output branch listing in `git branch` in columns.

Re: [PATCH] column doc: rewrite documentation for column.ui

[Ramkumar Ramachandra]

Junio C Hamano wrote:
> One micronit (read: if you think the suggested change is a good
> idea, I could just locally amend it) is that it would read better
> and also easier to maintain to say
>
>         These options control
>
> without "three".  Both 'man' and 'html' output looked good.

Sure, amend it.