Commit Graph

44 Commits

Author SHA1 Message Date
Martin Kroeker 7d7757acd1
Update cross-compilation instructions for the Android NDK 2025-07-15 18:25:55 +02:00
Igor S. Gerasimov 46b0dfef8f Use links to issues 2025-06-21 11:35:02 +02:00
Igor S. Gerasimov 83efceb3cd Keep dgemm_snb_1thread.png in repo 2025-06-21 11:24:42 +02:00
Martin Kroeker 7a27e2b00d
Simplify build instructions for Windows on Arm 2025-01-26 18:36:58 +01:00
Matthew Brett 252c43265d Fix Windows on ARM build instructions
The command as merged uses the compiler target as the compiler path.

I have run and tested a build with this command.

@Mugundanmcw - is this correct?
2025-01-24 12:58:20 +00:00
Ralf Gommers f697cfe0d0 docs: improve the rendering of the HarmonyOS build instructions 2025-01-04 21:18:07 +01:00
Ralf Gommers eda80f436a docs: improve rendering of Windows on Arm instructions 2025-01-04 21:10:43 +01:00
Ralf Gommers 1833e68bee docs: improve rendering of "Runtime variables" page 2025-01-04 20:55:39 +01:00
Ralf Gommers c0bf48fbf3 docs: remove warning on the Build system page
Content is reviewed fairly carefully, and should be up to the
same standard as the rest of the docs now.
2025-01-04 20:42:10 +01:00
Ralf Gommers f764d76a4a docs: improve the Makefile dependency graph
Uses Mermaid to render it as a diagram in the html docs.
2025-01-04 20:42:05 +01:00
Ralf Gommers 5aa1845a43 docs: fix two broken links related to MSVC
The doc build is now clean of warnings again.
2025-01-04 20:37:47 +01:00
Ralf Gommers ed114150d1 docs: add the build variables for BLAS/LAPACK functionality 2025-01-04 20:37:47 +01:00
Ralf Gommers c526b10b68 docs: add library and symbol name build variables 2025-01-04 20:37:47 +01:00
Ralf Gommers d4addc0688 docs: improve description of library, data type and toolchain build variables 2025-01-04 20:37:47 +01:00
Ralf Gommers 970e48e9e5 docs: improve readability of the Build system page
This only fixes Markdown syntax, and adds a few headers to bring
some structure into the long list of variables that influence the
build. It does not add or remove variables.
2025-01-04 20:37:47 +01:00
Martin Kroeker b6c906f805
Add OPENBLAS_L2_SIZE and improve formatting 2025-01-04 13:02:35 +01:00
Martin Kroeker 33b9e5b143
Add a documentation page for the runtime variables 2025-01-03 23:32:34 +01:00
Martin Kroeker afd572511f
Add build instructions for Huawei's HarmonyOS from #5043 2025-01-03 22:47:38 +01:00
Martin Kroeker fff2e214ca
Add LAPACK-TEST errors topic 2024-12-30 23:05:17 +01:00
Ralf Gommers df42f79c4c docs: update extensions and install pages with last wiki edits
I went through the wiki pages and found two pages with edits that
weren't reflected in the html docs yet, so syncing that content here.
2024-12-26 21:10:32 +01:00
Martin Kroeker a93d3db34a
fix formatting of WoA section 2024-12-19 00:53:10 +01:00
Martin Kroeker e460512685
Update WoA build instructions from rewording in issue #5001 2024-12-19 00:50:37 +01:00
Martin Kroeker 009c1e0387
fix download link for the current WoA binary of LLVM 2024-11-23 14:15:04 +01:00
Martin Kroeker 760a5371f3
Update build instructions for WoA (use LLVM19 and its flang-new) 2024-11-22 15:59:45 +01:00
Martin Kroeker 7006492863
replace "Preview" in the MSVC vcvarsall path with "Community" 2024-07-26 12:49:57 +02:00
Ralf Gommers 268dcd8f45 docs: convert remaining install sections (Android, iOS, FreeBSD, Cortex-M) 2024-07-04 19:16:30 +02:00
Ralf Gommers 452014341e docs: rework building from source on Windows section 2024-07-04 19:16:30 +02:00
Ralf Gommers 4547908901 docs: rewrite "Install OpenBLAS" page (part 1: binaries, basic from source) 2024-07-04 19:15:51 +02:00
Ralf Gommers c1c0dbfd60 docs: address review comments on PR 4774 2024-07-02 14:05:47 +02:00
Ralf Gommers ca9a0c28e8 docs: improve extensions page 2024-06-30 18:04:12 +02:00
Ralf Gommers 3eba16c583 docs: improve the Developer manual 2024-06-30 18:04:08 +02:00
Ralf Gommers a8e1ff84ce docs: improve the "Build system" page 2024-06-30 16:27:54 +02:00
Ralf Gommers c1b9bb8519 docs: improvements to the User Manual 2024-06-30 16:18:24 +02:00
Ralf Gommers 237c2c4130 docs: fix footnote rendering on "Redistributing OpenBLAS" page 2024-06-30 16:09:00 +02:00
Ralf Gommers 3a8e72c0e6 docs: improve the "About" documentation page 2024-06-30 16:08:56 +02:00
Martin Kroeker a82ecadc11
mention LD_LIBRARY_PATH 2024-05-04 15:48:48 +02:00
cyk 95315f95d2
Update user_manual.md for static linker
when I use static link method to compile , result is undefined with pthread_create, so we should add -lpthread
2024-04-06 13:51:01 +08:00
Matthew Barber 45cbabcf58 Improve `index.md`
* Fix typo
* Improve platforms sentence
2024-03-20 11:19:51 +00:00
Matthew Barber 51a465a162 Mailing list doc updates 2024-03-20 11:13:21 +00:00
Matthew Barber 7a8b1d40a2 Address review comments
* Update backers link to OpenBLAS repo
* Remove reference to Bountysource
2024-03-20 11:13:21 +00:00
Matthew Barber 27841b8b44 More doc improvements
* Fold "Users of OpenBLAS", "Publications", "Mailing list", "Donation" pages into "About"
* Remove full license
* Remove outdated TODO and machine list pages
* Shorter titles for CI and distributing pages
* Link to GotoBLAS readme in repo
* Brief description of OpenBLAS in homepage
* Move acknowledgements into About page
* Remove manual TOC in FAQ docs
2024-03-20 11:13:21 +00:00
Matthew Barber 9cfcee131e Doc improvements squish
* Fix more broken links
* Move FAQ last
* Fold all install-y content into `install.md`
* Fix header levels
* Fold `download.md` contents into `install.md`
* Fix cross-references
* Ordered navigation
* Add logo to docs
* Make doc pages more consistent
2024-03-20 11:13:14 +00:00
Matthew Barber 2aee9a8a7d Move wiki contents to `docs/` 2024-03-14 08:45:49 +00:00
Ralf Gommers ee72575475 Add documentation on redistributing OpenBLAS
This touches on the following:

- build configurations
- naming of symbols, shared/static libraries and other build outputs
  like pkg-config and CMake files
- (in more detail) guidance on ILP64 builds

It tries to explain that, while this is only guidance and there may be
reasons to deviate from that, for some build options there are best
practices, and for some others there are choices to make.

It also links to a number of well-maintained build recipes in order
to help packagers of other distros make choices.

Closes gh-3798

[skip ci]
2023-07-26 23:37:28 +02:00