[Git][ghc/ghc][master] docs: clarify that LLVM codegen is not available in unregisterised mode

[Marge Bot (@marge-bot)]

Marge Bot pushed to branch master at Glasgow Haskell Compiler / GHC


Commits:
ee9d0f5c by matoro at 2022-09-20T13:13:06-04:00
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.

- - - - -


1 changed file:

- docs/users_guide/codegens.rst


Changes:

=====================================
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



View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/ee9d0f5c5680ae033d701dfbd220c7938c7a2d51

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/ee9d0f5c5680ae033d701dfbd220c7938c7a2d51
You're receiving this email because of your account on gitlab.haskell.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-commits/attachments/20220920/d9793114/attachment.html>