Convert README.clang to Markdown.

README.clang:
    As above.

    Add a .md extension.

README.md:
RELEASE_NOTES:
    Conform to the above change.
This commit is contained in:
Julien Fischer
2023-01-23 02:09:44 +11:00
parent 6dffe00611
commit c79966ea17
4 changed files with 24 additions and 18 deletions

View File

@@ -1,16 +0,0 @@
This file documents how to use clang as the C compiler with Mercury. Support
for Mercury with clang has been tested on Linux, Mac OS X and Windows. To use
clang as the C compiler for Mercury invoke Mercury's configure script with the
--with-cc option set as follows:
$ ./configure --with-cc=clang
Note that the asm_fast* and reg* grades are not usable with clang as they rely
on GNU C extensions that clang does not support.
Versions of LLVM (the underlying compiler infrastructure used by clang) before
about 2.9 contain bugs that require most C compiler optimizations to be
disabled when compiling Mercury generated C code with clang (i.e. the generated
C files have to be compiled at -O0). If you are using a more recent version of
LLVM then the configure script will automatically enable a higher level of
optimization.

22
README.clang.md Normal file
View File

@@ -0,0 +1,22 @@
Mercury with Clang
==================
This file documents how to use `clang` as the C compiler with Mercury.
Support for Mercury with `clang` has been tested on Linux, macOS and Windows.
To use `clang` as the C compiler for Mercury invoke Mercury's `configure`
script with the `--with-cc` option set as follows:
```
$ ./configure --with-cc=clang
```
Note that the `asm_fast*` and `reg*` grades are not usable with `clang` as they
rely on GNU C extensions that clang does not provide.
Versions of LLVM (the underlying compiler infrastructure used by `clang`) before
about version 2.9 contain bugs that require most C compiler optimizations to be
disabled when compiling Mercury generated C code with `clang` (i.e. the
generated C files have to be compiled at `-O0`). If you are using a more recent
version of LLVM then the `configure` script will automatically enable a higher
level of optimization.

View File

@@ -29,7 +29,7 @@ Specific information is contained in individual README files:
This backend works well with GCC but also works with:
* [Clang](README.clang)
* [Clang](README.clang.md)
* High-level backend targets

View File

@@ -162,7 +162,7 @@ later. Do not use gcc versions 2.96, 3.0 or 4.0; those versions have bugs that
cause trouble for Mercury. If you are using gcc, you will need at least
version 2.95 or higher, except on Mac OS X where you will need version 3.3 or
higher. Visual C++ or clang may also be used as a C compiler.
(See README.MS-VisualC.md and README.clang for further details.)
(See README.MS-VisualC.md and README.clang.md for further details.)
You will also need GNU make version 3.69 or higher.
The Mercury distribution contains: