gitk(1): expand the manpage to look less like a template

Add a short description and document a few selected options additionally to
the different "entities" in the standard calling convention. Advertise
other git repository browsers. Lastly, climb Mount Ego.

Signed-off-by: Jonas Fonseca <fonseca@diku.dk>
Signed-off-by: Junio C Hamano <junkio@cox.net>

diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt
index cb482bf98ef9e2509ab2d2e1665933687538a574..23be0050b0023cbfecc5fa271b97a7d9855a73b0 100644 (file)
--- a/Documentation/gitk.txt
+++ b/Documentation/gitk.txt
@@ -3,26 +3,52 @@ gitk(1)
 
 NAME
 ----
 
 NAME
 ----

-gitk - Some git command not yet documented.
-
+gitk - git repository browser

 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------

-'gitk' [ --option ] <args>...
+'gitk' [<option>...] [<revs>] [--] [<path>...]

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------

-Does something not yet documented.
+Displays changes in a repository or a selected set of commits. This includes
+visualizing the commit graph, showing information related to each commit, and
+the files in the trees of each revision.

 
 

+Historically, gitk was the first repository browser. It's written in tcl/tk
+and started off in a separate repository but was later merged into the main
+git repository.

 
 OPTIONS
 -------
 
 OPTIONS
 -------

---option::
-       Some option not yet documented.
+To control which revisions to shown, the command takes options applicable to
+the gitlink:git-rev-list[1] command. This manual page describes only the most
+frequently used options.
+
+-n <number>, --max-count=<number>::
+
+       Limits the number of commits to show.
+
+--since=<date>::
+
+       Show commits more recent than a specific date.
+
+--until=<date>::
+
+       Show commits older than a specific date.

 
 

-<args>...::
-       Some argument not yet documented.
+<revs>::

 
 

+       Limit the revisions to show. This can be either a single revision
+       meaning show from the given revision and back, or it can be a range in
+       the form "'<from>'..'<to>'" to show all revisions between '<from>' and
+       back to '<to>'. Note, more advanced revision selection can be applied.
+
+<path>::
+
+       Limit commits to the ones touching files in the given paths. Note, to
+       avoid ambiguity wrt. revision names use "--" to separate the paths
+       from any preceeding options.

 
 Examples
 --------
 
 Examples
 --------


@@ -37,13 +63,27 @@ gitk --since="2 weeks ago" \-- gitk::
        The "--" is necessary to avoid confusion with the *branch* named
        'gitk'
 
        The "--" is necessary to avoid confusion with the *branch* named
        'gitk'
 

+See Also
+--------
+'qgit(1)'::
+       A repository browser written in C++ using Qt.
+
+'gitview(1)'::
+       A repository browser written in Python using Gtk. It's based on
+       'bzrk(1)' and distributed in the contrib area of the git repository.
+
+'tig(1)'::
+       A minimal repository browser and git tool output highlighter written
+       in C using Ncurses.
+

 Author
 ------
 Author
 ------

-Written by Paul Mackerras <paulus@samba.org>
+Written by Paul Mackerras <paulus@samba.org>.

 
 Documentation
 --------------
 
 Documentation
 --------------

-Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
+Documentation by Junio C Hamano, Jonas Fonseca, and the git-list
+<git@vger.kernel.org>.

 
 GIT
 ---
 
 GIT
 ---