git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Pratyush Yadav <me@yadavpratyush.com>
Cc: <git@vger.kernel.org>, Bert Wesarg <bert.wesarg@googlemail.com>,
	Johannes Schindelin <johannes.schindelin@gmx.de>
Subject: Re: [PATCH v2] git-gui: add a readme
Date: Mon, 07 Oct 2019 10:39:24 +0900	[thread overview]
Message-ID: <xmqqimp149mb.fsf@gitster-ct.c.googlers.com> (raw)
In-Reply-To: <20191006220935.31766-1-me@yadavpratyush.com> (Pratyush Yadav's message of "Mon, 7 Oct 2019 03:39:35 +0530")

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)

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.

>      +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.


  reply	other threads:[~2019-10-07  1:43 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-04 22:10 [PATCH] git-gui: add a readme Pratyush Yadav
2019-10-05 10:51 ` Bert Wesarg
2019-10-05 21:11   ` Pratyush Yadav
2019-10-05 19:56 ` Johannes Schindelin
2019-10-05 21:10   ` Pratyush Yadav
2019-10-06 22:09 ` [PATCH v2] " Pratyush Yadav
2019-10-07  1:39   ` Junio C Hamano [this message]
2019-10-07 23:18     ` Pratyush Yadav
2019-10-08 12:17 ` [PATCH v3] " Pratyush Yadav
2019-10-11 21:35   ` Pratyush Yadav
2019-10-12 10:44     ` Bert Wesarg

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqimp149mb.fsf@gitster-ct.c.googlers.com \
    --to=gitster@pobox.com \
    --cc=bert.wesarg@googlemail.com \
    --cc=git@vger.kernel.org \
    --cc=johannes.schindelin@gmx.de \
    --cc=me@yadavpratyush.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).