git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v2] git-gui: add a readme

From
Pratyush Yadav <me@yadavpratyush.com>
Date
Oct 7, 2019, 23:18 UTC
Message-ID
<20191007231821.mlaqhobojfca7fgv@yadavpratyush.com>
In-Reply-To
<xmqqimp149mb.fsf@gitster-ct.c.googlers.com>
On 07/10/19 10:39AM, Junio C Hamano wrote:
Show 11 quoted lines
> Pratyush Yadav <me@yadavpratyush.com> writes:
> 
> >     -+# Git Gui - A graphical user interface for Git
> >     ++# Git GUI - A graphical user interface for Git
> >      +
> >     -+Git Gui is a GUI for [git](https://git-scm.com/) written in Tcl/Tk. It allows
> >     -+you to use the git source control management tools via a GUI. This includes
> >     ++Git GUI is a GUI for [Git](https://git-scm.com/) written in Tcl/Tk. It allows
> >     ++you to use the Git source control management tools via a GUI. This includes
> 
> (ignore me if this has been discussed already)
It hasn't been.
 
Show 13 quoted lines
> The first sentence looks overly repeticious (it just looks to me as
> if saying "Git GUI is a Git GUI written in Tcl/Tk").  Saying
> 
> 	Git GUI allows you to use the [Git source control management
> 	tools](https://git-scm.com/) via a GUI and is written in
> 	Tcl/Tk.  This includes ...
> 
> may reduce the repetition somewhat.  Also if I were writing this
> intro, I'd move "writtein in Tcl/Tk" to a lot later or perhaps just
> drop the phrase from here; what the users can gain from the tool is
> much more important to the readers of this document than its
> implementation detail.  "Written in Tcl" is given in the installation
> section anyway.
Will fix.
 
Show 27 quoted lines
> >      +staging, commiting, adding, pushing, etc. It can also be used as a blame
> >      +viewer, a tree browser, and a citool (make exactly one commit before exiting
> >      +and returning to shell). More details about git-gui can be found in its manual
> >      +page by either running `man git-gui`, or by visiting the [online manual
> >      +page](https://git-scm.com/docs/git-gui).
> >      +
> >     -+Git Gui was initially written by Shawn O. Pearce, and is distributed with the
> >     -+standard git installation.
> >     ++Git GUI was initially written by Shawn O. Pearce, and is distributed with the
> >     ++standard Git installation.
> >      +
> >      +# Building and installing
> >      +
> >     -+Most of Git Gui is written in Tcl, so there is not much compilation involved.
> >     -+Still, some things do need to be done, so you do need to "build" it.
> >     ++Most of Git GUI is written in Tcl, so there is no compilation involved. Still,
> >     ++some things do need to be done (mostly some substitutions), so you do need to
> >     ++"build" it.
> 
> It is a good thing to say that it is written in Tcl for two
> reasons..  The users need to know (1) they need to know Tcl/Tk to
> hack on it, and (2) they need to install "wish" as a prerequisite to
> run it.  
> 
> Does the document mention the latter explicitly?  If it does not, it
> probably should.  Also it helps to have msgfmt installed when
> building git-gui.  That also should be mentioned.
No, it does not.

I'll also check if there are any other dependencies. I installed git-gui from my distro's package manager, so I got all the dependencies pulled in automatically, and don't remember if there was something other than Tcl and wish needed.

-- 
Regards,
Pratyush Yadav
Previous: Junio C HamanoNext: Pratyush Yadav
Message 8 of 11 in “git-gui: add a readme”
  1. git-gui: add a readmePratyush Yadav, Oct 4, 2019
  2. Bert WesargOct 5, 2019
  3. Pratyush YadavOct 5, 2019
  4. Johannes SchindelinOct 5, 2019
  5. Pratyush YadavOct 5, 2019
  6. git-gui: add a readmePratyush Yadav, Oct 6, 2019
  7. Junio C HamanoOct 7, 2019
  8. Pratyush YadavOct 7, 2019
  9. git-gui: add a readmePratyush Yadav, Oct 8, 2019
  10. Pratyush YadavOct 11, 2019
  11. Bert WesargOct 12, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.