Skip to content

Commit 5e62cc1

Browse files
artagnongitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent c0add30 commit 5e62cc1

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

Documentation/config.txt

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -930,26 +930,40 @@ column.ui::
930930
This variable consists of a list of tokens separated by spaces
931931
or commas:
932932
+
933+
These options control when the feature should be enabled
934+
(defaults to 'never'):
935+
+
933936
--
934937
`always`;;
935938
always show in columns
936939
`never`;;
937940
never show in columns
938941
`auto`;;
939942
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+
--
940950
`column`;;
941-
fill columns before rows (default)
951+
fill columns before rows
942952
`row`;;
943953
fill rows before columns
944954
`plain`;;
945955
show in one column
956+
--
957+
+
958+
Finally, these options can be combined with a layout option (defaults
959+
to 'nodense'):
960+
+
961+
--
946962
`dense`;;
947963
make unequal size columns to utilize more space
948964
`nodense`;;
949965
make equal size columns
950966
--
951-
+
952-
This option defaults to 'never'.
953967

954968
column.branch::
955969
Specify whether to output branch listing in `git branch` in columns.

0 commit comments

Comments
 (0)