diff options
| author | matoro <82706-matoro@users.noreply.gitlab.haskell.org> | 2022-09-19 10:32:58 -0400 |
|---|---|---|
| committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2022-09-20 13:13:06 -0400 |
| commit | ee9d0f5c5680ae033d701dfbd220c7938c7a2d51 (patch) | |
| tree | e5cb3d69b6c25c201b3a92c9db884667bf7dfd9d | |
| parent | 6a8c6b5ede0345bf0bb1b34d93fe7dc759b99bfd (diff) | |
| download | haskell-ee9d0f5c5680ae033d701dfbd220c7938c7a2d51.tar.gz | |
docs: clarify that LLVM codegen is not available in unregisterised mode
The current docs are misleading and suggest that it is possible to use
LLVM codegen from an unregisterised build. This is not the case;
attempting to pass `-fllvm` to an unregisterised build warns:
```
when making flags consistent: warning:
Target platform uses unregisterised ABI, so compiling via C
```
and uses the C codegen anyway.
| -rw-r--r-- | docs/users_guide/codegens.rst | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/docs/users_guide/codegens.rst b/docs/users_guide/codegens.rst index e9b696fe0e..993806b1a2 100644 --- a/docs/users_guide/codegens.rst +++ b/docs/users_guide/codegens.rst @@ -108,10 +108,9 @@ disabling some of the platform-specific tricks that GHC normally uses to make programs go faster. When compiling unregisterised, GHC simply generates a C file which is compiled via gcc. -When GHC is build in unregisterised mode only the LLVM and C code -generators will be available. The native code generator won't be. LLVM -usually offers a substantial performance benefit over the C backend in -unregisterised mode. +When GHC is built in unregisterised mode only the C code generator is +available. Neither the LLVM nor native code generator can be used by an +unregisterised build. Unregisterised compilation can be useful when porting GHC to a new machine, since it reduces the prerequisite tools to ``gcc``, ``as``, and |