Skip to content

Commit d073702

Browse files
authored
Merge pull request #5661 from martin-frbg/update_readme_java
Fix leftover wiki links in the README and add java insights from issue #5109
2 parents 22fc689 + 1590d8b commit d073702

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -277,23 +277,29 @@ Please note that it is not possible to combine support for different architectur
277277
### Supported OS
278278

279279
- **GNU/Linux**
280-
- **MinGW or Visual Studio (CMake)/Windows**: Please read <https://github.com/xianyi/OpenBLAS/wiki/How-to-use-OpenBLAS-in-Microsoft-Visual-Studio>.
281-
- **Darwin/macOS/OSX/iOS**: Experimental. Although GotoBLAS2 already supports Darwin, we are not OSX/iOS experts.
280+
- **MinGW or Visual Studio (CMake)/Windows**: Please read <https://github.com/OpenMathLib/OpenBLAS/docs/nstall.md#visual-studio-native-windows-abi>.
281+
- **Darwin/macOS/OSX/iOS**: Already supported on PPC and x86 by the original GotoBLAS, now also on ARM64 but we are not OSX/iOS experts.
282282
- **FreeBSD**: Supported by the community. We don't actively test the library on this OS.
283283
- **OpenBSD**: Supported by the community. We don't actively test the library on this OS.
284284
- **NetBSD**: Supported by the community. We don't actively test the library on this OS.
285285
- **DragonFly BSD**: Supported by the community. We don't actively test the library on this OS.
286-
- **Android**: Supported by the community. Please read <https://github.com/xianyi/OpenBLAS/wiki/How-to-build-OpenBLAS-for-Android>.
287-
- **AIX**: Supported on PPC up to POWER10
286+
- **Android**: Supported by the community. Please read <https://github.com/OpenMathLib/OpenBLAS/docs/install.md#android>.
287+
- **AIX**: Supported on PPC up to POWER10 but testing is increasingly problematic due to lack of publicly available systems
288288
- **Haiku**: Supported by the community. We don't actively test the library on this OS.
289289
- **SunOS**: Supported by the community. We don't actively test the library on this OS.
290-
- **Cortex-M**: Supported by the community. Please read <https://github.com/xianyi/OpenBLAS/wiki/How-to-use-OpenBLAS-on-Cortex-M>.
290+
- **Cortex-M**: Supported by the community. Please read <https://github.com/OpenMathLib/OpenBLAS/docs/install.md#cortex-m>.
291291

292292
## Usage
293293

294294
Statically link with `libopenblas.a` or dynamically link with `-lopenblas` if OpenBLAS was
295295
compiled as a shared library.
296296

297+
### Considerations for using the library from Java
298+
299+
The default stack size of only 1MB may be too small, especially if you built OpenBLAS to support larger matrix sizes than provided for by the default settings. Use the -Xss option to request a larger stack size if you encounter problems.
300+
301+
When a Windows build of OpenBLAS was created using the MINGW gfortran (for the LAPACK parts), the java application may hang on startup due to a deadlock between the gfortran runtime library initialization and any pipes created by a Win11/SBT/Play Framework environment. Use -Djdk.console=jdk.internal.le to work around this.
302+
297303
### Setting the number of threads using environment variables
298304

299305
Environment variables are used to specify a maximum number of threads.

0 commit comments

Comments
 (0)