home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / binutils-2.7-src.tgz / tar.out / fsf / binutils / gas / README < prev    next >
Text File  |  1996-09-28  |  11KB  |  293 lines
  1. -*- text -*-
  2.  
  3.         README for GAS
  4.       [cribbed largely from GDB's README file]
  5.  
  6. A number of things have changed since version 1 and the wonderful world of gas
  7. looks very different.  There's still a lot of irrelevant garbage lying around
  8. that will be cleaned up in time.  Documentation is scarce, as are logs of the
  9. changes made since the last gas release.  My apologies, and I'll try to get
  10. something useful.
  11.  
  12. Unpacking and Installation - Summary
  13. ====================================
  14.  
  15. See ../binutils/README.
  16.  
  17. To build just the assembler, make the target all-gas.
  18.  
  19. Documentation
  20. =============
  21.  
  22. The GAS release includes texinfo source for its manual, which can be processed
  23. into `info' or `dvi' forms.
  24.  
  25. The DVI form is suitable for printing or displaying; the commands for doing
  26. this vary from system to system.  On many systems, `lpr -d' will print a DVI
  27. file.  On others, you may need to run a program such as `dvips' to convert the
  28. DVI file into a form your system can print.
  29.  
  30. If you wish to build the DVI file, you will need to have TeX installed on your
  31. system.  You can rebuild it by typing:
  32.  
  33.     cd gas/doc
  34.     make as.dvi
  35.  
  36. The Info form is viewable with the GNU Emacs `info' subsystem, or the
  37. standalone `info' program, available as part of the GNU Texinfo distribution.
  38. To build the info files, you will need the `makeinfo' program.  Type:
  39.  
  40.     cd gas/doc
  41.     make info
  42.  
  43. Specifying names for hosts and targets
  44. ======================================
  45.  
  46.    The specifications used for hosts and targets in the `configure'
  47. script are based on a three-part naming scheme, but some short
  48. predefined aliases are also supported.  The full naming scheme encodes
  49. three pieces of information in the following pattern:
  50.  
  51.      ARCHITECTURE-VENDOR-OS
  52.  
  53.    For example, you can use the alias `sun4' as a HOST argument or in a
  54. `--target=TARGET' option.  The equivalent full name is
  55. `sparc-sun-sunos4'.
  56.  
  57.    The `configure' script accompanying GAS does not provide any query
  58. facility to list all supported host and target names or aliases. 
  59. `configure' calls the Bourne shell script `config.sub' to map
  60. abbreviations to full names; you can read the script, if you wish, or
  61. you can use it to test your guesses on abbreviations--for example:
  62.  
  63.      % sh config.sub sun4
  64.      sparc-sun-sunos411
  65.      % sh config.sub sun3
  66.      m68k-sun-sunos411
  67.      % sh config.sub decstation
  68.      mips-dec-ultrix42
  69.      % sh config.sub hp300bsd
  70.      m68k-hp-bsd
  71.      % sh config.sub i386v
  72.      i386-unknown-sysv
  73.      % sh config.sub i786v
  74.      Invalid configuration `i786v': machine `i786v' not recognized
  75.  
  76.  
  77. `configure' options
  78. ===================
  79.  
  80.    Here is a summary of the `configure' options and arguments that are
  81. most often useful for building GAS.  `configure' also has several other
  82. options not listed here.
  83.  
  84.      configure [--help]
  85.                [--prefix=DIR]
  86.                [--srcdir=PATH]
  87.                [--norecursion] [--rm]
  88.                [--target=TARGET] HOST
  89.                [--with-OPTION]
  90.                [--enable-OPTION]
  91.  
  92. You may introduce options with a single `-' rather than `--' if you
  93. prefer; but you may abbreviate option names if you use `--'.
  94.  
  95. `--help'
  96.      Display a quick summary of how to invoke `configure'.
  97.  
  98. `-prefix=DIR'
  99.      Configure the source to install programs and files under directory
  100.      `DIR'.
  101.  
  102. `--srcdir=PATH'
  103.      *Warning: using this option requires GNU `make', or another `make'
  104.      that implements the `VPATH' feature.*
  105.      Use this option to make configurations in directories separate
  106.      from the GAS source directories.  Among other things, you can use
  107.      this to build (or maintain) several configurations simultaneously,
  108.      in separate directories.  `configure' writes configuration
  109.      specific files in the current directory, but arranges for them to
  110.      use the source in the directory PATH.  `configure' will create
  111.      directories under the working directory in parallel to the source
  112.      directories below PATH.
  113.  
  114. `--norecursion'
  115.      Configure only the directory level where `configure' is executed;
  116.      do not propagate configuration to subdirectories.
  117.  
  118. `--target=TARGET'
  119.      Configure GAS for cross-assembling programs for the specified
  120.      TARGET.  Without this option, GAS is configured to assemble .o files
  121.      that run on the same machine (HOST) as GAS itself.
  122.  
  123.      There is no convenient way to generate a list of all available
  124.      targets.
  125.  
  126. `--enable-OPTION'
  127.      These flags tell the program or library being configured to 
  128.      configure itself differently from the default for the specified
  129.      host/target combination.  See below for a list of `--enable'
  130.      options recognized in the gas distribution.
  131.  
  132. `HOST ...'
  133.      Configure GAS to run on the specified HOST.
  134.  
  135.      There is no convenient way to generate a list of all available
  136.      hosts.
  137.  
  138. `configure' accepts other options, for compatibility with configuring
  139. other GNU tools recursively; but these are the only options that affect
  140. GAS or its supporting libraries.
  141.  
  142. The `--enable' options recognized by software in the gas distribution are:
  143.  
  144. `--enable-targets=...'
  145.      This causes one or more specified configurations to be added to those for
  146.      which BFD support is compiled.  Currently gas cannot use any format other
  147.      than its compiled-in default, so this option is not very useful.
  148.  
  149. `--enable-bfd-assembler'
  150.      This causes the assembler to use the new code being merged into it to use
  151.      BFD data structures internally, and use BFD for writing object files.
  152.      For most targets, this isn't supported yet.  For most targets where it has
  153.      been done, it's already the default.  So generally you won't need to use
  154.      this option.  See `BFD CONVERSION' in the file `gas/NOTES'.
  155.  
  156. Supported platforms
  157. ===================
  158.  
  159. At this point I believe gas to be ansi only code for most target cpu's.  That
  160. is, there should be relatively few, if any host system dependencies.  So
  161. porting (as a cross-assembler) to hosts not yet supported should be fairly
  162. easy.  Porting to a new target shouldn't be too tough if it's a variant of one
  163. already supported.
  164.  
  165. Native assembling should work on:
  166.  
  167.     sun3
  168.     sun4
  169.     386bsd
  170.     bsd/386
  171.     delta (m68k-sysv from Motorola)
  172.     delta88 (m88k-sysv from Motorola)
  173.     linux
  174.     m68k hpux 8.0 (hpux 7.0 may be a problem)
  175.     vax bsd, ultrix, vms
  176.     hp9000s300
  177.     decstation
  178.     iris
  179.     miniframe (m68k-sysv from Convergent Technologies)
  180.     i386-aix (ps/2)
  181.     hppa (hpux 4.3bsd, osf1)
  182.     rs6000
  183.     unixware
  184.     sco 3.2v4.2
  185.     sco openserver 5.0 (a.k.a. 3.2v5.0 )
  186.     sparc solaris 2.3
  187.  
  188. For cross-assemblers, I believe hosting to work on any of the machines listed
  189. above, plus:
  190.  
  191.     sun386i
  192.     at least some flavors of hpux (hpux 7.0 may be a problem)
  193.     most flavors of sysV
  194.  
  195. I believe that gas as a cross-assembler can currently be targetted for:
  196.  
  197.     386bsd
  198.     bsd/386
  199.     decstation-bsd (a.out format, to be used in BSD 4.4)
  200.     ebmon29k
  201.     go32 (DOS on i386, with DJGPP -- old a.out version)
  202.     h8/300, h8/500 (Hitachi)
  203.     hp9000/300
  204.     i386-aix (ps/2)
  205.     i960-coff
  206.     linux
  207.     mips ecoff (decstation-ultrix, iris, mips magnum, mips-idt-ecoff)
  208.     nindy960
  209.     powerpc
  210.     sco386
  211.     sun3
  212.     sun4
  213.     vax bsd or ultrix?
  214.     vms
  215.     vxworks68k
  216.     vxworks960
  217.     z8000 (Zilog)
  218.  
  219. MIPS ECOFF support has been added, but GAS will not run a C-style
  220. preprocessor.  If you want that, rename your file to have a ".S" suffix, and
  221. run gcc on it.  Or run "gcc -xassembler-with-cpp foo.s".
  222.  
  223. Support for ELF should work now for sparc, hppa, i386, alpha, m68k.
  224.  
  225. Support for ns32k, tahoe, i860, m88k may be suffering from bitrot.
  226.  
  227. If you try out gas on some host or target not listed above, please let me know
  228. the results, so I can update the list.
  229.  
  230. Compiler Support Hacks
  231. ======================
  232.  
  233. The assembler has been modified to support a feature that is potentially
  234. useful when assembling compiler output, but which may confuse assembly
  235. language programmers.  If assembler encounters a .word pseudo-op of the form
  236. symbol1-symbol2 (the difference of two symbols), and the difference of those
  237. two symbols will not fit in 16 bits, the assembler will create a branch around
  238. a long jump to symbol1, and insert this into the output directly before the
  239. next label: The .word will (instead of containing garbage, or giving an error
  240. message) contain (the address of the long jump)-symbol2.  This allows the
  241. assembler to assemble jump tables that jump to locations very far away into
  242. code that works properly.  If the next label is more than 32K away from the
  243. .word, you lose (silently); RMS claims this will never happen.  If the -K
  244. option is given, you will get a warning message when this happens.
  245.  
  246.  
  247. REPORTING BUGS IN GAS
  248. =====================
  249.  
  250. Bugs in gas should be reported to bug-gnu-utils@prep.ai.mit.edu.  They may be
  251. cross-posted to bug-gcc if they affect the use of gas with gcc.  They should
  252. not be reported just to bug-gcc, since I don't read that list, and therefore
  253. wouldn't see them.
  254.  
  255. If you report a bug in GAS, please remember to include:
  256.  
  257. A description of exactly what went wrong, and exactly what should have
  258. happened instead.
  259.  
  260. The type of machine (VAX, 68020, etc) and operating system (BSD, SunOS, DYNIX,
  261. VMS, etc) GAS was running on.
  262.  
  263. The configuration name(s) given to the "configure" script.  The
  264. "config.status" file should have this information.
  265.  
  266. The options given to GAS at run time.
  267.  
  268. The actual input file that caused the problem.
  269.  
  270. It is silly to report a bug in GAS without including an input file for GAS.
  271. Don't ask us to generate the file just because you made it from files you
  272. think we have access to.
  273.  
  274. 1. You might be mistaken.
  275. 2. It might take us a lot of time to install things to regenerate that file.
  276. 3. We might get a different file from the one you got, and might not see any
  277. bug.
  278.  
  279. To save us these delays and uncertainties, always send the input file for the
  280. program that failed.  A smaller test case that demonstrates the problem is of
  281. course preferable, but be sure it is a complete input file, and that it really
  282. does demonstrate the problem; but if paring it down would cause large delays
  283. in filing the bug report, don't bother.
  284.  
  285. If the input file is very large, and you are on the internet, you may want to
  286. make it avaliable for anonymous FTP instead of mailing it.  If you do, include
  287. instructions for FTP'ing it in your bug report.
  288.  
  289. If you expect to be contributing a large number of test cases, it would be
  290. helpful if you would look at the test suite included in the release (based on
  291. the Deja Gnu testing framework, available from the usual ftp sites) and write
  292. test cases to fit into that framework.  This is certainly not required.
  293.