column doc: rewrite documentation for column.ui

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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Ramkumar Ramachandra 2013-06-25 21:24:36 +05:30 committed by Junio C Hamano
parent c0add3073a
commit 5e62cc14c3

View File

@ -930,6 +930,9 @@ column.ui::
This variable consists of a list of tokens separated by spaces This variable consists of a list of tokens separated by spaces
or commas: or commas:
+ +
These options control when the feature should be enabled
(defaults to 'never'):
+
-- --
`always`;; `always`;;
always show in columns always show in columns
@ -937,19 +940,30 @@ column.ui::
never show in columns never show in columns
`auto`;; `auto`;;
show in columns if the output is to the terminal show in columns if the output is to the terminal
--
+
These options control layout (defaults to 'column'). Setting any
of these implies 'always' if none of 'always', 'never', or 'auto' are
specified.
+
--
`column`;; `column`;;
fill columns before rows (default) fill columns before rows
`row`;; `row`;;
fill rows before columns fill rows before columns
`plain`;; `plain`;;
show in one column show in one column
--
+
Finally, these options can be combined with a layout option (defaults
to 'nodense'):
+
--
`dense`;; `dense`;;
make unequal size columns to utilize more space make unequal size columns to utilize more space
`nodense`;; `nodense`;;
make equal size columns make equal size columns
-- --
+
This option defaults to 'never'.
column.branch:: column.branch::
Specify whether to output branch listing in `git branch` in columns. Specify whether to output branch listing in `git branch` in columns.