From: Philip Oakley <philipoakley@iee.email>
To: Pratyush Yadav <me@yadavpratyush.com>
Cc: Birger Skogeng Pedersen <birger.sp@gmail.com>, git@vger.kernel.org
Subject: Re: [PATCH] git-gui: Add hotkeys to set widget focus
Date: Mon, 2 Sep 2019 18:23:07 +0100 [thread overview]
Message-ID: <ca5052b8-32ea-5d38-76ba-2389b5f95e45@iee.email> (raw)
In-Reply-To: <20190902122527.6cbcizo5dsewrl57@yadavpratyush.com>
On 02/09/2019 13:25, Pratyush Yadav wrote:
> On 01/09/19 11:27PM, Philip Oakley wrote:
>> Hi Pratyus,
>> On 01/09/2019 12:32, Pratyush Yadav wrote:
>>> Hi Birger,
>>>
>>> In case you haven't been following the list, Pat has been inactive
>>> recently, so I am acting as the interim maintainer of git-gui for now,
>>> because no one else stepped up and Junio would rather not maintain it.
>>>
>>> You can find my fork over athttps://github.com/prati0100/git-gui. I
>>> munged your patches to apply on my tree (which is separate from the
>>> git.git tree), but it would be great if you base them on my tree next
>>> time around.
>> Are there any plans or thoughts about creating a more inclusive man page for
>> the git-gui?
>
> Having better documentation has been one of the things I have in my
> future plans, but I can't really say when I can get to it depending on
> my schedule and time available. I have a couple other topics active
> which I'd like to get resolved first.
>
> Of course, if someone else is willing to take the initiative, I'm happy
> to help :)
The main aspect that would help for providing a contribution would be to
at least decide the (rough) framework/format for a full Gui 'man page'.
The existing one
https://github.com/git/git/blob/master/Documentation/git-gui.txt is
rather short. (would also need the sub-tree integration to be finessed)
e.g.
1. how much should it be done via 'include' files (like the git-config
man page now does include::config.txt[] and onwards).
2. Does it use the doc-book man-page format, or something akin to the
former tutorial format? (everything appears to have shifted to the man
page format, so looks like man format is the one.. [1,2,3,4]
I'm thinking that, as it is a big job, it will need the documentation to
be split over a number of small include files so that more folk can be
contributors.
>> Such things as the Options dialog linkages [1], and how to drive the command
>> line options are areas I've wondered about over the years.
>>
>> Not exactly sure how our plain text man pages and formatted HTML would fare
>> for describing the gui layout and where to click. One thing I am noting is
>> that these hotkey nicely have numbers so can easily be used for reference..
>
> For the options dialog, I think a "tooltip" (something like what you get
> when you hover over a image in a browser) that describes the option is a
> better idea than having a separate man page. I don't expect the option
> descriptions to be too long or complicated. This approach has the added
> benefit of not having to maintain a separate man page. Whenever someone
> adds a new options, they have to add its description as well.
A tool tip that says 'see git help config.. ' could be done. Any
pointers to an existing one for trying a cookie cutter approach getting
started on those ones?
>
> I also think the "tools" feature needs some documentation, especially
> about what environment variables we export.
>
> Other than these two, I don't see many places that need too much
> documentation. Rest of the UI is pretty self-intuitive, at least to me.
>
>> Philip
>>
>> [1] https://stackoverflow.com/questions/6007823/is-there-a-help-page-for-the-git-gui-options-dialog
[1,2,3,4]
https://github.com/git/git/blob/master/Documentation/giteveryday.txt
https://github.com/git/git/blob/master/Documentation/gittutorial.txt
https://github.com/git/git/blob/master/Documentation/gitcore-tutorial.txt
https://github.com/git/git/blob/master/Documentation/everyday.txto
next prev parent reply other threads:[~2019-09-02 17:23 UTC|newest]
Thread overview: 46+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-02-20 13:32 git-gui, feature request: add hotkeys to focus different widgets Birger Skogeng Pedersen
2018-02-23 10:22 ` [PATCH] git-gui: Add hotkeys to change focus between ui widgets Birger Skogeng Pedersen
2018-02-23 16:42 ` Birger Skogeng Pedersen
2018-02-28 12:10 ` Birger Skogeng Pedersen
2018-03-05 16:55 ` Johannes Schindelin
2018-03-06 14:35 ` Birger Skogeng Pedersen
2018-03-06 19:28 ` Junio C Hamano
2019-08-31 12:23 ` [PATCH] git-gui: Add hotkeys to set widget focus Birger Skogeng Pedersen
2019-08-31 12:27 ` Birger Skogeng Pedersen
2019-09-01 11:32 ` Pratyush Yadav
2019-09-01 16:21 ` Junio C Hamano
2019-09-01 18:24 ` Birger Skogeng Pedersen
2019-09-01 19:01 ` Bert Wesarg
2019-09-01 19:36 ` [PATCH] " Birger Skogeng Pedersen
2019-09-02 18:19 ` Pratyush Yadav
2019-09-02 18:35 ` Birger Skogeng Pedersen
2019-09-02 18:53 ` Pratyush Yadav
2019-09-02 19:05 ` Birger Skogeng Pedersen
2019-09-02 19:42 ` Bert Wesarg
2019-09-03 14:21 ` Birger Skogeng Pedersen
2019-09-03 14:22 ` Pratyush Yadav
2019-09-03 14:45 ` [PATCH] git-gui: use path name instead of list index to track last clicked file Pratyush Yadav
2019-09-03 18:07 ` [PATCH v4] git-gui: Add hotkeys to set widget focus Birger Skogeng Pedersen
2019-09-03 18:13 ` Birger Skogeng Pedersen
2019-09-03 19:30 ` Birger Skogeng Pedersen
2019-09-03 21:49 ` Pratyush Yadav
2019-09-04 14:30 ` [PATCH v5] " Birger Skogeng Pedersen
2019-09-04 18:59 ` Johannes Sixt
2019-09-04 19:20 ` Birger Skogeng Pedersen
2019-09-04 21:39 ` Johannes Sixt
2019-09-04 22:31 ` Pratyush Yadav
2019-09-04 23:38 ` Junio C Hamano
2019-09-05 12:33 ` Pratyush Yadav
2019-09-04 19:55 ` Bert Wesarg
2019-09-04 21:45 ` Johannes Sixt
2019-09-10 19:12 ` Pratyush Yadav
2019-09-11 6:49 ` Birger Skogeng Pedersen
2019-09-11 17:48 ` Pratyush Yadav
2019-09-11 18:11 ` Johannes Sixt
2019-09-03 16:06 ` [PATCH] [PATCH] " Bert Wesarg
2019-09-01 22:27 ` Philip Oakley
2019-09-02 12:25 ` Pratyush Yadav
2019-09-02 17:23 ` Philip Oakley [this message]
2019-09-03 22:18 ` Pratyush Yadav
2019-09-01 18:58 ` Bert Wesarg
2019-09-01 19:25 ` Birger Skogeng Pedersen
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=ca5052b8-32ea-5d38-76ba-2389b5f95e45@iee.email \
--to=philipoakley@iee.email \
--cc=birger.sp@gmail.com \
--cc=git@vger.kernel.org \
--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).