Skip to content

Commit

Permalink
Fix typos.
Browse files Browse the repository at this point in the history
  • Loading branch information
tcojean committed Oct 20, 2019
1 parent 6e20872 commit c47a498
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 16 deletions.
8 changes: 4 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Changelog

This file may not always be up to date in particular for the unrealeased
This file may not always be up to date in particular for the unreleased
commits. For a comprehensive list, use the following command:
```bash
git log --first-parent
Expand All @@ -22,10 +22,10 @@ Supported systems and requirements:
+ Apple LLVM: 8.0+
+ CUDA module: CUDA 9.0+
+ Windows
+ MinGW and CygWin: gcc 5.3+, 6.3+, 7.3+, 8.1+
+ MinGW and Cygwin: gcc 5.3+, 6.3+, 7.3+, 8.1+
+ Microsoft Visual Studio: VS 2017 15.7+
+ CUDA module: CUDA 9.0+, Microsoft Visual Studio
+ OpenMP module: MinGW or CygWin.
+ OpenMP module: MinGW or Cygwin.


The current known issues can be found in the [known issues
Expand All @@ -38,7 +38,7 @@ page](https://github.com/ginkgo-project/ginkgo/wiki/Known-Issues).
algorithm ([#305](https://github.com/ginkgo-project/ginkgo/issues/305), [#315](https://github.com/ginkgo-project/ginkgo/issues/315), [#319](https://github.com/ginkgo-project/ginkgo/issues/319), [#324](https://github.com/ginkgo-project/ginkgo/issues/324))
+ New ILU preconditioner ([#348](https://github.com/ginkgo-project/ginkgo/issues/348), [#353](https://github.com/ginkgo-project/ginkgo/issues/353))
+ Windows MinGW and Cygwin support ([#347](https://github.com/ginkgo-project/ginkgo/issues/347))
+ Windows Visual studio support ([#351](https://github.com/ginkgo-project/ginkgo/issues/351))
+ Windows Visual Studio support ([#351](https://github.com/ginkgo-project/ginkgo/issues/351))
+ New example showing how to use ParILU as a preconditioner ([#358](https://github.com/ginkgo-project/ginkgo/issues/358))
+ New example on using loggers for debugging ([#360](https://github.com/ginkgo-project/ginkgo/issues/360))
+ Add two new 9pt and 27pt stencil examples ([#300](https://github.com/ginkgo-project/ginkgo/issues/300), [#306](https://github.com/ginkgo-project/ginkgo/issues/306))
Expand Down
21 changes: 11 additions & 10 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,14 @@ Ginkgo adds the following additional switches to control what is being built:

* `-DGINKGO_DEVEL_TOOLS={ON, OFF}` sets up the build system for development
(requires clang-format, will also download git-cmake-format),
default is `ON`
default is `ON`.
* `-DGINKGO_BUILD_TESTS={ON, OFF}` builds Ginkgo's tests
(will download googletest), default is `ON`
(will download googletest), default is `ON`.
* `-DGINKGO_BUILD_BENCHMARKS={ON, OFF}` builds Ginkgo's benchmarks
(will download gflags and rapidjson), default is `ON`
(will download gflags and rapidjson), default is `ON`.
* `-DGINKGO_BUILD_EXAMPLES={ON, OFF}` builds Ginkgo's examples, default is `ON`
* `-DGINKGO_BUILD_EXTLIB_EXAMPLE={ON, OFF}` builds the interfacing example with deal.II, default is `OFF`
* `-DGINKGO_BUILD_EXTLIB_EXAMPLE={ON, OFF}` builds the interfacing example
with deal.II, default is `OFF`.
* `-DGINKGO_BUILD_REFERENCE={ON, OFF}` build reference implementations of the
kernels, useful for testing, default is `ON`
* `-DGINKGO_BUILD_OMP={ON, OFF}` builds optimized OpenMP versions of the kernels,
Expand All @@ -42,21 +43,21 @@ Ginkgo adds the following additional switches to control what is being built:
CMake package registry. The default is `OFF`.
* `-DGINKGO_WITH_CLANG_TIDY={ON, OFF}` makes Ginkgo call `clang-tidy` to find
programming issues. The path can be manually controlled with the CMake
variable `-DGINKGO_CLANG_TIDY_PATH=<path>`.
variable `-DGINKGO_CLANG_TIDY_PATH=<path>`. The default is `OFF`.
* `-DGINKGO_WITH_IWYU={ON, OFF}` makes Ginkgo call `iwyu` to find include
issues. The path can be manually controlled with the CMake variable
`-DGINKGO_IWYU_PATH=<path>`.
`-DGINKGO_IWYU_PATH=<path>`. The default is `OFF`.
* `-DGINKGO_VERBOSE_LEVEL=integer` sets the verbosity of Ginkgo.
* `0` disables all output in the main libraries,
* `1` enables a few important messages related to unexpected behavior (default).
* `-DCMAKE_INSTALL_PREFIX=path` sets the installation path for `make install`.
The default value is usually something like `/usr/local`
The default value is usually something like `/usr/local`.
* `-DCMAKE_BUILD_TYPE=type` specifies which configuration will be used for
this build of Ginkgo. The default is `RELEASE`. Supported values are CMake's
standard build types such as `DEBUG` and `RELEASE` and the Ginkgo specific
`COVERAGE`, `ASAN` (AddressSanitizer) and `TSAN` (ThreadSanitizer) types.
* `-DBUILD_SHARED_LIBS={ON, OFF}` builds ginkgo as shared libraries (`OFF`)
or as dynamic libraries (`ON`), default is `ON`
or as dynamic libraries (`ON`), default is `ON`.
* `-DGINKGO_JACOBI_FULL_OPTIMIZATIONS={ON, OFF}` use all the optimizations
for the CUDA Jacobi algorithm. `OFF` by default. Setting this option to `ON`
may lead to very slow compile time (>20 minutes) for the
Expand Down Expand Up @@ -92,7 +93,7 @@ Ginkgo adds the following additional switches to control what is being built:
program, default is `windows_shared_library`.
* `-DGINKGO_CHECK_PATH={ON, OFF}` checks if the environment variable PATH is valid.
It is checked only when building shared libraries and executable program,
default is `ON`
default is `ON`.

For example, to build everything (in debug mode), use:

Expand Down Expand Up @@ -135,7 +136,7 @@ Information, see the [CMake documentation for
CMAKE_PREFIX_PATH](https://cmake.org/cmake/help/v3.9/variable/CMAKE_PREFIX_PATH.html)
for details.

To manually configure the paths Ginkgo relies on the [standard xSDK Installation
To manually configure the paths, Ginkgo relies on the [standard xSDK Installation
policies](https://xsdk.info/policies/) for all packages except `CAS` (as it is
neither a library nor a header, it cannot be expressed through the `TPL`
format):
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,10 @@ The prequirement needs to be verified
* _cmake 3.9+_
* C++11 compliant 64-bits compiler:
* _MinGW : gcc 5.3+, 6.3+, 7.3+, 8.1+_
* _CygWin : gcc 5.3+, 6.3+, 7.3+, 8.1+_
* _Cygwin : gcc 5.3+, 6.3+, 7.3+, 8.1+_
* _Microsoft Visual Studio : VS 2017 15.7+_

__NOTE:__ Need to add `--autocrlf=input` after `git clone` in _CygWin_.
__NOTE:__ Need to add `--autocrlf=input` after `git clone` in _Cygwin_.

The Ginkgo CUDA module has the following __additional__ requirements:

Expand Down

0 comments on commit c47a498

Please sign in to comment.