-*- text -*-

Copyright 1998-2001, University of Notre Dame.
Authors: Jeffrey M. Squyres and Arun Rodrigues with Brian Barrett,
         Kinis L. Meyer, M. D. McNally, and Andrew Lumsdaine

This file is part of the Notre Dame LAM implementation of MPI.

You should have received a copy of the License Agreement for the Notre
Dame LAM implementation of MPI along with the software; see the file
LICENSE.  If not, contact Office of Research, University of Notre
Dame, Notre Dame, IN 46556.

Permission to modify the code and to distribute modified code is
granted, provided the text of this NOTICE is retained, a notice that
the code was modified is included with the above COPYRIGHT NOTICE and
with the COPYRIGHT NOTICE in the LICENSE file, and that the LICENSE
file is distributed with the modified code.

LICENSOR MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED.
By way of example, but not limitation, Licensor MAKES NO
REPRESENTATIONS OR WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY
PARTICULAR PURPOSE OR THAT THE USE OF THE LICENSED SOFTWARE COMPONENTS
OR DOCUMENTATION WILL NOT INFRINGE ANY PATENTS, COPYRIGHTS, TRADEMARKS
OR OTHER RIGHTS.

Additional copyrights may follow.


This tree includes all the necessary files for the different RPI's in
LAM/MPI.  The layout is not entirely self-explanaitory; this file is
meant to clear up any confusion.

Note that the LAM RPI is due to change in the not-too-distant future.
Changes will likely include capabilities for making LAM MT safe, MT
hot, and having [true] multiple devices compiled in LAM
simultaneously.  It is possible that the old RPI will be left intact
(i.e., the changes will consist of an entirely new API such that the
old API can be left for compatability-mode compiles), so that any
independantly-developed 3rd party RPIs will still function correctly,
but we're not making any promises to that effect.

Subdirectories:

- c2c   - contains files common to all C2C RPIs.
- lamd  - contains the LAMD RPI, and a helper function that is common
          to all RPIs, lamfault().  When there are more helper
          functions, they will likely warrant their own subdirectory.
- myri  - contains the Myrinet RPI (still under development).
- shmem - contains files common to the 2 shared memory RPIs.
- sysv  - contains the files specific to the sysv shared memory RPI.
          Compiling with this RPI also requires the contents of the
          shmem and tcp directories.
- tcp   - contains the files specific to the tcp RPI.  Taking
          advantage of Unix linker semantics, this can be combined
          with the shared memory RPIs to make the shared memory RPIs
          be TCP-aware as well.
- sysv  - contains the files specific to the usysv shared memory RPI.
          Compiling with this RPI also requires the contents of the
          shmem and tcp directories.

