diff options
| author | Daniel Gröber <dxld@darkboxed.org> | 2019-12-26 22:06:40 +0100 |
|---|---|---|
| committer | Daniel Gröber <dxld@darkboxed.org> | 2019-12-26 22:07:05 +0100 |
| commit | 861dfdeb5cc010e87d623ed949673f1637c8118e (patch) | |
| tree | 2c2e1e9509fcffe9941b07b9f2c627a92149e167 /cabal-helper.cabal | |
| parent | 5b6cefdbe03ebc4ec6451751fbaba72cab663766 (diff) | |
Tweak README and cabal description
Diffstat (limited to 'cabal-helper.cabal')
| -rw-r--r-- | cabal-helper.cabal | 26 |
1 files changed, 4 insertions, 22 deletions
diff --git a/cabal-helper.cabal b/cabal-helper.cabal index ef3b8a7..81c94f9 100644 --- a/cabal-helper.cabal +++ b/cabal-helper.cabal @@ -2,29 +2,11 @@ cabal-version: 2.2 name: cabal-helper version: 1.0.0.0 synopsis: - Simple interface to some of Cabal's configuration state, mainly used by ghc-mod + Give Haskell development tools access to Cabal project environment description: - Cabal's little helper provides access to build information gathered by - @cabal@ when configuring a project. Specifically we're interested in - retrieving enough information to bring up a compiler session, using the GHC - API, which is similar to running @cabal repl@ in a project. - . - While simple in principle this is complicated by the fact that the - information Cabal writes to disk is in an unstable format and only really - accessible through the Cabal API itself. - . - Since we do not want to bind the user of a development tool which utilises - this library to a specific version of Cabal we compile the code which - interfaces with the Cabal library's API on the user's machine, at runtime, - against whichever version of Cabal was used to write the on disk information - for a given project. - . - If this version of Cabal is not available on the users machine anymore, - which is fairly likely since cabal-install is usually linked statically, we - have support for compiling the Cabal library also. In this case the library - is installed into a private, isolated, package database in - @$XDG_CACHE_HOME/cabal-helper@ so as to not interfere with the user's - package database. + The purpose of the @cabal-helper@ library is to give Haskell development + tools access to the same environment which build tools such as @cabal@ and + @stack@ normally provide to the compiler. license: Apache-2.0 license-file: LICENSE author: Daniel Gröber <cabal-helper@dxld.at> |