From mboxrd@z Thu Jan 1 00:00:00 1970 From: Thomas Rast Subject: [PATCH] Documentation: revamp gitk(1) Date: Sun, 20 Oct 2013 18:57:41 +0200 Message-ID: <21f40508f83a9407986d29f002adf5ad366c8b88.1382287779.git.trast@inf.ethz.ch> References: <874nblpamj.fsf@linux-k42r.v.cablecom.net> <874nbdnomj.fsf@hexa.v.cablecom.net> <51F6CB7D.1070806@web.de> <87siyu98cq.fsf@linux-k42r.v.cablecom.net> <20130818115456.GA6772@iris.ozlabs.ibm.com> <874namay5p.fsf@linux-k42r.v.cablecom.net> <87k3hhadhj.fsf@linux-k42r.v.cablecom.net> <20131014052547.GB25344@google.com> Mime-Version: 1.0 Content-Type: text/plain Cc: Junio C Hamano , Jonathan Nieder , Paul Mackerras , Jens Lehmann To: X-From: git-owner@vger.kernel.org Sun Oct 20 18:57:52 2013 Return-path: Envelope-to: gcvg-git-2@plane.gmane.org Received: from vger.kernel.org ([209.132.180.67]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1VXwK8-0000Qz-3O for gcvg-git-2@plane.gmane.org; Sun, 20 Oct 2013 18:57:52 +0200 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751254Ab3JTQ5s (ORCPT ); Sun, 20 Oct 2013 12:57:48 -0400 Received: from edge10.ethz.ch ([82.130.75.186]:4181 "EHLO edge10.ethz.ch" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751171Ab3JTQ5r (ORCPT ); Sun, 20 Oct 2013 12:57:47 -0400 Received: from CAS20.d.ethz.ch (172.31.51.110) by edge10.ethz.ch (82.130.75.186) with Microsoft SMTP Server (TLS) id 14.2.298.4; Sun, 20 Oct 2013 18:57:36 +0200 Received: from linux-a99i.v.cablecom.net (46.126.8.85) by CAS20.d.ethz.ch (172.31.51.110) with Microsoft SMTP Server (TLS) id 14.2.298.4; Sun, 20 Oct 2013 18:57:42 +0200 X-Mailer: git-send-email 1.8.4.1.810.g312044e In-Reply-To: <20131014052547.GB25344@google.com> X-Originating-IP: [46.126.8.85] Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Archived-At: The gitk manpage suffers from a bit of neglect: there have been only minor changes, and no changes to the set of options documented, since a2df1fb (Documentation: New GUI configuration and command-line options., 2008-11-13). In the meantime, the set of rev-list options has been expanded several times by options that are useful in gitk, e.g., --ancestry-path and the optional globbing for --branches, --tags and --remotes. Restructure and expand the manpage. List more options that the author perceives as useful, while remaining somewhat terse. Ideally the user should not have to look up any of the references, but we dispense with precise explanations in some places and refer to git-log(1) instead. Note that the options that have an easy GUI equivalent (e.g., --word-diff, -S, --grep) are deliberately not listed even in the cases where they simply fill in the GUI fields. Signed-off-by: Thomas Rast --- Jonathan Nieder wrote: > Support for just the sticked form is better than nothing, especially > if the gitk(1) manpage gains a note about it. In the long run I guess > the ideal would be to add a parse-options-like library to the tcl > support. Ok. I'm generally not happy with the state of that manpage, so I took the chance to improve it (and include a note about sticked forms). The approach is really my own opinion; I ran a half-hearted attempt at an IRC survey but none of the willing victims had any 'gitk' invocations in their history. I'll hold the gitk patches until we get this one sorted out, but then just do the sticked form as before. Documentation/gitk.txt | 107 ++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 83 insertions(+), 24 deletions(-) diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index c17e760..d44e14c 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -8,7 +8,7 @@ gitk - The Git repository browser SYNOPSIS -------- [verse] -'gitk' [