@matheusbsbs / matheus-bagliano / commits / 5164b6cd3c
Fork 0

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>

Jonas Fonseca committed Aug 25, 2006 at 03:04 UTC 5164b6cd3c3a460e43869e6c7d2145d6b49d5c28
1 file changed +50 -10
Documentation/gitk.txt
+50 -10
@@ -3,26 +3,52 @@ gitk(1)
3
4 NAME
5 ----
6 -gitk - Some git command not yet documented.
7 -
6 +gitk - git repository browser
7
8 SYNOPSIS
9 --------
11 -'gitk' [ --option ] <args>...
10 +'gitk' [<option>...] [<revs>] [--] [<path>...]
11
12 DESCRIPTION
13 -----------
15 -Does something not yet documented.
14 +Displays changes in a repository or a selected set of commits. This includes
15 +visualizing the commit graph, showing information related to each commit, and
16 +the files in the trees of each revision.
17
18 +Historically, gitk was the first repository browser. It's written in tcl/tk
19 +and started off in a separate repository but was later merged into the main
20 +git repository.
21
22 OPTIONS
23 -------
20 ---option::
21 - Some option not yet documented.
24 +To control which revisions to shown, the command takes options applicable to
25 +the gitlink:git-rev-list[1] command. This manual page describes only the most
26 +frequently used options.
27 +
28 +-n <number>, --max-count=<number>::
29 +
30 + Limits the number of commits to show.
31 +
32 +--since=<date>::
33 +
34 + Show commits more recent than a specific date.
35 +
36 +--until=<date>::
37 +
38 + Show commits older than a specific date.
39
23 -<args>...::
24 - Some argument not yet documented.
40 +<revs>::
41
42 + Limit the revisions to show. This can be either a single revision
43 + meaning show from the given revision and back, or it can be a range in
44 + the form "'<from>'..'<to>'" to show all revisions between '<from>' and
45 + back to '<to>'. Note, more advanced revision selection can be applied.
46 +
47 +<path>::
48 +
49 + Limit commits to the ones touching files in the given paths. Note, to
50 + avoid ambiguity wrt. revision names use "--" to separate the paths
51 + from any preceeding options.
52
53 Examples
54 --------
@@ -37,13 +63,27 @@ gitk --since="2 weeks ago" \-- gitk::
63 The "--" is necessary to avoid confusion with the *branch* named
64 'gitk'
65
66 +See Also
67 +--------
68 +'qgit(1)'::
69 + A repository browser written in C++ using Qt.
70 +
71 +'gitview(1)'::
72 + A repository browser written in Python using Gtk. It's based on
73 + 'bzrk(1)' and distributed in the contrib area of the git repository.
74 +
75 +'tig(1)'::
76 + A minimal repository browser and git tool output highlighter written
77 + in C using Ncurses.
78 +
79 Author
80 ------
42 -Written by Paul Mackerras <paulus@samba.org>
81 +Written by Paul Mackerras <paulus@samba.org>.
82
83 Documentation
84 --------------
46 -Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
85 +Documentation by Junio C Hamano, Jonas Fonseca, and the git-list
86 +<git@vger.kernel.org>.
87
88 GIT
89 ---