diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,49 @@ +Build and installation instructions +----------------------------------- + +Please don't think of these as canonical build instructions yet, as +this work is rather early along. Let me tell you what's working for +*me*, and hopefully this information will be enough to get you going. + + +Prerequisites +------------- + +Firstly, you'll need to have LLVM. I recommend installing LLVM +version 2.8 or later (from [llvm.org](http://llvm.org/releases/)), which is what +this package has been tested with. + +It's easy to install LLVM itself from source: + + cd llvm + ./configure --prefix=$SOMEWHERE + make + make install + +It's a good idea to have `$SOMEWHERE/bin` in your path. + +Installing from source on Windows requires MinGW. + + +Building +-------- + +This is a normal Haskell package, but needs a `configure` script to +configure some system-specific details of LLVM. + + cabal install --configure-option --with-llvm-prefix=$SOMEWHERE + +If you have LLVM installed in a fairly normal location (`/usr` or +`/usr/local`), you don't need the `--configure-option` bits. + + +Building examples +----------------- + +In the examples directory are a few example programs. There's a GNU +Makefile in there, so running `make` in that directory will build the +examples, as will `make examples` in the top-level directory. Doing +`make run` will build and run the examples. + +Note: On older versions of MacOS X you may see a lot of "atom sorting +error" warnings. They seem to be harmless. diff --git a/INSTALL.txt b/INSTALL.txt deleted file mode 100644 --- a/INSTALL.txt +++ /dev/null @@ -1,58 +0,0 @@ -Build and installation instructions ------------------------------------ - -Please don't think of these as canonical build instructions yet, as -this work is rather early along. Let me tell you what's working for -*me*, and hopefully this information will be enough to get you going. - - -Prerequisites -------------- - -Firstly, you'll need to have LLVM. I recommend installing LLVM -version 2.6 (from llvm.org) which is what it's been tested with. - -Install from source.: -Build this and install it somewhere. Follow the LLVM instructions, -or use this: - - cd llvm - ./configure --prefix=$SOMEWHERE - make - make install - -It's a good idea to have $SOMEWHERE/bin is in your path. - -Installing from source on Windows requires MinGW. - - -Building --------- -It's normal cabal package, but using a configure script as well to -configure LLVM. Do A or B. - -A) If you have cabal-install just do - cabal install --configure-option --with-llvm-prefix=$SOMEWHERE - -B) If you don't have cabal-install: - -Configure the package. - runhaskell Setup configure --configure-option --with-llvm-prefix=$SOMEWHERE - -Build. - runhaskell Setup build - -Install. - runhaskell Setup install - - -Building examples ------------------ - -In the examples directory are a few example programs. There's a GNU -Make Makefile in there, so running "make" in that directory will build -the examples, as will "make examples" in the top-level directory. -Doing "make run" will build and run the examples. - -Note: On MacOS X you get a lot of "atom sorting error" warnings. They -seem to be harmless. diff --git a/Makefile b/Makefile --- a/Makefile +++ b/Makefile @@ -34,6 +34,11 @@ tests: $(MAKE) -C tests +html: INSTALL.html PROBLEMS.html README.html + +%.html: %.md + pandoc -s -o $@ $< + doc haddock: dist/setup-config ./setup haddock diff --git a/PROBLEMS.md b/PROBLEMS.md new file mode 100644 --- /dev/null +++ b/PROBLEMS.md @@ -0,0 +1,20 @@ +Known problems +-------------- + +If you have solutions to any of the problems listed below, please let +me know, or better yet, send a patch. Thanks! + + +Can't use LLVM bindings from ghci +--------------------------------- + +When I try to use the LLVM bindings in `ghci`, on Linux, loading the +bindings succeeds, but trying to do anything fails: + + $ ghci + Prelude> :m +LLVM.Core + Prelude LLVM.Core> m <- createModule "foo" + can't load .so/.DLL for: stdc++ (libstdc++.so: cannot open shared + object file: No such file or directory) + +I don't know why this happens, but it looks like a `ghci` bug. diff --git a/PROBLEMS.txt b/PROBLEMS.txt deleted file mode 100644 --- a/PROBLEMS.txt +++ /dev/null @@ -1,20 +0,0 @@ -Known problems --------------- - -If you have solutions to any of the problems listed below, please let -me know, or better yet, send a patch. Thanks! - - -Can't use LLVM bindings from ghci ---------------------------------- - -When I try to use the LLVM bindings in ghci, on Linux, loading the -bindings succeeds, but trying to do anything fails: - - $ ghci - Prelude> :m +LLVM.Core - Prelude LLVM.Core> m <- createModule "foo" - can't load .so/.DLL for: stdc++ (libstdc++.so: cannot open shared - object file: No such file or directory) - -I don't know why this happens, but it looks like a ghci bug. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +Haskell LLVM bindings +--------------------- + +This package provides Haskell bindings for the popular +[LLVM](http://llvm.org/) compiler infrastructure project. + + +Configuration +------------- + +By default, when you run `cabal install`, the Haskell bindings will be +configured to look for LLVM in `/usr/local`. + +If you have LLVM installed in a different location, e.g. `/usr`, you +can tell the `configure` script where to find it as follows: + + cabal install --configure-option=--with-llvm-prefix=/usr + + +Package status - what to expect +------------------------------- + +This package is still under development. + +The high level bindings are currently incomplete, so there are some +limits on what you can do. Adding new functions is generally easy, +though, so don't be afraid to get your hands dirty. + +The high level interface is mostly safe, but the type system cannot +protect against everything that can go wrong, so take care. And, of +course, there's no way to guarantee anything about the generated code. + + +Jump in and help! +----------------- + +We welcome your comments and contributions. You can send email to us +at or . If you want to +send patches, please clone a copy of the +[git repository](https://github.com/bos/llvm): + + git clone git://github.com/bos/llvm + +Thanks! diff --git a/README.txt b/README.txt deleted file mode 100644 --- a/README.txt +++ /dev/null @@ -1,50 +0,0 @@ -Haskell LLVM bindings ---------------------- - -This package provides Haskell bindings for the popular LLVM compiler -infrastructure project. If you don't know what LLVM is, the main LLVM -home page is here: - - http://llvm.org/ - - -Configuration -------------- - -By default, when you run "cabal install" or "runghc Setup configure", -the Haskell bindings will be configured to install to /usr/local. The -configure script will look for your LLVM installation in that same -directory. - -If you have LLVM installed in a different location, e.g. /usr, you can -tell the configure script where to find it as follows: - - cabal install --configure-option=--with-llvm-prefix=/usr - - runghc Setup configure --configure-option=--with-llvm-prefix=/usr - - -Package status - what to expect -------------------------------- - -This package is still under development. - -The high level bindings are currently incomplete, so there are some -limits on what you can do. Adding new functions is generally easy, -though, so don't be afraid to get your hands dirty. - -The high level interface is mostly safe, but the type system cannot -protect against everything that can go wrong, so take care. And, of -course, there's no way to guarantee anything about the generated code. - - -Jump in and help! ------------------ - -We welcome your comments and contributions. You can send email to us -at or . If you want to -send patches, please get a copy of the darcs repository: - - darcs get http://code.haskell.org/llvm/ - -Thanks! diff --git a/llvm.cabal b/llvm.cabal --- a/llvm.cabal +++ b/llvm.cabal @@ -1,5 +1,5 @@ name: llvm -version: 0.9.1.1 +version: 0.9.1.2 license: BSD3 license-file: LICENSE synopsis: Bindings to the LLVM compiler toolkit. @@ -25,19 +25,19 @@ * New in 0.7.0.0: Adapted to LLVM 2.6; author: Bryan O'Sullivan, Lennart Augustsson maintainer: Bryan O'Sullivan , Lennart Augustsson -bug-reports: Lennart Augustsson -homepage: http://code.haskell.org/llvm/ +homepage: https://github.com/bos/llvm +bug-reports: https://github.com/bos/llvm/issues stability: experimental category: Compilers/Interpreters, Code Generation -tested-with: GHC == 6.10.4, GHC == 6.12.3 +tested-with: GHC == 6.10.4, GHC == 6.12.3, GHC == 7.0.3 cabal-version: >= 1.10 build-type: Custom extra-source-files: - INSTALL.txt + INSTALL.md Makefile - PROBLEMS.txt - README.txt + PROBLEMS.md + README.md configure configure.ac examples/Align.hs @@ -137,5 +137,9 @@ cbits/free.c source-repository head - type: darcs - location: http://code.haskell.org/llvm/ + type: git + location: https://github.com/bos/llvm/ + +source-repository head + type: mercurial + location: https://github.com/bos/llvm/