This is the mail archive of the
binutils@sourceware.org
mailing list for the binutils project.
Use --with-bugurl value in manuals
- From: "Joseph S. Myers" <joseph at codesourcery dot com>
- To: binutils at sourceware dot org
- Date: Fri, 2 Mar 2007 21:21:15 +0000 (UTC)
- Subject: Use --with-bugurl value in manuals
This patch makes --with-bugurl control the bug reporting URL in the
Texinfo manuals as well as that in --help output. OK to commit?
In the default case the manuals will now refer to the Bugzilla database
URL rather than giving the bug-binutils email address. I think this is a
good thing. Some obsolete text about sending large files by email
(suggesting uuencode for binaries, so predating MIME, and anon FTP, so
predating the Web) is removed, since with a bug database URL users will be
attaching files to the bugs in the database instead.
Note: the gprof manual does not have a section on reporting bugs, so there
are no gprof directory changes here.
binutils:
2007-03-02 Joseph Myers <joseph@codesourcery.com>
* configure.in (REPORT_BUGS_TEXI): Define to Texinfo version of
bug-reporting URL.
* doc/Makefile.am (config.texi): Define BUGURL.
* doc/binutils.texi: Use BUGURL. Remove text about large files
and uuencoding.
* Makefile.in, configure, doc/Makefile.in: Regenerate.
gas:
2007-03-02 Joseph Myers <joseph@codesourcery.com>
* configure.in (REPORT_BUGS_TEXI): Define to Texinfo version of
bug-reporting URL.
* doc/Makefile.am (gasver.texi): Define BUGURL.
* doc/as.texinfo: Use BUGURL.
* Makefile.in, configure, doc/Makefile.in: Regenerate.
ld:
2007-03-02 Joseph Myers <joseph@codesourcery.com>
* configure.in (REPORT_BUGS_TEXI): Define to Texinfo version of
bug-reporting URL.
* Makefile.am (ldver.texi): Define BUGURL.
* ld.texinfo: Use BUGURL.
* Makefile.in, configure: Regenerate.
Index: binutils/configure.in
===================================================================
RCS file: /cvs/src/src/binutils/configure.in,v
retrieving revision 1.75
diff -u -r1.75 configure.in
--- binutils/configure.in 28 Feb 2007 01:29:32 -0000 1.75
+++ binutils/configure.in 2 Mar 2007 21:04:43 -0000
@@ -35,12 +35,18 @@
[Direct users to URL to report a bug]),
[case "$withval" in
yes) AC_MSG_ERROR([bug URL not specified]) ;;
- no) REPORT_BUGS_TO="" ;;
- *) REPORT_BUGS_TO="<URL:$withval>" ;;
+ no) REPORT_BUGS_TO="";
+ REPORT_BUGS_TEXI=""
+ ;;
+ *) REPORT_BUGS_TO="<URL:$withval>"
+ REPORT_BUGS_TEXI="@uref{`echo $withval | sed 's/@/@@/g'`}"
+ ;;
esac],
REPORT_BUGS_TO="<URL:http://www.sourceware.org/bugzilla/>"
+ REPORT_BUGS_TEXI="@uref{http://www.sourceware.org/bugzilla/}";
)
AC_SUBST(REPORT_BUGS_TO)
+AC_SUBST(REPORT_BUGS_TEXI)
AM_BINUTILS_WARNINGS
Index: binutils/doc/Makefile.am
===================================================================
RCS file: /cvs/src/src/binutils/doc/Makefile.am,v
retrieving revision 1.16
diff -u -r1.16 Makefile.am
--- binutils/doc/Makefile.am 11 Dec 2006 15:09:41 -0000 1.16
+++ binutils/doc/Makefile.am 2 Mar 2007 21:04:43 -0000
@@ -42,6 +42,9 @@
eval `grep '^ *VERSION=' $(srcdir)/../../bfd/configure`; \
echo "@set VERSION $$VERSION" > $@
echo "@set UPDATED `date '+%B %Y'`" >> config.texi
+ if [ -n "$(REPORT_BUGS_TEXI)" ]; then \
+ echo "@set BUGURL $(REPORT_BUGS_TEXI)" >> config.texi; \
+ fi
# Man page generation from texinfo
addr2line.1: $(binutils_TEXI) $(binutils_TEXINFOS)
Index: binutils/doc/binutils.texi
===================================================================
RCS file: /cvs/src/src/binutils/doc/binutils.texi,v
retrieving revision 1.100
diff -u -r1.100 binutils.texi
--- binutils/doc/binutils.texi 1 Mar 2007 16:39:42 -0000 1.100
+++ binutils/doc/binutils.texi 2 Mar 2007 21:04:44 -0000
@@ -1,6 +1,7 @@
\input texinfo @c -*- Texinfo -*-
@setfilename binutils.info
-@c Copyright 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
+@c Copyright 2001, 2002, 2003, 2004, 2005, 2006, 2007
+@c Free Software Foundation, Inc.
@c man begin INCLUDE
@include config.texi
@@ -32,7 +33,7 @@
@ifinfo
@c man begin COPYRIGHT
Copyright @copyright{} 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
-2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
+2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1
@@ -56,8 +57,8 @@
@c This file documents the GNU binary utilities "ar", "ld", "objcopy",
@c "objdump", "nm", "size", "strings", "strip", "readelf" and "ranlib".
@c
-@c Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
-@c 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
+@c Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
+@c 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
@c
@c This text may be freely distributed under the terms of the GNU
@c Free Documentation License.
@@ -83,7 +84,7 @@
@vskip 0pt plus 1filll
Copyright @copyright{} 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
-2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
+2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1
@@ -3784,8 +3785,10 @@
individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
distribution.
+@ifset BUGURL
In any event, we also recommend that you send bug reports for the binary
-utilities to @samp{bug-binutils@@gnu.org}.
+utilities to @value{BUGURL}.
+@end ifset
The fundamental principle of reporting bugs usefully is this:
@strong{report all the facts}. If you are not sure whether to state a
@@ -3844,11 +3847,7 @@
@item
A complete input file, or set of input files, that will reproduce the
bug. If the utility is reading an object file or files, then it is
-generally most helpful to send the actual object files, uuencoded if
-necessary to get them through the mail system. Note that
-@samp{bug-binutils@@gnu.org} is a mailing list, so you should avoid
-sending very large files to it. Making the files available for
-anonymous FTP is OK.
+generally most helpful to send the actual object files.
If the source files were produced exclusively using @sc{gnu} programs
(e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
Index: gas/configure.in
===================================================================
RCS file: /cvs/src/src/gas/configure.in,v
retrieving revision 1.197
diff -u -r1.197 configure.in
--- gas/configure.in 17 Feb 2007 13:33:56 -0000 1.197
+++ gas/configure.in 2 Mar 2007 21:04:46 -0000
@@ -46,12 +46,18 @@
[Direct users to URL to report a bug]),
[case "$withval" in
yes) AC_MSG_ERROR([bug URL not specified]) ;;
- no) REPORT_BUGS_TO="" ;;
- *) REPORT_BUGS_TO="<URL:$withval>" ;;
+ no) REPORT_BUGS_TO="";
+ REPORT_BUGS_TEXI=""
+ ;;
+ *) REPORT_BUGS_TO="<URL:$withval>"
+ REPORT_BUGS_TEXI="@uref{`echo $withval | sed 's/@/@@/g'`}"
+ ;;
esac],
REPORT_BUGS_TO="<URL:http://www.sourceware.org/bugzilla/>"
+ REPORT_BUGS_TEXI="@uref{http://www.sourceware.org/bugzilla/}";
)
AC_SUBST(REPORT_BUGS_TO)
+AC_SUBST(REPORT_BUGS_TEXI)
AM_BINUTILS_WARNINGS
Index: gas/doc/Makefile.am
===================================================================
RCS file: /cvs/src/src/gas/doc/Makefile.am,v
retrieving revision 1.48
diff -u -r1.48 Makefile.am
--- gas/doc/Makefile.am 12 Dec 2006 14:31:47 -0000 1.48
+++ gas/doc/Makefile.am 2 Mar 2007 21:04:46 -0000
@@ -67,6 +67,9 @@
rm -f $@
eval `grep '^ *VERSION=' $(srcdir)/../../bfd/configure`; \
echo "@set VERSION $$VERSION" > $@
+ if [ -n "$(REPORT_BUGS_TEXI)" ]; then \
+ echo "@set BUGURL $(REPORT_BUGS_TEXI)" >> $@; \
+ fi
# We want install to imply install-info as per GNU standards, despite the
# cygnus option.
Index: gas/doc/as.texinfo
===================================================================
RCS file: /cvs/src/src/gas/doc/as.texinfo,v
retrieving revision 1.157
diff -u -r1.157 as.texinfo
--- gas/doc/as.texinfo 20 Feb 2007 13:28:52 -0000 1.157
+++ gas/doc/as.texinfo 2 Mar 2007 21:04:48 -0000
@@ -1,6 +1,6 @@
\input texinfo @c -*-Texinfo-*-
@c Copyright 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
-@c 2001, 2002, 2003, 2004, 2005, 2006
+@c 2001, 2002, 2003, 2004, 2005, 2006, 2007
@c Free Software Foundation, Inc.
@c UPDATE!! On future updates--
@c (1) check for new machine-dep cmdline options in
@@ -100,7 +100,8 @@
This file documents the GNU Assembler "@value{AS}".
@c man begin COPYRIGHT
-Copyright (C) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002, 2006 Free Software Foundation, Inc.
+Copyright (C) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002,
+2006, 2007 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1
@@ -153,7 +154,8 @@
@end tex
@vskip 0pt plus 1filll
-Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002, 2006 Free Software Foundation, Inc.
+Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002,
+2006, 2007 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1
@@ -6634,8 +6636,10 @@
individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
distribution.
+@ifset BUGURL
In any event, we also recommend that you send bug reports for @command{@value{AS}}
-to @samp{bug-binutils@@gnu.org}.
+to @value{BUGURL}.
+@end ifset
The fundamental principle of reporting bugs usefully is this:
@strong{report all the facts}. If you are not sure whether to state a
Index: ld/Makefile.am
===================================================================
RCS file: /cvs/src/src/ld/Makefile.am,v
retrieving revision 1.232
diff -u -r1.232 Makefile.am
--- ld/Makefile.am 28 Feb 2007 10:53:19 -0000 1.232
+++ ld/Makefile.am 2 Mar 2007 21:04:49 -0000
@@ -1771,6 +1771,9 @@
rm -f $@
eval `grep '^ *VERSION=' $(srcdir)/../bfd/configure`; \
echo "@set VERSION $$VERSION" > $@
+ if [ -n "$(REPORT_BUGS_TEXI)" ]; then \
+ echo "@set BUGURL $(REPORT_BUGS_TEXI)" >> $@; \
+ fi
# Build the man page from the texinfo file
# The sed command removes the no-adjust Nroff command so that
Index: ld/configure.in
===================================================================
RCS file: /cvs/src/src/ld/configure.in,v
retrieving revision 1.44
diff -u -r1.44 configure.in
--- ld/configure.in 17 Feb 2007 13:33:57 -0000 1.44
+++ ld/configure.in 2 Mar 2007 21:04:50 -0000
@@ -72,12 +72,18 @@
[Direct users to URL to report a bug]),
[case "$withval" in
yes) AC_MSG_ERROR([bug URL not specified]) ;;
- no) REPORT_BUGS_TO="" ;;
- *) REPORT_BUGS_TO="<URL:$withval>" ;;
+ no) REPORT_BUGS_TO="";
+ REPORT_BUGS_TEXI=""
+ ;;
+ *) REPORT_BUGS_TO="<URL:$withval>"
+ REPORT_BUGS_TEXI="@uref{`echo $withval | sed 's/@/@@/g'`}"
+ ;;
esac],
REPORT_BUGS_TO="<URL:http://www.sourceware.org/bugzilla/>"
+ REPORT_BUGS_TEXI="@uref{http://www.sourceware.org/bugzilla/}";
)
AC_SUBST(REPORT_BUGS_TO)
+AC_SUBST(REPORT_BUGS_TEXI)
AM_BINUTILS_WARNINGS
Index: ld/ld.texinfo
===================================================================
RCS file: /cvs/src/src/ld/ld.texinfo,v
retrieving revision 1.184
diff -u -r1.184 ld.texinfo
--- ld/ld.texinfo 29 Jan 2007 16:28:40 -0000 1.184
+++ ld/ld.texinfo 2 Mar 2007 21:04:52 -0000
@@ -1,7 +1,7 @@
\input texinfo
@setfilename ld.info
@c Copyright 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
-@c 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
+@c 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
@syncodeindex ky cp
@c man begin INCLUDE
@include configdoc.texi
@@ -64,7 +64,7 @@
This file documents the @sc{gnu} linker LD version @value{VERSION}.
Copyright (C) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000,
-2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
+2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
@ignore
@@ -108,7 +108,7 @@
@vskip 0pt plus 1filll
@c man begin COPYRIGHT
Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001,
-2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
+2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1
@@ -6471,8 +6471,10 @@
individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
distribution.
+@ifset BUGURL
Otherwise, send bug reports for @command{ld} to
-@samp{bug-binutils@@gnu.org}.
+@value{BUGURL}.
+@end ifset
The fundamental principle of reporting bugs usefully is this:
@strong{report all the facts}. If you are not sure whether to state a
--
Joseph S. Myers
joseph@codesourcery.com