From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 25125 invoked by alias); 13 Jun 2013 09:12:20 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Received: (qmail 25114 invoked by uid 89); 13 Jun 2013 09:12:20 -0000 X-Spam-SWARE-Status: No, score=-7.7 required=5.0 tests=AWL,BAYES_00,KHOP_THREADED,RCVD_IN_HOSTKARMA_W,RCVD_IN_HOSTKARMA_WL,RP_MATCHES_RCVD,SPF_HELO_PASS,SPF_PASS autolearn=ham version=3.3.1 Received: from mx1.redhat.com (HELO mx1.redhat.com) (209.132.183.28) by sourceware.org (qpsmtpd/0.84/v0.84-167-ge50287c) with ESMTP; Thu, 13 Jun 2013 09:12:18 +0000 Received: from int-mx01.intmail.prod.int.phx2.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) by mx1.redhat.com (8.14.4/8.14.4) with ESMTP id r5D9CGE4021614 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Thu, 13 Jun 2013 05:12:16 -0400 Received: from [127.0.0.1] (ovpn01.gateway.prod.ext.ams2.redhat.com [10.39.146.11]) by int-mx01.intmail.prod.int.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id r5D9CFY1005783; Thu, 13 Jun 2013 05:12:16 -0400 Message-ID: <51B98CEE.3080006@redhat.com> Date: Thu, 13 Jun 2013 09:16:00 -0000 From: Pedro Alves User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:17.0) Gecko/20130514 Thunderbird/17.0.6 MIME-Version: 1.0 To: Phil Muldoon CC: "gdb-patches@sourceware.org" Subject: Re: [rfc] Add help text to start-up text References: <51B8D10E.5030409@redhat.com> In-Reply-To: <51B8D10E.5030409@redhat.com> Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 7bit X-SW-Source: 2013-06/txt/msg00306.txt.bz2 On 06/12/2013 08:50 PM, Phil Muldoon wrote: > This patch proposes to add a few items to the GDB start-up text to > provide some indication on where the user can find help. > > I did not add the wiki and manual URLs to configure et al as I am not > sure that is needed (I guess GDB packagers might have an opinion > here). > > Also I am not sure if anything actually parses the initial output of > the GDB start-up text and if adding these lines will affect that. So > I am seeking comments. > > What do you think? I think at least the help and apropos bits are going to be super useful. I like that a lot. > + fprintf_filtered (stream, _("The GDB manual can be found online at:\n\ > +\n")); > + fprintf_filtered (stream, _("The GDB wiki can be found online at:\n\ > +\n\n")); IMO, putting only one url here would be enough, and would make this more condensed. I don't think users need to care about the fact that some documentation is in a wiki. We should add a link to the wiki to . There's more than the manual there even. We could then just say something like: (I suggest the imperative, like the help/apropos sentences, which turns out shorter too.) "Find the GDB manual and other documentation resources online at:\n\ + fprintf_filtered (stream, _("For help, type 'help'.\n")); > + fprintf_filtered (stream, _("Type 'apropos word' to search for \ > +commands related to 'word'.\n")); > } > > /* Print the details of GDB build-time configuration. */ -- Pedro Alves