{"thread":{"id":"8669","subject":"[PATCH 1/2] Document git-gui, git-citool as mainporcelain manual pages","startedAt":"2007-06-21T04:51:00Z","lastAt":"2007-06-21T04:51:00Z","messageCount":1,"participants":["Shawn O. Pearce"],"isPatch":true,"patchVersion":1,"patchTotal":2},"messages":[{"id":"45463","messageId":"20070621045100.GA13977@spearce.org","threadId":"8669","inReplyTo":null,"subject":"[PATCH 1/2] Document git-gui, git-citool as mainporcelain manual pages","fromName":"Shawn O. Pearce","fromEmail":"spearce@spearce.org","sentAt":"2007-06-21T04:51:00Z","receivedAt":"2007-06-21T04:51:00Z","isPatch":true,"sender":{"key":"spearce@spearce.org","avatar":"https://avatars.githubusercontent.com/u/34844?v=4"},"body":"Jakub Narebski pointed out that the git-gui blame viewer is not a\nwidely known feature, but is incredibly useful.  Part of the issue\nis advertising.  Up until now we haven't even referenced git-gui from\nwithin the core Git manual pages, mostly because I just wasn't sure\nhow I wanted to supply git-gui documentation to end-users, or how\nthat documentation should integrate with the core Git documentation.\n\nBased upon Jakub's comment that many users may not even know that\nthe gui is available in a stock Git distribution I'm offering up\ntwo basic manual pages: git-citool and git-gui.  These should offer\nenough of a starting point for users to identify that the gui exists,\nand how to start it.  Future releases of git-gui may contain their\nown documentation system available from within a running git-gui.\nBut not today.\n\nSigned-off-by: Shawn O. Pearce <spearce@spearce.org>\n---\n\n From Jakub Narebski <jnareb@gmail.com>:\n > It would be nice though to have git-gui(1) man page describing\n > 'blame' subcommand of git-gui\n\n Yes, it would!  You might find one below.  ;-)\n\n\n Documentation/cmd-list.perl  |    2 +\n Documentation/git-citool.txt |   32 ++++++++++++\n Documentation/git-gui.txt    |  115 ++++++++++++++++++++++++++++++++++++++++++\n git.spec.in                  |   12 +++--\n 4 files changed, 156 insertions(+), 5 deletions(-)\n create mode 100644 Documentation/git-citool.txt\n create mode 100644 Documentation/git-gui.txt\n\ndiff --git a/Documentation/cmd-list.perl b/Documentation/cmd-list.perl\nindex a181f75..fcea1d7 100755\n--- a/Documentation/cmd-list.perl\n+++ b/Documentation/cmd-list.perl\n@@ -86,6 +86,7 @@ git-check-attr                          purehelpers\n git-check-ref-format                    purehelpers\n git-cherry                              ancillaryinterrogators\n git-cherry-pick                         mainporcelain\n+git-citool                              mainporcelain\n git-clean                               mainporcelain\n git-clone                               mainporcelain\n git-commit                              mainporcelain\n@@ -111,6 +112,7 @@ git-fsck\t                        ancillaryinterrogators\n git-gc                                  mainporcelain\n git-get-tar-commit-id                   ancillaryinterrogators\n git-grep                                mainporcelain\n+git-gui                                 mainporcelain\n git-hash-object                         plumbingmanipulators\n git-http-fetch                          synchelpers\n git-http-push                           synchelpers\ndiff --git a/Documentation/git-citool.txt b/Documentation/git-citool.txt\nnew file mode 100644\nindex 0000000..5217ab2\n--- /dev/null\n+++ b/Documentation/git-citool.txt\n@@ -0,0 +1,32 @@\n+git-citool(1)\n+=============\n+\n+NAME\n+----\n+git-citool - Graphical alternative to git-commit\n+\n+SYNOPSIS\n+--------\n+'git citool'\n+\n+DESCRIPTION\n+-----------\n+A Tcl/Tk based graphical interface to review modified files, stage\n+them into the index, enter a commit message and record the new\n+commit onto the current branch.  This interface is an alternative\n+to the less interactive gitlink:git-commit[1] program.\n+\n+git-citool is actually a standard alias for 'git gui citool'.\n+See gitlink:git-gui[1] for more details.\n+\n+Author\n+------\n+Written by Shawn O. Pearce <spearce@spearce.org>.\n+\n+Documentation\n+--------------\n+Documentation by Shawn O. Pearce <spearce@spearce.org>.\n+\n+GIT\n+---\n+Part of the gitlink:git[7] suite\ndiff --git a/Documentation/git-gui.txt b/Documentation/git-gui.txt\nnew file mode 100644\nindex 0000000..bd613b2\n--- /dev/null\n+++ b/Documentation/git-gui.txt\n@@ -0,0 +1,115 @@\n+git-gui(1)\n+==========\n+\n+NAME\n+----\n+git-gui - A portable graphical interface to Git\n+\n+SYNOPSIS\n+--------\n+'git gui' [<command>] [arguments]\n+\n+DESCRIPTION\n+-----------\n+A Tcl/Tk based graphical user interface to Git.  git-gui focuses\n+on allowing users to make changes to their repository by making\n+new commits, amending existing ones, creating branches, performing\n+local merges, and fetching/pushing to remote repositories.\n+\n+Unlike gitlink:gitk[1], git-gui focuses on commit generation\n+and single file annotation, and does not show project history.\n+It does however supply menu actions to start a gitk session from\n+within git-gui.\n+\n+git-gui is known to work on all popular UNIX systems, Mac OS X,\n+and Windows (under both Cygwin and MSYS).  To the extent possible\n+OS specific user interface guidelines are followed, making git-gui\n+a fairly native interface for users.\n+\n+COMMANDS\n+--------\n+blame::\n+\tStart a blame viewer on the specified file on the given\n+\tversion (or working directory if not specified).\n+\n+browser::\n+\tStart a tree browser showing all files in the specified\n+\tcommit (or 'HEAD' by default).\tFiles selected through the\n+\tbrowser are opened in the blame viewer.\n+\n+citool::\n+\tStart git-gui and arrange to make exactly one commit before\n+\texiting and returning to the shell.  The interface is limited\n+\tto only commit actions, slightly reducing the application's\n+\tstartup time and simplifying the menubar.\n+\n+version::\n+\tDisplay the currently running version of git-gui.\n+\n+\n+Examples\n+--------\n+git gui blame Makefile::\n+\n+\tShow the contents of the file 'Makefile' in the current\n+\tworking directory, and provide annotations for both the\n+\toriginal author of each line, and who moved the line to its\n+\tcurrent location.  The uncommitted file is annotated, and\n+\tuncommitted changes (if any) are explicitly attributed to\n+\t'Not Yet Committed'.\n+\n+git gui blame v0.99.8 Makefile::\n+\n+\tShow the contents of 'Makefile' in revision 'v0.99.8'\n+\tand provide annotations for each line.\tUnlike the above\n+\texample the file is read from the object database and not\n+\tthe working directory.\n+\n+git gui citool::\n+\n+\tMake one commit and return to the shell when it is complete.\n+\n+git citool::\n+\n+\tSame as 'git gui citool' (above).\n+\n+git gui browser maint::\n+\n+\tShow a browser for the tree of the 'maint' branch.  Files\n+\tselected in the browser can be viewed with the internal\n+\tblame viewer.\n+\n+See Also\n+--------\n+'gitk(1)'::\n+\tThe git repository browser.  Shows branches, commit history\n+\tand file differences.  gitk is the utility started by\n+\tgit-gui's Repository Visualize actions.\n+\n+Other\n+-----\n+git-gui is actually maintained as an independent project, but stable\n+versions are distributed as part of the Git suite for the convience\n+of end users.\n+\n+A git-gui development repository can be obtained from:\n+\n+  git clone git://repo.or.cz/git-gui.git\n+\n+or\n+\n+  git clone http://repo.or.cz/r/git-gui.git\n+\n+or browsed online at http://repo.or.cz/w/git-gui.git/[].\n+\n+Author\n+------\n+Written by Shawn O. Pearce <spearce@spearce.org>.\n+\n+Documentation\n+--------------\n+Documentation by Shawn O. Pearce <spearce@spearce.org>.\n+\n+GIT\n+---\n+Part of the gitlink:git[7] suite\ndiff --git a/git.spec.in b/git.spec.in\nindex b9dc1d5..287057e 100644\n--- a/git.spec.in\n+++ b/git.spec.in\n@@ -164,11 +164,10 @@ rm -rf $RPM_BUILD_ROOT\n %{_bindir}/git-gui\n %{_bindir}/git-citool\n %{_datadir}/git-gui/\n-# Not Yet...\n-# %{!?_without_docs: %{_mandir}/man1/git-gui.1}\n-# %{!?_without_docs: %doc Documentation/git-gui.html}\n-# %{!?_without_docs: %{_mandir}/man1/git-citool.1}\n-# %{!?_without_docs: %doc Documentation/git-citool.html}\n+%{!?_without_docs: %{_mandir}/man1/git-gui.1}\n+%{!?_without_docs: %doc Documentation/git-gui.html}\n+%{!?_without_docs: %{_mandir}/man1/git-citool.1}\n+%{!?_without_docs: %doc Documentation/git-citool.html}\n \n %files -n gitk\n %defattr(-,root,root)\n@@ -188,6 +187,9 @@ rm -rf $RPM_BUILD_ROOT\n %{!?_without_docs: %doc Documentation/technical}\n \n %changelog\n+* Thu Jun 21 2007 Shawn O. Pearce <spearce@spearce.org>\n+- Added documentation files for git-gui\n+\n * Tue May 13 2007 Quy Tonthat <qtonthat@gmail.com>\n - Added lib files for git-gui\n - Added Documentation/technical (As needed by Git Users Manual)\n-- \n1.5.2.2.1050.g51a8b\n"}]}