diff options
| author | Ramkumar Ramachandra <artagnon@gmail.com> | 2013-06-25 21:24:36 +0530 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2013-06-26 08:51:43 -0700 |
| commit | 5e62cc14c36fa1d10a057ebe6fd2bba504422573 (patch) | |
| tree | 9d3b0dda0d98e167143cab6ad153c39242433e4e | |
| parent | c0add3073a5bd0e295cdaea76e5c9b7805f8a047 (diff) | |
| download | git-5e62cc14c36fa1d10a057ebe6fd2bba504422573.tar.gz | |
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>
| -rw-r--r-- | Documentation/config.txt | 20 |
1 files changed, 17 insertions, 3 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt index 6e53fc5074..0a7bd06a29 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -930,6 +930,9 @@ column.ui:: This variable consists of a list of tokens separated by spaces or commas: + +These options control when the feature should be enabled +(defaults to 'never'): ++ -- `always`;; always show in columns @@ -937,19 +940,30 @@ column.ui:: never show in columns `auto`;; 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`;; - 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. |