From cfb472f6725568fa673f951896d82c77932e56cd Mon Sep 17 00:00:00 2001 From: gareth Date: Sat, 28 Aug 2021 15:09:10 +1000 Subject: [PATCH 1/3] add comment suggested in issue 492 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 951084001..945fe426c 100644 --- a/README.md +++ b/README.md @@ -170,7 +170,7 @@ Alternatively, you can build using provided Makefiles: make -f Makefile.manual ``` -You can limit the maximum rank by setting ``-DMAXRANK=`` in the ``FYPPFLAGS`` environment variable: +You can limit the maximum rank by setting ``-DMAXRANK=`` in the ``FYPPFLAGS`` environment variable (which can reduce the compilation time): ```sh make -f Makefile.manual FYPPFLAGS=-DMAXRANK=4 From 43a3da15dc7757d6afb044d53d82facbf4ed6c71 Mon Sep 17 00:00:00 2001 From: gareth Date: Sat, 28 Aug 2021 15:13:30 +1000 Subject: [PATCH 2/3] make the default INSTALL_PREFIX clearer in the documentation --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 945fe426c..cf1ea75c6 100644 --- a/README.md +++ b/README.md @@ -125,7 +125,7 @@ You can pass additional options to CMake to customize the build. Important options are - `-G Ninja` to use the Ninja backend instead of the default Make backend. Other build backends are available with a similar syntax. -- `-DCMAKE_INSTALL_PREFIX` is used to provide the install location for the library. +- `-DCMAKE_INSTALL_PREFIX` is used to provide the install location for the library. If not provided, this defaults to `stdlib_install` in the `stdlib` directory. - `-DCMAKE_MAXIMUM_RANK` the maximum array rank procedures should be generated for. The default value is chosen as 4. The maximum is 15 for Fortran 2003 compliant compilers, otherwise 7 for compilers not supporting Fortran 2003 completely yet. @@ -153,7 +153,7 @@ cmake --build build --target test Please report failing tests on our [issue tracker](https://github.com/fortran-lang/stdlib/issues/new/choose) including details of the compiler used, the operating system and platform architecture. -To install the project to the declared prefix run +To install the project to the declared prefix (by default `stdlib_install` in the `stdlib` directory), run ```sh cmake --install build @@ -199,7 +199,7 @@ To make the installed stdlib project discoverable add the stdlib directory to th The usual install localtion of the package files is ``$PREFIX/lib/cmake/fortran_stdlib``. For non-CMake build systems (like make) you can use the exported pkg-config file by setting ``PKG_CONFIG_PATH`` to include the directory containing the exported pc-file. -The usual install location of the pc-file is ``$PREFIX/lib/pkgconfig``. +The usual install location of the pc-file is ``$PREFIX/lib/pkgconfig`` (by default, `stdlib_install/lib/pkgconfig` in the `stdlib` directory). In make you can obtain the required compile and link arguments with ```make From b22f2d183794c3176625bd670852b564fc514452 Mon Sep 17 00:00:00 2001 From: gareth Date: Sat, 28 Aug 2021 19:02:10 +1000 Subject: [PATCH 3/3] fix incorrect statement about default location --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cf1ea75c6..f75a2e24b 100644 --- a/README.md +++ b/README.md @@ -125,7 +125,7 @@ You can pass additional options to CMake to customize the build. Important options are - `-G Ninja` to use the Ninja backend instead of the default Make backend. Other build backends are available with a similar syntax. -- `-DCMAKE_INSTALL_PREFIX` is used to provide the install location for the library. If not provided, this defaults to `stdlib_install` in the `stdlib` directory. +- `-DCMAKE_INSTALL_PREFIX` is used to provide the install location for the library. If not provided the defaults will depend on your operating system, [see here](https://cmake.org/cmake/help/latest/variable/CMAKE_INSTALL_PREFIX.html). - `-DCMAKE_MAXIMUM_RANK` the maximum array rank procedures should be generated for. The default value is chosen as 4. The maximum is 15 for Fortran 2003 compliant compilers, otherwise 7 for compilers not supporting Fortran 2003 completely yet. @@ -153,7 +153,7 @@ cmake --build build --target test Please report failing tests on our [issue tracker](https://github.com/fortran-lang/stdlib/issues/new/choose) including details of the compiler used, the operating system and platform architecture. -To install the project to the declared prefix (by default `stdlib_install` in the `stdlib` directory), run +To install the project to the declared prefix run ```sh cmake --install build @@ -196,10 +196,10 @@ target_link_libraries( ``` To make the installed stdlib project discoverable add the stdlib directory to the ``CMAKE_PREFIX_PATH``. -The usual install localtion of the package files is ``$PREFIX/lib/cmake/fortran_stdlib``. +The usual install location of the package files is ``$PREFIX/lib/cmake/fortran_stdlib``. For non-CMake build systems (like make) you can use the exported pkg-config file by setting ``PKG_CONFIG_PATH`` to include the directory containing the exported pc-file. -The usual install location of the pc-file is ``$PREFIX/lib/pkgconfig`` (by default, `stdlib_install/lib/pkgconfig` in the `stdlib` directory). +The usual install location of the pc-file is ``$PREFIX/lib/pkgconfig``. In make you can obtain the required compile and link arguments with ```make