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>
Ramkumar Ramachandra committed
Jun 25, 2013 at 21:24 UTC
5e62cc14c36fa1d10a057ebe6fd2bba504422573
1 file changed
+17
-3
Documentation/config.txt
+17
-3
@@ -930,6 +930,9 @@ column.ui::
930
This variable consists of a list of tokens separated by spaces
931
or commas:
932
+
933
+These options control when the feature should be enabled
934
+(defaults to 'never'):
935
++
936
--
937
`always`;;
938
always show in columns
@@ -937,19 +940,30 @@ column.ui::
940
never show in columns
941
`auto`;;
942
show in columns if the output is to the terminal
943
+--
944
++
945
+These options control layout (defaults to 'column'). Setting any
946
+of these implies 'always' if none of 'always', 'never', or 'auto' are
947
+specified.
948
++
949
+--
950
`column`;;
941
- fill columns before rows (default)
951
+ fill columns before rows
952
`row`;;
953
fill rows before columns
954
`plain`;;
955
show in one column
956
+--
957
++
958
+Finally, these options can be combined with a layout option (defaults
959
+to 'nodense'):
960
++
961
+--
962
`dense`;;
963
make unequal size columns to utilize more space
964
`nodense`;;
965
make equal size columns
966
--
951
-+
952
-This option defaults to 'never'.
967
968
column.branch::
969
Specify whether to output branch listing in `git branch` in columns.