This is the mail archive of the binutils@sourceware.org mailing list for the binutils project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

PATCH, libiberty: improve documentation


This patch is a subset of a patch posted by Manuel Lopez-Ibanez that
requires further changes before it can be committed:

  http://gcc.gnu.org/ml/gcc-patches/2009-08/msg00459.html

This subset is logically separate and obvious enough that I am going to
check it in to the gcc and src trees now.  I made the change suggested
by DJ to gather-docs in his review.

Ben

2009-11-25  Manuel Lopez-Ibanez  <manu@gcc.gnu.org>
	    Ben Elliston  <bje@au.ibm.com>

	* README: Mention changes to Makefile.in and functions.texi.
	* gather-docs: Mention 'make stamp-functions' in the header.

Index: README
===================================================================
--- README	(revision 154522)
+++ README	(working copy)
@@ -25,13 +25,14 @@ There are two sets of files:  Those that
 included in the library for all configurations, while those
 that are "optional" will be included in the library only if "needed."
 
-To add a new required file, edit Makefile to add the source file
+To add a new required file, edit Makefile.in to add the source file
 name to CFILES and the object file to REQUIRED_OFILES.
 
 To add a new optional file, it must provide a single function, and the
 name of the function must be the same as the name of the file.
 
-    * Add the source file name to CFILES.
+    * Add the source file name to CFILES in Makefile.in and the object
+      file to CONFIGURED_OFILES.
 
     * Add the function to name to the funcs shell variable in
       configure.ac.
@@ -48,6 +49,11 @@ name of the function must be the same as
       object file to LIBOBJS, and add the function name to the case
       controlling whether to define HAVE_func.
 
+Finally, in the build directory of libiberty, configure with
+"--enable-maintainer-mode", run "make maint-deps" to update
+Makefile.in, and run 'make stamp-functions' to regenerate
+functions.texi.
+
 The optional file you've added (e.g. getcwd.c) should compile and work
 on all hosts where it is needed.  It does not have to work or even
 compile on hosts where it is not needed.
Index: gather-docs
===================================================================
--- gather-docs	(revision 154522)
+++ gather-docs	(working copy)
@@ -110,7 +110,7 @@ print "Writing $outfile\n" if $verbose;
 print OUT "\@c Automatically generated from *.c and others (the comments before\n";
 print OUT "\@c each entry tell you which file and where in that file).  DO NOT EDIT!\n";
 print OUT "\@c Edit the *.c files, configure with --enable-maintainer-mode,\n";
-print OUT "\@c and let gather-docs build you a new copy.\n\n";
+print OUT "\@c run 'make stamp-functions' and gather-docs will build a new copy.\n\n";
 
 for $key (sort keys %name) {
     print OUT "\@c $src_file{$key}:$src_line{$key}\n";



Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]