From: Frederick Eaton <frederik@ofb.net>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org, Frederick Eaton <frederik@ofb.net>
Subject: [PATCH 2/3] git-column.1: clarify initial description, provide examples
Date: Wed, 19 Sep 2018 13:12:30 -0700 [thread overview]
Message-ID: <20180919201231.609-3-frederik@ofb.net> (raw)
In-Reply-To: <20180919201231.609-1-frederik@ofb.net>
When I read this man page I couldn't figure out what kind of input it
was referring to, or how input was being put into columns, or where I
should look for the syntax of the --mode option.
Signed-off-by: Frederick Eaton <frederik@ofb.net>
---
Documentation/git-column.txt | 35 +++++++++++++++++++++++++++++++++--
1 file changed, 33 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-column.txt b/Documentation/git-column.txt
index 03d18465d..5bbb51068 100644
--- a/Documentation/git-column.txt
+++ b/Documentation/git-column.txt
@@ -13,7 +13,10 @@ SYNOPSIS
DESCRIPTION
-----------
-This command formats its input into multiple columns.
+This command formats the lines of its standard input into a table with
+multiple columns. Each input line occupies one cell of the table. It
+is used internally by other git commands to format output into
+columns.
OPTIONS
-------
@@ -23,7 +26,7 @@ OPTIONS
--mode=<mode>::
Specify layout mode. See configuration variable column.ui for option
- syntax.
+ syntax (in git-config(1)).
--raw-mode=<n>::
Same as --mode but take mode encoded as a number. This is mainly used
@@ -43,6 +46,34 @@ OPTIONS
--padding=<N>::
The number of spaces between columns. One space by default.
+EXAMPLES
+------
+
+Format data by columns:
+------------
+$ seq 1 24 | git column --mode=column --padding=5
+1 4 7 10 13 16 19 22
+2 5 8 11 14 17 20 23
+3 6 9 12 15 18 21 24
+------------
+
+Format data by rows:
+------------
+$ seq 1 21 | git column --mode=row --padding=5
+1 2 3 4 5 6 7
+8 9 10 11 12 13 14
+15 16 17 18 19 20 21
+------------
+
+List some tags in a table with unequal column widths:
+------------
+$ git tag --list 'v2.4.*' --column=row,dense
+v2.4.0 v2.4.0-rc0 v2.4.0-rc1 v2.4.0-rc2 v2.4.0-rc3
+v2.4.1 v2.4.10 v2.4.11 v2.4.12 v2.4.2
+v2.4.3 v2.4.4 v2.4.5 v2.4.6 v2.4.7
+v2.4.8 v2.4.9
+------------
+
GIT
---
Part of the linkgit:git[1] suite
--
2.19.0
next prev parent reply other threads:[~2018-09-19 20:53 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-09-19 20:12 [PATCH 0/3] some documentation changes from the beginning of the alphabet Frederick Eaton
2018-09-19 20:12 ` [PATCH 1/3] git-archimport.1: specify what kind of Arch we're talking about Frederick Eaton
2018-09-19 22:59 ` Junio C Hamano
2018-09-19 23:13 ` frederik
2018-09-19 20:12 ` Frederick Eaton [this message]
2018-09-19 22:59 ` [PATCH 2/3] git-column.1: clarify initial description, provide examples Junio C Hamano
2018-09-20 16:23 ` Duy Nguyen
2018-09-20 17:47 ` frederik
2018-09-21 5:32 ` Eric Sunshine
2018-09-21 16:32 ` Junio C Hamano
2018-09-21 16:48 ` frederik
2018-09-19 20:12 ` [PATCH 3/3] git-describe.1: clarify that "human readable" is also git-readable Frederick Eaton
2018-09-19 22:49 ` [PATCH 0/3] some documentation changes from the beginning of the alphabet Junio C Hamano
2018-09-21 5:18 ` Eric Sunshine
2018-09-21 5:45 ` frederik
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180919201231.609-3-frederik@ofb.net \
--to=frederik@ofb.net \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.