Merge pull request #327 from PRUNERS/release-v2.1

Release v2.1 into devel branch

documentation/release-notes.md

@@ -6,18 +6,86 @@
 
 Release note versions:
 
+- [v2.1.0](#v2.1.0) _(19 March 2020)_
 - [v2.0-beta.2](#v2.0-beta.2) _(10 April 2019)_
 - [v2.0-beta.1](#v2.0-beta.1) _(18 July 2018)_
 - [v2.0-alpha.3](#v2.0-alpha.3) _(29 January 2018)_
 - [v2.0-alpha.2](#v2.0-alpha.2) _(27 January 2018)_
 - [v2.0-alpha.1](#v2.0-alpha.1) _(25 September 2017)_
 - [v1.0.0](#v1.0.0) _(25 March 2017)_
 
+## v2.1.0
+
+_Released on 19 March 2020_
+
+FLiT is now very stable, so we can exit the beta releases.  Honestly, we kept it in the beta release not because the tool was unreliable, but rather because we were unsure if the interface would undergo breaking changes with design reworks.
+
+The interface has stabilized.  We may do small breaks of interface in the future, but so far nothing major until FLiT 3.0.
+
+**Highlights of Major Changes:**
+
+- Place items from `flit::fsutil` namespace into the `flit` namespace (breaking change)
+- MPI
+    - Add MPICH support
+    - Change MPI usage to be with a `main`-like function as subprocesses
+- `flit bisect`
+    - Bisect uses information from `flit-config.toml` if the given compiler matches one specified there.
+    - Improve speed of the generated `Makefile`
+    - Add `--compiler-type` flag
+    - Add `--ldflags`, `--add-ldflags`, and `--use-linker`
+- Autogenerated `Makefile`
+    - Use standard GNU Makefile variable names
+    - Brief colored output
+    - Source files can have any suffix (instead of just `.cpp`)
+    - Removed the automatic insertion of `--gcc-toolchain` and `--gxx-name` for the Clang and Intel compilers respectively -- user can now add this from `flit-config.toml` (documentation added on how to do this)
+    - Experimental support for a Ninja build file instead (through `flit experimental ninja`)
+    - Improve speed and responsiveness using more self-recursion
+    - Faster `make clean` by deleting output directories rather than all files
+    - Mitigate C++ standard library incompatibility by compiling FLiT source code into each test executable
+- `flit-config.toml`
+    - Add `fixed_compile_flags` and `fixed_link_flags` fields for each compiler specified in `flit-config.toml`
+- Return `std::vector` of `float`, `double`, `long double`, or `std::string` from tests.  Add a comparison function for each.
+- Add functions to FLiT's C++ interface (can be used in tests): `rsplit()`, `lsplit()`, `split()`, `trim()`, `rstrip()`, `lstrip()`, `strip()`, `basename()`, and `dirname()`
+- Bash-completion
+
+**All Issues Addressed:**
+
+- [#255](https://github.com/PRUNERS/FLiT/issues/255) (PR [#260](https://github.com/PRUNERS/FLiT/pull/260)): Added `--compiler-type` flag for `flit bisect`
+- [#222](https://github.com/PRUNERS/FLiT/issues/222) (PR [#264](https://github.com/PRUNERS/FLiT/pull/264)): Added MPICH support
+- [#253](https://github.com/PRUNERS/FLiT/issues/253) (PR [#266](https://github.com/PRUNERS/FLiT/pull/266)): Handle different file endings for source files
+- [#267](https://github.com/PRUNERS/FLiT/issues/267) (PR [#268](https://github.com/PRUNERS/FLiT/pull/268)): Makefile recursion on dry runs too
+- [#269](https://github.com/PRUNERS/FLiT/issues/269) (PR [#270](https://github.com/PRUNERS/FLiT/pull/270)): Faster `make clean` by deleting destination directories.  Also, reorganize destination directories.  Add a `make dirs` target.
+- [#49](https://github.com/PRUNERS/FLiT/issues/49) (PR [#271](https://github.com/PRUNERS/FLiT/pull/271)): Return `std::vector` of floating-point or of `std::string` from a test
+- [#273](https://github.com/PRUNERS/FLiT/issues/273) (PR [#274](https://github.com/PRUNERS/FLiT/pull/274)): Fix `flit bisect` when calling `main` as a subprocess
+- [#165](https://github.com/PRUNERS/FLiT/issues/165) (PR [#280](https://github.com/PRUNERS/FLiT/pull/280)): Fixed the SimpleCHull litmus test to not use relative paths
+- [#272](https://github.com/PRUNERS/FLiT/issues/272) (PR [#275](https://github.com/PRUNERS/FLiT/pull/275)): Add ability to call a `main`-like function from your test as a subprocess, with or without MPI
+- [#216](https://github.com/PRUNERS/FLiT/issues/216) (PR [#281](https://github.com/PRUNERS/FLiT/pull/281)): Use standard Makefile Variable names in autogenerated Makefiles
+- [#276](https://github.com/PRUNERS/FLiT/issues/276) (PR [#282](https://github.com/PRUNERS/FLiT/pull/282)): Brief colored output from Makefiles
+- [#283](https://github.com/PRUNERS/FLiT/issues/283) (PR [#284](https://github.com/PRUNERS/FLiT/pull/284)): Fix `--delete` flag behavior for `flit bisect`
+- [#289](https://github.com/PRUNERS/FLiT/issues/289) (PR [#290](https://github.com/PRUNERS/FLiT/pull/290)): Fix automated test for `flit bisect` involving templates
+- [#286](https://github.com/PRUNERS/FLiT/issues/286) (PR [#288](https://github.com/PRUNERS/FLiT/pull/288)): Add helper functions for `std::string` such as `flit::split()` and `flit::trim()`.  Remove `flit::fsutil` namespace
+- [#292](https://github.com/PRUNERS/FLiT/issues/292) (PR [#295](https://github.com/PRUNERS/FLiT/pull/295)): Add `DESTDIR` variable to FLiT's top-level `Makefile`
+- [#296](https://github.com/PRUNERS/FLiT/issues/296) (PR [#297](https://github.com/PRUNERS/FLiT/pull/297)): Fix `Makefile` color output for older systems and OSX
+- [#125](https://github.com/PRUNERS/FLiT/issues/125) (PR [#301](https://github.com/PRUNERS/FLiT/pull/301)): Add `fixed_compile_flags` and `fixed_link_flags` to the `compiler` section in `flit-config.toml`
+- [#302](https://github.com/PRUNERS/FLiT/issues/302) (PR [#303](https://github.com/PRUNERS/FLiT/pull/303)): Experimental support for Ninja build files instead of an autogenerated `Makefile`
+- [#293](https://github.com/PRUNERS/FLiT/issues/293) (PR [#304](https://github.com/PRUNERS/FLiT/pull/304)): Improve usage and testing of `mkstemp()` and `mkdtemp()`.  Add functions `strip()`, `basename()`, and `dirname()` to FLiT
+- [#307](https://github.com/PRUNERS/FLiT/issues/307) (PR [#309](https://github.com/PRUNERS/FLiT/pull/309)): Fix use of `fixed_compile_flags` and `fixed_link_flags` from `flit bisect`
+- [#310](https://github.com/PRUNERS/FLiT/issues/310) (PR [#311](https://github.com/PRUNERS/FLiT/pull/311)): Significantly improve responsiveness of autogenerated `Makefile`s by using more self-recursion
+- [#96](https://github.com/PRUNERS/FLiT/issues/96) (PR [#314](https://github.com/PRUNERS/FLiT/pull/314)): All flit functions in the `flit` namespace
+- [#227](https://github.com/PRUNERS/FLiT/issues/227) (PR [#315](https://github.com/PRUNERS/FLiT/pull/315)): Remove hostname from generated files
+- [#210](https://github.com/PRUNERS/FLiT/issues/210) (PR [#318](https://github.com/PRUNERS/FLiT/pull/318)): Mitigate C++ standard library incompatibility by compiling FLiT source code into each test executable
+- [#133](https://github.com/PRUNERS/FLiT/issues/133) (PR [#322](https://github.com/PRUNERS/FLiT/pull/322)): Create a good default `compare()` method that handles `NaN` and `inf` in a way that makes sense
+- [#316](https://github.com/PRUNERS/FLiT/issues/316) (PR [#324](https://github.com/PRUNERS/FLiT/pull/324)): Do not copy `Empty.cpp` when calling `flit init --litmus-tests`
+- [#320](https://github.com/PRUNERS/FLiT/issues/320) (PR [#321](https://github.com/PRUNERS/FLiT/pull/321)): Update the issue template on GitHub
+- [#121](https://github.com/PRUNERS/FLiT/issues/121) (PR [#319](https://github.com/PRUNERS/FLiT/pull/319)): Implement bash-completion for FLiT
+- [#308](https://github.com/PRUNERS/FLiT/issues/308) (PR [#325](https://github.com/PRUNERS/FLiT/pull/325)): Add `--ldflags`, `--add-ldflags`, and `--use-linker` to `flit bisect`
+
+
 ## v2.0-beta.2
 
 _Released on 10 April 2019_
 
-**Highlights of Major Changes**
+**Highlights of Major Changes:**
 
 - TravisCI continuous integration fixed and working
 - `flit bisect`

scripts/flitcli/config/version.txt

@@ -1 +1 @@
-v2.0-beta.2
+v2.1.0