Made more current
authorBruce Korb <korbb@gcc.gnu.org>
Mon, 29 Mar 1999 08:22:24 +0000 (08:22 +0000)
committerBruce Korb <korbb@gcc.gnu.org>
Mon, 29 Mar 1999 08:22:24 +0000 (08:22 +0000)
From-SVN: r26051

gcc/fixinc/README

index d061cd6..5481fbf 100644 (file)
@@ -1,13 +1,13 @@
 
 The fast-fixincludes system now, to the best of our collective belief,
 correctly implements exactly the same functionality as the previous
-fixincludes/fixinc.* shell scripts.  On most systems where many fixes
-are required, this is accomplished by putting most of the functionality
-into a binary executable.  On systems that had dedicated fixinc.* shell
-scripts, those scripts are still used by default until they can be
-converted.
+fixincludes and fixinc.* shell scripts.  On systems where many fixes
+are required, this is accomplished by putting most of the
+functionality into a binary executable.  On systems that had dedicated
+fixinc.* shell scripts, those scripts are still used by default until
+they can be converted.
 
-KNOWN PROBLEMS
+POSSIBLE PROBLEMS
 
 There may be some systems on which the fixinc binary program appears
 to be functional, but fails to work.  Current thinking is that this
@@ -16,32 +16,44 @@ systems.  If you are experiencing this problem, then copy the script
 ${src}/gcc/fixinc/inclhack.sh into ${builddir}/gcc/fixinc.sh and run
 make again.
 
-Oh, yes, please also report the problem with a description of
+And, *please* also report the problem with a description of
 the failure mode (symptoms) and the output from:
 
         egcs/config.guess
 
+to me:  Bruce Korb <fixincludes@autogen.freeservers.com>
+
 TO DO
 
 * fixincl needs to be converted to use gcc's system.h, libiberty, and
   other portability frameworks.
 
-* FIXME: XXX needs to have tests for file descriptors > 10 or 12 added
-  to detect/solve XXX.
-
-* 
-
 
+THEORY OF OPERATION
 
-THEORY OF OPS
+See also:  http://autogen.freeservers.com
 
-inclhack.def contains a list of potential fixes to be applied to the
-system headers.   This file is processed by autogen to make both a
-shell script and a binary to apply those fixes to your headers.
-If the binary cannot be built, the shell version will be used instead.
+The set of fixes required was distilled down to just the data required
+to specify what needed to happen for each fix.  Those data were edited
+into a new file named gcc/fixinc/inclhack.def.  A program called
+AutoGen (http://autogen.freeservers.com) uses these definitions to
+instantiate several different templates (gcc/fixinc/*.tpl) that then
+produces a fixincludes replacement shell script (inclhack.sh), a
+replacement binary program (fixincl.x) and a script to drive the
+binary fixincl.sh).
 
-If mkfixinc.sh determines that your system needs machine-specific
-fixes that have not yet been applied to inclhack.def, it will install
-and use the current fixinc.* for that system instead.
+If there is no special purpose script, then mkfixinc.sh will try to
+compile, link and test execute the binary version.  If it cannot be
+successfully built, the shell version will be used instead.  If
+mkfixinc.sh determines that your system needs machine-specific fixes
+that have not yet been applied to inclhack.def, it will install and
+use the current fixinc.* for that system instead.
 
+Usually, the mkfixinc.sh script will be able to detect when
+the binary is not runable.  If you do have problems, however,
+please see "POSSIBLE PROBLEMS" above.  Thank you.
 
+Regards,
+       Bruce <fixincludes@autogen.freeservers.com>
+       Robert <RobertLipe@usa.net>
+       Manfred <manfred@s-direktnet.de>
\ No newline at end of file