This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Improve man page's pointer to Texinfo manual.
- From: Pedro Alves <palves at redhat dot com>
- To: GDB Patches <gdb-patches at sourceware dot org>
- Date: Fri, 14 Sep 2012 11:01:19 +0100
- Subject: Improve man page's pointer to Texinfo manual.
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 <palves@redhat.com>
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