{"thread":{"id":"34274","subject":"[PATCH] column doc: rewrite documentation for column.ui","startedAt":"2013-06-25T15:54:36Z","lastAt":"2013-06-26T06:37:17Z","messageCount":3,"participants":["Ramkumar Ramachandra","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"221958","messageId":"1372175676-5423-1-git-send-email-artagnon@gmail.com","threadId":"34274","inReplyTo":null,"subject":"[PATCH] column doc: rewrite documentation for column.ui","fromName":"Ramkumar Ramachandra","fromEmail":"artagnon@gmail.com","sentAt":"2013-06-25T15:54:36Z","receivedAt":"2013-06-25T15:54:36Z","isPatch":true,"sender":{"key":"r@artagnon.com","avatar":"https://avatars.githubusercontent.com/u/37226?v=4"},"body":"The configuration option column.ui is very poorly documented, and it is\nunclear what the defaults are, and what option can be combined with\nwhat.  Rewrite it by splitting up the options into three sections\nclearly showing how COL_ENABLED, COL_LAYOUT_MASK, and COL_DENSE work.\n\nSigned-off-by: Ramkumar Ramachandra <artagnon@gmail.com>\n---\n Documentation/config.txt | 20 +++++++++++++++++---\n 1 file changed, 17 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/config.txt b/Documentation/config.txt\nindex 1153585..5a10169 100644\n--- a/Documentation/config.txt\n+++ b/Documentation/config.txt\n@@ -934,6 +934,9 @@ column.ui::\n \tThis variable consists of a list of tokens separated by spaces\n \tor commas:\n +\n+These three options control when the feature should be enabled\n+(defaults to 'never'):\n++\n --\n `always`;;\n \talways show in columns\n@@ -941,19 +944,30 @@ column.ui::\n \tnever show in columns\n `auto`;;\n \tshow in columns if the output is to the terminal\n+--\n++\n+These three options control layout (defaults to 'column').  Setting\n+layout implies 'always' if none of 'always', 'never', or 'auto' are\n+specified.\n++\n+--\n `column`;;\n-\tfill columns before rows (default)\n+\tfill columns before rows\n `row`;;\n \tfill rows before columns\n `plain`;;\n \tshow in one column\n+--\n++\n+Finally, these options can be combined with a layout option (defaults\n+to 'nodense'):\n++\n+--\n `dense`;;\n \tmake unequal size columns to utilize more space\n `nodense`;;\n \tmake equal size columns\n --\n-+\n-This option defaults to 'never'.\n \n column.branch::\n \tSpecify whether to output branch listing in `git branch` in columns.\n-- \n1.8.3.1.585.g9832cb9\n"},{"id":"221986","messageId":"7vobatzvfg.fsf@alter.siamese.dyndns.org","threadId":"34274","inReplyTo":"1372175676-5423-1-git-send-email-artagnon@gmail.com","subject":"Re: [PATCH] column doc: rewrite documentation for column.ui","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2013-06-25T22:18:11Z","receivedAt":"2013-06-25T22:18:11Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Ramkumar Ramachandra <artagnon@gmail.com> writes:\n\n> The configuration option column.ui is very poorly documented, and it is\n> unclear what the defaults are, and what option can be combined with\n> what.  Rewrite it by splitting up the options into three sections\n> clearly showing how COL_ENABLED, COL_LAYOUT_MASK, and COL_DENSE work.\n>\n> Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>\n> ---\n\nThanks.\n\nOne micronit (read: if you think the suggested change is a good\nidea, I could just locally amend it) is that it would read better\nand also easier to maintain to say\n\n\tThese options control\n\nwithout \"three\".  Both 'man' and 'html' output looked good.\n\n\n>  Documentation/config.txt | 20 +++++++++++++++++---\n>  1 file changed, 17 insertions(+), 3 deletions(-)\n>\n> diff --git a/Documentation/config.txt b/Documentation/config.txt\n> index 1153585..5a10169 100644\n> --- a/Documentation/config.txt\n> +++ b/Documentation/config.txt\n> @@ -934,6 +934,9 @@ column.ui::\n>  \tThis variable consists of a list of tokens separated by spaces\n>  \tor commas:\n>  +\n> +These three options control when the feature should be enabled\n> +(defaults to 'never'):\n> ++\n>  --\n>  `always`;;\n>  \talways show in columns\n> @@ -941,19 +944,30 @@ column.ui::\n>  \tnever show in columns\n>  `auto`;;\n>  \tshow in columns if the output is to the terminal\n> +--\n> ++\n> +These three options control layout (defaults to 'column').  Setting\n> +layout implies 'always' if none of 'always', 'never', or 'auto' are\n> +specified.\n> ++\n> +--\n>  `column`;;\n> -\tfill columns before rows (default)\n> +\tfill columns before rows\n>  `row`;;\n>  \tfill rows before columns\n>  `plain`;;\n>  \tshow in one column\n> +--\n> ++\n> +Finally, these options can be combined with a layout option (defaults\n> +to 'nodense'):\n> ++\n> +--\n>  `dense`;;\n>  \tmake unequal size columns to utilize more space\n>  `nodense`;;\n>  \tmake equal size columns\n>  --\n> -+\n> -This option defaults to 'never'.\n>  \n>  column.branch::\n>  \tSpecify whether to output branch listing in `git branch` in columns.\n"},{"id":"222009","messageId":"CALkWK0mkdsJpLPpXLdNwdtFS39Vwfer50LpFU3_eegSPHHsUog@mail.gmail.com","threadId":"34274","inReplyTo":"7vobatzvfg.fsf@alter.siamese.dyndns.org","subject":"Re: [PATCH] column doc: rewrite documentation for column.ui","fromName":"Ramkumar Ramachandra","fromEmail":"artagnon@gmail.com","sentAt":"2013-06-26T06:37:17Z","receivedAt":"2013-06-26T06:37:17Z","isPatch":true,"sender":{"key":"r@artagnon.com","avatar":"https://avatars.githubusercontent.com/u/37226?v=4"},"body":"Junio C Hamano wrote:\n> One micronit (read: if you think the suggested change is a good\n> idea, I could just locally amend it) is that it would read better\n> and also easier to maintain to say\n>\n>         These options control\n>\n> without \"three\".  Both 'man' and 'html' output looked good.\n\nSure, amend it.\n"}]}