{"thread":{"id":"9399","subject":"Re: [PATCH] user-manual: mention git gui citool (commit, amend)","startedAt":"2007-08-06T03:33:29Z","lastAt":"2007-08-06T04:06:26Z","messageCount":2,"participants":["Brett Schwarz","Shawn O. Pearce"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"49974","messageId":"608102.66070.qm@web38905.mail.mud.yahoo.com","threadId":"9399","inReplyTo":null,"subject":"Re: [PATCH] user-manual: mention git gui citool (commit, amend)","fromName":"Brett Schwarz","fromEmail":"brett_schwarz@yahoo.com","sentAt":"2007-08-06T03:33:29Z","receivedAt":"2007-08-06T03:33:29Z","isPatch":true,"sender":{"key":"brett_schwarz@yahoo.com","avatar":null},"body":"> \n> ----- Original Message ----\n> From: Shawn O. Pearce \n> To: J. Bruce Fields \n> Cc: Steffen Prohaska ; git@vger.kernel.org\n> Sent: Friday, August 3, 2007 11:20:10 PM\n> Subject: Re: [PATCH] user-manual: mention git gui citool (commit, amend)\n> \n> \"J. Bruce Fields\" wrote:\n> > On Thu, Aug 02, 2007 at 11:04:59PM -0400, Shawn O. Pearce wrote:\n> > > Online help? In git-gui? :-)\n> > >\n> > > We don't have an online help system yet.\n> >\n> > Fair enough.\n> >\n> > Though I'd like to keep the main body of the manual focused on the major\n> > command line tools, I'd have no objection to a separate chapter (or\n> > appendix?) devoted to git-gui; then you could point directly at that.\n> > Would that make sense?\n> \n> Yea, that makes a lot of sense. git-gui isn't a full replacement\n> for the command line anyway, so I would never suggest a wholesale\n> rewrite of the user manual to slant the entire thing towards git-gui.\n> Doing so would only point out the many shortcomings in git-gui. :)\n> \n> I haven't explored any in-Tk rendering options yet, been too busy\n> with other projects. Ideally I'd like to just render the asciidoc\n> markup directly, but I don't think anyone has done an asciidoc\n> viewer for Tk. I can't imagine it would be that difficult to get\n> some sort of parser working though...\n> \n> \n\nSo, I took a stab at this earlier today, and it is fairly straight forward. I have \nsomething that is semi working (I haven't tested all the scenarios yet), but \nthe rest is just really filling in the blanks.\n\nQuestion though: I was going to have a index tree on a side panel...but do\n you want this thing to only bring up the git-gui.txt file, and show the table \nof contents, or do you want all *.txt files in the index? Or .... ?\n\nThanks,\n --brett\n\n\n\n\n\n \n____________________________________________________________________________________\nBe a better Globetrotter. Get better travel answers from someone who knows. Yahoo! Answers - Check it out.\nhttp://answers.yahoo.com/dir/?link=list&sid=396545469\n"},{"id":"49977","messageId":"20070806040626.GI9527@spearce.org","threadId":"9399","inReplyTo":"608102.66070.qm@web38905.mail.mud.yahoo.com","subject":"Re: [PATCH] user-manual: mention git gui citool (commit, amend)","fromName":"Shawn O. Pearce","fromEmail":"spearce@spearce.org","sentAt":"2007-08-06T04:06:26Z","receivedAt":"2007-08-06T04:06:26Z","isPatch":true,"sender":{"key":"spearce@spearce.org","avatar":"https://avatars.githubusercontent.com/u/34844?v=4"},"body":"Brett Schwarz wrote:\n> > From: Shawn O. Pearce \n> > \n> > I haven't explored any in-Tk rendering options yet, been too busy\n> > with other projects. Ideally I'd like to just render the asciidoc\n> > markup directly, but I don't think anyone has done an asciidoc\n> > viewer for Tk. I can't imagine it would be that difficult to get\n> > some sort of parser working though...\n> > \n> > \n> \n> So, I took a stab at this earlier today, and it is fairly straight forward. I have \n> something that is semi working (I haven't tested all the scenarios yet), but \n> the rest is just really filling in the blanks.\n\nYea, I thought it would be really straight-forward. The Tk text\nwidget is a really wonderful tool. Makes these sorts things almost\nwrite themselves...\n \n> Question though: I was going to have a index tree on a side panel...but do\n> you want this thing to only bring up the git-gui.txt file, and show the table \n> of contents, or do you want all *.txt files in the index? Or .... ?\n\nYea, that's a good question. I think I want all of that. ;-)\n\nI mean:\n\nI'd like to be able to allow users to browse all of the Git manual\npages and the user manual, directly from within git-gui. Then I\ncan setup a new subcommand `git gui help commit` to bring up the\ngit-commit manual page in this renderer (for example). So in that\nsense showing all of the manuals in an index is really useful.\nThis may make it easier for some users (e.g me!) as they don't have\nto render the manuals, or rely upon the man/html branches from Junio.\n\nI'd like to let users also browse the git user manual. This is\na fairly large set of documentation, so the table of contents for\nthis thing is not just a list; a proper tree that one can browse\nthrough is really nice.\n\nAnd I'd like to start writing git-gui specific documentation,\nand let users browse through that as well.\n\nSo whatever you can provide is great. And you don't have to get\neverything at once either; just showing single files would be a\ngreat start. Showing single files with the various section headers\nin an \"outline\" view to the left would be even better.\n\n\nI think one of the worst manuals we have is git-fast-import.\nIts huge. It uses a number of asciidoc features, and it has\na fairly large outline. The user manual is actually a lot\nmore complex, but isn't a single file manual page. ;-)\n\n-- \nShawn.\n"}]}