From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 3255 invoked by alias); 14 Sep 2012 10:01:35 -0000 Received: (qmail 3242 invoked by uid 22791); 14 Sep 2012 10:01:34 -0000 X-SWARE-Spam-Status: No, hits=-7.1 required=5.0 tests=AWL,BAYES_00,KHOP_RCVD_UNTRUST,RCVD_IN_DNSWL_HI,RCVD_IN_HOSTKARMA_W,RP_MATCHES_RCVD,SPF_HELO_PASS X-Spam-Check-By: sourceware.org Received: from mx1.redhat.com (HELO mx1.redhat.com) (209.132.183.28) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Fri, 14 Sep 2012 10:01:20 +0000 Received: from int-mx09.intmail.prod.int.phx2.redhat.com (int-mx09.intmail.prod.int.phx2.redhat.com [10.5.11.22]) by mx1.redhat.com (8.14.4/8.14.4) with ESMTP id q8EA1KNe004402 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Fri, 14 Sep 2012 06:01:20 -0400 Received: from [127.0.0.1] (ovpn01.gateway.prod.ext.ams2.redhat.com [10.39.146.11]) by int-mx09.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id q8EA1Jbo014602 for ; Fri, 14 Sep 2012 06:01:20 -0400 Message-ID: <5053006F.70200@redhat.com> Date: Fri, 14 Sep 2012 10:01:00 -0000 From: Pedro Alves User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:15.0) Gecko/20120828 Thunderbird/15.0 MIME-Version: 1.0 To: GDB Patches Subject: Improve man page's pointer to Texinfo manual. Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 7bit 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 X-SW-Source: 2012-09/txt/msg00276.txt.bz2 Over time, I've observed that after kindly pointing people to RTFM, it's frequent to see them trip over the fact that "man gdb" is very short on details, and they don't realize that the full manual is something else. Worse, if they do get to "info gdb", on some distros, like Fedora, the Texinfo manual is in a separate gdb-doc package, and "info gdb" brings up the man page (because "info" is helpful like that), which further leaves the person thinking that this might be the only documentation there is. Things could be improved on that front, but, IMO, the "SEE ALSO" section of the manual can also make a better job at pointing at the proper manual. This patch steals text from makeinfo's man page, in an effort to try to improve upon the status quo. Before: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ SEE ALSO `gdb' entry in info; Using GDB: A Guide to the GNU Source-Level Debugger, Richard M. Stallman and Roland H. Pesch, July 1991. COPYING ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ After: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ SEE ALSO The full documentation for gdb is maintained as a Texinfo manual. If the info and gdb programs and GDB's Texinfo documentation are properly installed at your site, the command info gdb should give you access to the complete manual. Using GDB: A Guide to the GNU Source-Level Debugger, Richard M. Stallman and Roland H. Pesch, July 1991. COPYING ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Okay? 2012-09-14 Pedro Alves gdb/ * gdb.1 (SEE ALSO): Expand pointer to GDB's Texinfo manual. --- gdb/gdb.1 | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/gdb/gdb.1 b/gdb/gdb.1 index 638f779..7a54f85 100644 --- a/gdb/gdb.1 +++ b/gdb/gdb.1 @@ -365,10 +365,19 @@ Run using \c .PP .SH "SEE ALSO" -.RB "`\|" gdb "\|'" -entry in -.B info\c -\&; +The full documentation for +.B gdb +is maintained as a Texinfo manual. If the +.B info +and +.B gdb +programs and GDB's Texinfo documentation are properly installed at +your site, the command +.IP +.B info gdb +.PP +should give you access to the complete manual. + .I Using GDB: A Guide to the GNU Source-Level Debugger\c , Richard M. Stallman and Roland H. Pesch, July 1991. -- Pedro Alves