Document git-gui, git-citool as mainporcelain manual pages
PATCH 1/2 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.
---
From Jakub Narebski <[email protected]>:
Quoted 2 lines
It would be nice though to have git-gui(1) man page describing 'blame' subcommand of git-gui
Yes, it would! You might find one below. ;-)
Documentation/cmd-list.perl | 2 + Documentation/git-citool.txt | 32 ++++++++++++ Documentation/git-gui.txt | 115 ++++++++++++++++++++++++++++++++++++++++++ git.spec.in | 12 +++-- 4 files changed, 156 insertions(+), 5 deletions(-) create mode 100644 Documentation/git-citool.txt create mode 100644 Documentation/git-gui.txt
Documentation/cmd-list.perl +2 -0
@@ -86,6 +86,7 @@ git-check-attr purehelpers git-check-ref-format purehelpers git-cherry ancillaryinterrogators git-cherry-pick mainporcelain +git-citool mainporcelain git-clean mainporcelain git-clone mainporcelain git-commit mainporcelain
@@ -111,6 +112,7 @@ git-fsck ancillaryinterrogators git-gc mainporcelain git-get-tar-commit-id ancillaryinterrogators git-grep mainporcelain +git-gui mainporcelain git-hash-object plumbingmanipulators git-http-fetch synchelpers git-http-push synchelpers
Documentation/git-citool.txt new file +32 -0
@@ -0,0 +1,32 @@ +git-citool(1) +============= + +NAME +---- +git-citool - Graphical alternative to git-commit + +SYNOPSIS +-------- +'git citool' + +DESCRIPTION +----------- +A Tcl/Tk based graphical interface to review modified files, stage +them into the index, enter a commit message and record the new +commit onto the current branch. This interface is an alternative +to the less interactive gitlink:git-commit[1] program. + +git-citool is actually a standard alias for 'git gui citool'. +See gitlink:git-gui[1] for more details. + +Author +------ +Written by Shawn O. Pearce <[email protected]>. + +Documentation +-------------- +Documentation by Shawn O. Pearce <[email protected]>. + +GIT +--- +Part of the gitlink:git[7] suite
Documentation/git-gui.txt new file +115 -0
115 lines not on this page · raw message
git.spec.in +7 -5
@@ -164,11 +164,10 @@ rm -rf $RPM_BUILD_ROOT %{_bindir}/git-gui %{_bindir}/git-citool %{_datadir}/git-gui/ -# Not Yet... -# %{!?_without_docs: %{_mandir}/man1/git-gui.1} -# %{!?_without_docs: %doc Documentation/git-gui.html} -# %{!?_without_docs: %{_mandir}/man1/git-citool.1} -# %{!?_without_docs: %doc Documentation/git-citool.html} +%{!?_without_docs: %{_mandir}/man1/git-gui.1} +%{!?_without_docs: %doc Documentation/git-gui.html} +%{!?_without_docs: %{_mandir}/man1/git-citool.1} +%{!?_without_docs: %doc Documentation/git-citool.html} %files -n gitk %defattr(-,root,root)
@@ -188,6 +187,9 @@ rm -rf $RPM_BUILD_ROOT %{!?_without_docs: %doc Documentation/technical} %changelog +* Thu Jun 21 2007 Shawn O. Pearce <[email protected]> +- Added documentation files for git-gui + * Tue May 13 2007 Quy Tonthat <[email protected]> - Added lib files for git-gui - Added Documentation/technical (As needed by Git Users Manual)
Signature · 1 line
1.5.2.2.1050.g51a8b