Skip to content

Commit 4ed2780

Browse files
authoredSep 6, 2018
Merge pull request #847 from shefty/master
master: Document that master branch is frozen
2 parents 49d1363 + 1d65d85 commit 4ed2780

File tree

1 file changed

+3
-90
lines changed

1 file changed

+3
-90
lines changed
 

‎README.md

+3-90
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,6 @@
1-
[![Build Status](https://travis-ci.org/ofiwg/fabtests.svg?branch=master)](https://travis-ci.org/ofiwg/fabtests)
2-
[![fabtests Coverity scan suild status](https://scan.coverity.com/projects/ofiwg-fabtests/badge.svg)](https://scan.coverity.com/projects/ofiwg-fabtests)
3-
[![fabtests release version](https://img.shields.io/github/release/ofiwg/fabtests.svg)](https://github.com/ofiwg/fabtests/releases/latest)
4-
51
# fabtests
62

7-
Fabtests provides a set of examples that uses
8-
[libfabric](http://libfabric.org) -- a high-performance fabric
9-
software library.
10-
11-
## Notes
12-
13-
Note that the fabtests suite is released paired with a specific
14-
version of libfabric. For example, libfabric v1.4 and fabtests v1.4
15-
were released together.
16-
17-
Using these paired versions is the best way to test a given version of
18-
libfabric. Using version-mismatched libfabric/fabtests pairs may
19-
produce unexpected results.
20-
21-
## Building fabtests
22-
23-
Distribution tarballs are available from the Github
24-
[releases](https://github.com/ofiwg/fabtests/releases) tab.
25-
26-
If you are building Fabtests from a developer Git clone, you must
27-
first run the `autogen.sh` script. This will invoke the GNU Autotools
28-
to bootstrap Fabtests' configuration and build mechanisms. If you are
29-
building Fabtests from an official distribution tarball, there is no
30-
need to run `autogen.sh`; Fabtests distribution tarballs are already
31-
bootstrapped for you.
32-
33-
Fabtests relies on being able to find an installed version of
34-
Libfabric. In some cases, Libfabric may be in default compiler /
35-
linker search paths, and you don't need to tell Fabtests where to find
36-
it. In other cases, you may need to tell Fabtests where to find the
37-
installed Libfabric's header and library files using the
38-
`--with-libfabric=<directory>` option, described below.
39-
40-
### Configure options
41-
42-
The `configure` script has many built in options (see `./configure
43-
--help`). Some useful options are:
44-
45-
```
46-
--prefix=<directory>
47-
```
48-
49-
By default `make install` will place the files in the `/usr` tree.
50-
The `--prefix` option specifies that the Fabtests files should be
51-
installed into the tree specified by named `<directory>`. The
52-
executables will be located at `<directory>/bin`.
53-
54-
```
55-
--with-libfabric=<directory>
56-
```
57-
58-
Specify the directory where the Libfabric library and header files are
59-
located. This is necessary if Libfabric was installed in a location
60-
where the compiler and linker will not search by default. The
61-
Libfabric library will be searched for in `<directory>/lib`, and
62-
headers will be searched for in `<directory>/include`.
63-
64-
```
65-
--with-valgrind=<directory>
66-
```
67-
68-
Directory where valgrind is installed. If valgrind is found, then
69-
valgrind annotations are enabled. This may incur a performance
70-
penalty.
71-
72-
### Examples
73-
74-
Consider the following example:
75-
76-
```
77-
$ ./configure --with-libfabric=/opt/libfabric --prefix=/opt/fabtests && make -j 32 && sudo make install
78-
```
79-
80-
This will tell the Fabtests to look for Libfabric libraries in the
81-
`/opt/libfabric` tree, and to install the Fabtests in the
82-
`/opt/fabtests` tree.
83-
84-
Alternatively:
85-
86-
```
87-
$ ./configure --prefix=/opt/fabtests && make -j 32 && sudo make install
88-
```
3+
The fabtests master branch has been merged with the libfabric git repository.
4+
All fabtests changes that are not fixes being applied to a stable branch
5+
should be applied to https://github.com/ofiwg/libfabric.git
896

90-
Tells the Fabtests that it should be able to find the Libfabric header
91-
files and libraries in default compiler / linker search paths
92-
(configure will abort if it is not able to find them), and to install
93-
Fabtests in `/opt/fabtests`.

0 commit comments

Comments
 (0)
Please sign in to comment.