@matheusbsbs / matheus-bagliano / commits / 37cd4f7e82
Fork 0

Document git-gui, git-citool as mainporcelain manual pages

Jakub Narebski pointed out that the git-gui blame viewer is not a widely known feature, but is incredibly useful. Part of the issue is advertising. Up until now we haven't even referenced git-gui from within the core Git manual pages, mostly because I just wasn't sure how I wanted to supply git-gui documentation to end-users, or how that documentation should integrate with the core Git documentation. Based upon Jakub's comment that many users may not even know that the gui is available in a stock Git distribution I'm offering up two basic manual pages: git-citool and git-gui. These should offer enough of a starting point for users to identify that the gui exists, and how to start it. Future releases of git-gui may contain their own documentation system available from within a running git-gui. But not today. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Shawn O. Pearce committed Jun 21, 2007 at 00:51 UTC 37cd4f7e820da82e5731c06b7ebf83963d796e5e
4 files changed +156 -5
Documentation/cmd-list.perl
+2
@@ -86,6 +86,7 @@ git-check-attr purehelpers
86 git-check-ref-format purehelpers
87 git-cherry ancillaryinterrogators
88 git-cherry-pick mainporcelain
89 +git-citool mainporcelain
90 git-clean mainporcelain
91 git-clone mainporcelain
92 git-commit mainporcelain
@@ -111,6 +112,7 @@ git-fsck ancillaryinterrogators
112 git-gc mainporcelain
113 git-get-tar-commit-id ancillaryinterrogators
114 git-grep mainporcelain
115 +git-gui mainporcelain
116 git-hash-object plumbingmanipulators
117 git-http-fetch synchelpers
118 git-http-push synchelpers
Documentation/git-citool.txt new
+32
@@ -0,0 +1,32 @@
1 +git-citool(1)
2 +=============
3 +
4 +NAME
5 +----
6 +git-citool - Graphical alternative to git-commit
7 +
8 +SYNOPSIS
9 +--------
10 +'git citool'
11 +
12 +DESCRIPTION
13 +-----------
14 +A Tcl/Tk based graphical interface to review modified files, stage
15 +them into the index, enter a commit message and record the new
16 +commit onto the current branch. This interface is an alternative
17 +to the less interactive gitlink:git-commit[1] program.
18 +
19 +git-citool is actually a standard alias for 'git gui citool'.
20 +See gitlink:git-gui[1] for more details.
21 +
22 +Author
23 +------
24 +Written by Shawn O. Pearce <spearce@spearce.org>.
25 +
26 +Documentation
27 +--------------
28 +Documentation by Shawn O. Pearce <spearce@spearce.org>.
29 +
30 +GIT
31 +---
32 +Part of the gitlink:git[7] suite
Documentation/git-gui.txt new
+115
@@ -0,0 +1,115 @@
1 +git-gui(1)
2 +==========
3 +
4 +NAME
5 +----
6 +git-gui - A portable graphical interface to Git
7 +
8 +SYNOPSIS
9 +--------
10 +'git gui' [<command>] [arguments]
11 +
12 +DESCRIPTION
13 +-----------
14 +A Tcl/Tk based graphical user interface to Git. git-gui focuses
15 +on allowing users to make changes to their repository by making
16 +new commits, amending existing ones, creating branches, performing
17 +local merges, and fetching/pushing to remote repositories.
18 +
19 +Unlike gitlink:gitk[1], git-gui focuses on commit generation
20 +and single file annotation, and does not show project history.
21 +It does however supply menu actions to start a gitk session from
22 +within git-gui.
23 +
24 +git-gui is known to work on all popular UNIX systems, Mac OS X,
25 +and Windows (under both Cygwin and MSYS). To the extent possible
26 +OS specific user interface guidelines are followed, making git-gui
27 +a fairly native interface for users.
28 +
29 +COMMANDS
30 +--------
31 +blame::
32 + Start a blame viewer on the specified file on the given
33 + version (or working directory if not specified).
34 +
35 +browser::
36 + Start a tree browser showing all files in the specified
37 + commit (or 'HEAD' by default). Files selected through the
38 + browser are opened in the blame viewer.
39 +
40 +citool::
41 + Start git-gui and arrange to make exactly one commit before
42 + exiting and returning to the shell. The interface is limited
43 + to only commit actions, slightly reducing the application's
44 + startup time and simplifying the menubar.
45 +
46 +version::
47 + Display the currently running version of git-gui.
48 +
49 +
50 +Examples
51 +--------
52 +git gui blame Makefile::
53 +
54 + Show the contents of the file 'Makefile' in the current
55 + working directory, and provide annotations for both the
56 + original author of each line, and who moved the line to its
57 + current location. The uncommitted file is annotated, and
58 + uncommitted changes (if any) are explicitly attributed to
59 + 'Not Yet Committed'.
60 +
61 +git gui blame v0.99.8 Makefile::
62 +
63 + Show the contents of 'Makefile' in revision 'v0.99.8'
64 + and provide annotations for each line. Unlike the above
65 + example the file is read from the object database and not
66 + the working directory.
67 +
68 +git gui citool::
69 +
70 + Make one commit and return to the shell when it is complete.
71 +
72 +git citool::
73 +
74 + Same as 'git gui citool' (above).
75 +
76 +git gui browser maint::
77 +
78 + Show a browser for the tree of the 'maint' branch. Files
79 + selected in the browser can be viewed with the internal
80 + blame viewer.
81 +
82 +See Also
83 +--------
84 +'gitk(1)'::
85 + The git repository browser. Shows branches, commit history
86 + and file differences. gitk is the utility started by
87 + git-gui's Repository Visualize actions.
88 +
89 +Other
90 +-----
91 +git-gui is actually maintained as an independent project, but stable
92 +versions are distributed as part of the Git suite for the convience
93 +of end users.
94 +
95 +A git-gui development repository can be obtained from:
96 +
97 + git clone git://repo.or.cz/git-gui.git
98 +
99 +or
100 +
101 + git clone http://repo.or.cz/r/git-gui.git
102 +
103 +or browsed online at http://repo.or.cz/w/git-gui.git/[].
104 +
105 +Author
106 +------
107 +Written by Shawn O. Pearce <spearce@spearce.org>.
108 +
109 +Documentation
110 +--------------
111 +Documentation by Shawn O. Pearce <spearce@spearce.org>.
112 +
113 +GIT
114 +---
115 +Part of the gitlink:git[7] suite
git.spec.in
+7 -5
@@ -164,11 +164,10 @@ rm -rf $RPM_BUILD_ROOT
164 %{_bindir}/git-gui
165 %{_bindir}/git-citool
166 %{_datadir}/git-gui/
167 -# Not Yet...
168 -# %{!?_without_docs: %{_mandir}/man1/git-gui.1}
169 -# %{!?_without_docs: %doc Documentation/git-gui.html}
170 -# %{!?_without_docs: %{_mandir}/man1/git-citool.1}
171 -# %{!?_without_docs: %doc Documentation/git-citool.html}
167 +%{!?_without_docs: %{_mandir}/man1/git-gui.1}
168 +%{!?_without_docs: %doc Documentation/git-gui.html}
169 +%{!?_without_docs: %{_mandir}/man1/git-citool.1}
170 +%{!?_without_docs: %doc Documentation/git-citool.html}
171
172 %files -n gitk
173 %defattr(-,root,root)
@@ -188,6 +187,9 @@ rm -rf $RPM_BUILD_ROOT
187 %{!?_without_docs: %doc Documentation/technical}
188
189 %changelog
190 +* Thu Jun 21 2007 Shawn O. Pearce <spearce@spearce.org>
191 +- Added documentation files for git-gui
192 +
193 * Tue May 13 2007 Quy Tonthat <qtonthat@gmail.com>
194 - Added lib files for git-gui
195 - Added Documentation/technical (As needed by Git Users Manual)