gcc/fixinc/README

   1
   2 The fast-fixincludes system now, to the best of our collective belief,
   3 correctly implements exactly the same functionality as the previous
   4 fixincludes and fixinc.* shell scripts.  On systems where many fixes
   5 are required, this is accomplished by putting most of the
   6 functionality into a binary executable.  On systems that had dedicated
   7 fixinc.* shell scripts, those scripts are still used by default until
   8 they can be converted.
   9
  10 POSSIBLE PROBLEMS
  11
  12 There may be some systems on which the fixinc binary program appears
  13 to be functional, but fails to work.  Current thinking is that this
  14 is due to some new process limitations (fork() calls) on those
  15 systems.  If you are experiencing this problem, then copy the script
  16 ${src}/gcc/fixinc/inclhack.sh into ${builddir}/gcc/fixinc.sh and run
  17 make again.
  18
  19 And, *please* also report the problem with a description of
  20 the failure mode (symptoms) and the output from:
  21
  22         egcs/config.guess
  23
  24 to me:  Bruce Korb <fixincludes@autogen.freeservers.com>
  25
  26 TO DO
  27
  28 * fixincl needs to be converted to use gcc's system.h, libiberty, and
  29   other portability frameworks.
  30
  31
  32 THEORY OF OPERATION
  33
  34 See also:  http://autogen.freeservers.com
  35
  36 The set of fixes required was distilled down to just the data required
  37 to specify what needed to happen for each fix.  Those data were edited
  38 into a new file named gcc/fixinc/inclhack.def.  A program called
  39 AutoGen (http://autogen.freeservers.com) uses these definitions to
  40 instantiate several different templates (gcc/fixinc/*.tpl) that then
  41 produces a fixincludes replacement shell script (inclhack.sh), a
  42 replacement binary program (fixincl.x) and a script to drive the
  43 binary fixincl.sh).
  44
  45 If there is no special purpose script, then mkfixinc.sh will try to
  46 compile, link and test execute the binary version.  If it cannot be
  47 successfully built, the shell version will be used instead.  If
  48 mkfixinc.sh determines that your system needs machine-specific fixes
  49 that have not yet been applied to inclhack.def, it will install and
  50 use the current fixinc.* for that system instead.
  51
  52 Usually, the mkfixinc.sh script will be able to detect when
  53 the binary is not runable.  If you do have problems, however,
  54 please see "POSSIBLE PROBLEMS" above.  Thank you.
  55
  56 Regards,
  57         Bruce <fixincludes@autogen.freeservers.com>
  58         Robert <RobertLipe@usa.net>
  59         Manfred <manfred@s-direktnet.de>