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 :) > 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. 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 -- Regards, Pratyush Yadav
