Merge remote-tracking branch 'bitbucket/master'

Author: Tony Curtis

README.md

@@ -1,73 +1,36 @@
-This project is the Open Source Software Solutions (OSSS) OpenSHMEM
-Implementation on top of OpenUCX (UCX) and PMIx.
+![](./doc/doxygen/openshmemlogo.svg)
+
+---
 
-Links
-=====
+# OSSS-UCX
 
-* OpenSHMEM
-    * [http://www.openshmem.org/](http://www.openshmem.org/)
-* OpenUCX
-    * [http://www.openucx.org/](http://www.openucx.org/)
-* PMIx
-    * [https://pmix.github.io/pmix/](https://pmix.github.io/pmix/)
-* Open-MPI
-    * [http://www.open-mpi.org/](http://www.open-mpi.org/)
+This project is the Open Source Software Solutions (OSSS) OpenSHMEM
+Implementation on top of OpenUCX (UCX) and PMIx.
 
---
+## Our Community
 
-* Copyright (c) 2016 - 2018
-      * Stony Brook University
-* Copyright (c) 2015 - 2018
-      * Los Alamos National Security, LLC.
-* Copyright (c) 2017 - 2018
-      * Rice University.  Neither the name of Rice University nor the names
-        of its contributors may be used to endorse or promote products
-        derived from this software without specific prior written
-        permission.
-* Copyright (c) 2011 - 2016
-    * University of Houston System and UT-Battelle, LLC.
-* Copyright (c) 2009 - 2016
-    * Silicon Graphics International Corp.  SHMEM is copyrighted
-      by Silicon Graphics International Corp. (SGI) The OpenSHMEM API
-      (shmem) is released by Open Source Software Solutions, Inc., under an
-      agreement with Silicon Graphics International Corp. (SGI).
+* [Project Website](http://www.openshmem.org/)
+* [Github](http://www.github.com/openshmem-org/)
+* [Mailing List](http://openshmem.org/mailman/listinfo/openshmem-list)
 
-All rights reserved.
+## Software Architecture
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
+![](./doc/doxygen/osss-ucx.svg)
 
-* Redistributions of source code must retain the above copyright notice,
-  this list of conditions and the following disclaimers.
+## Download Links
 
-* Redistributions in binary form must reproduce the above copyright
-  notice, this list of conditions and the following disclaimer in the
-  documentation and/or other materials provided with the distribution.
+| Software | Link |
+| :------- | :--- |
+| OpenSHMEM | [https://github.com/openshmem-org/osss-ucx/](https://github.com/openshmem-org/osss-ucx/) |
+| OpenUCX   | [http://www.openucx.org/](http://www.openucx.org/) |
+| PMIx      | [https://pmix.github.io/pmix/](https://pmix.github.io/pmix/) |
+| Open-MPI  | [http://www.open-mpi.org/](http://www.open-mpi.org/) |
 
-* Neither the name of Stony Brook University nor the names of its
-  contributors may be used to endorse or promote products derived from
-  this software without specific prior written permission.
+## License
 
-    Neither the name of the University of Houston System, UT-Battelle,
-    LLC. nor the names of its contributors may be used to endorse or
-    promote products derived from this software without specific prior
-    written permission.
+See the [license file](./LICENSE).
 
-    Neither the name of Los Alamos National Security, LLC, Los
-    Alamos National Laboratory, LANL, the U.S. Government, nor the names
-    of its contributors may be used to endorse or promote products
-    derived from this software without specific prior written
-    permission.
+## Building and Running
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
-TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
-PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+* [Building](./doc/building.txt)
+* [Running](./doc/running.txt)

config/m4/confargs.m4

@@ -68,7 +68,7 @@ AM_CONDITIONAL([ENABLE_ALIGNED_ADDRESSES], [test "x$enable_aligned_addresses" =
 #
 AC_ARG_ENABLE([threads],
 	AS_HELP_STRING([--disable-threads],
-			[This implementation will support threading levels @<:@default=yes@:>@]))
+		       [Are threading levels supported? @<:@default=yes@:>@]))
 AS_IF([test "x$enable_threads" != "xno"],
 	[AC_DEFINE([ENABLE_THREADS], [1], [Enable threading support])
 	 AC_SUBST([ENABLE_THREADS], [1])],

config/m4/cxx.m4

@@ -15,7 +15,7 @@ fi
 
 AC_ARG_ENABLE([cxx],
 	AS_HELP_STRING([--disable-cxx],
-			[Support C++ compiler? @<:@default=yes@:>@]))
+			[Provide OpenSHMEM C++ compiler wrapper? @<:@default=yes@:>@]))
 
 AS_IF([test "x$cxx_happy" = "xyes" -a "x$enable_cxx" != "xno"],
 	[AC_DEFINE([ENABLE_CXX], [1], [Enable C++ compiler])

configure.ac

@@ -8,7 +8,7 @@ m4_define([pkg_major],      [1])
 m4_define([pkg_minor],      [0])
 m4_define([pkg_version],    [pkg_major.pkg_minor])
 m4_define([pkg_bugreport],  [anthony.curtis@stonybrook.edu])
-m4_define([pkg_url],        [https://bitbucket.org/sbuopenshmem/osss-ucx.git])
+m4_define([pkg_url],        [https://bitbucket.org/tony-curtis/osss-ucx.git])
 
 m4_define([spec_major_version],     [1])
 m4_define([spec_minor_version],     [4])
@@ -183,6 +183,7 @@ AC_CONFIG_FILES([
 	src/shmemc/Makefile
 	src/shmemc/osh_common
 	src/shmemu/Makefile
+	src/shmemt/Makefile
         ])
 
 AC_OUTPUT

doc/building.txt

@@ -1,97 +1,94 @@
 # For license: see LICENSE file at top-level
 
-Prerequisites
-=============
+# Prerequisites
 
-PMIx
-====
+## PMIx
 
 v1.2.x, or newer, release; or from github master:
 
-    PMIx      : https://github.com/pmix/pmix/
+[Get PMIx](https://github.com/pmix/pmix/)
 
-Sample author config
---------------------
+### Sample author config
 
-    .../configure --prefix=/path/to/install/pmix
+```sh
+$ .../configure --prefix=/path/to/install/pmix
+```
 
-UCX
-===
+## UCX
 
 Tested with all releases and from github master:
 
-    UCX       : https://github.com/openucx/ucx/
+[Get UCX](https://github.com/openucx/ucx/)
 
 If you want to build threading support, UCX should be installed with
+`--enable-mt`.
 
-    --enable-mt
-
-SHCOLL
-======
+## SHCOLL
 
 The OpenSHMEM Collectives Library.
 
 Tested with github master:
 
-    SHCOLL    : https://github.com/tonycurtis/OpenSHMEM-Collective-Routines
+[Get SHCOLL](https://github.com/tonycurtis/OpenSHMEM-Collective-Routines)
 
 SHCOLL is also bundled with the OSSS-UCX distribution to avoid
 requiring an external installation, and will be used by default.
 
-Sample author config
---------------------
+### Sample author config
 
-    .../configure \
+```sh
+.../configure \
         --prefix=/path/to/install/shcoll
+```
 
-OpenMPI
-=======
+## OpenMPI
 
 For PMIx-aware "mpiexec" launcher:
 
-    OpenMPI downloads : https://www.open-mpi.org/software/ompi/
+[Get OpenMPI](https://www.open-mpi.org/software/ompi/)
 
-Sample author config
---------------------
+### Sample author config
 
-    .../configure \
+```sh
+.../configure \
         --prefix=/path/to/install/openmpi \
         --with-knem \
         --with-ucx=/path/to/install/ucx \
         --with-tm
+```
 
-Combinations
-============
+## Combinations
 
 For all users, any version of UCX is fine.
 
 The interaction with most impact is that of PMIx and Open-MPI:
 
-  o For end-users, the most stable combinations are
-      o PMIx 1.2.5 and Open-MPI 2.1.3
-      o PMIx 2.1.1 and Open-MPI 3.1.0
-  o For developers, the github master versions throughout will track
-    all the latest updates.
+* For end-users, the most stable combinations are
+    * PMIx 1.2.5 and Open-MPI 2.1.3
+    * PMIx 2.1.1 and Open-MPI 3.1.0, 4.0.0
+* For developers, the github master versions throughout will track
+  all the latest updates.
 
 A PRRTE-based launcher is in development, but as PRRTE is in flux,
-this will not be documented here for now, see prrte.txt for more
-information.
+this will not be documented here for now, see [prrte.txt](./prrte.txt)
+for more information.
 
-Building Sequence
-=================
+## Building Sequence
 
-1. In the top-level source directory, run ./autogen.sh
+In the top-level source directory, run
 
-2. You can build this package either in-source-tree or
-   out-of-source-tree
+```sh
+./autogen.sh
+```
 
-3. configure script can be told where PMIx and UCX live, and other
-   options
+You can build this package either in-source-tree or
+out-of-source-tree.
 
-   Sample author config
-   --------------------
+The configure script can be told where PMIx and UCX live, and other
+options, e.g.
 
-   .../configure \
+ ```sh
+ .../configure \
        --prefix=/path/to/install/osss-ucx \
        --with-pmix=/path/to/install/pmix \
        --with-ucx=/path/to/install/ucx \
@@ -100,5 +97,9 @@ Building Sequence
        --enable-logging \
        --enable-threads
        --with-heap-size=8G
-   
-4. make install
+ ```
+Then
+
+```sh
+$ make install
+```