This commit makes haddock-project handle sublibraries.

The commit changes how `cabal haddock` works, changing the layout
in the `dist-newstyle` folder.  With this change `haddock` subcommand
will install `package:sublib` component in a directory `package-sublib`
under `l/sublib/doc/html/`.

Matthew Pickering authored 1 year ago and Rodrigo Mesquita committed 11 months ago

This makes `withShorterPathForNewBuildStore` fit more nicely into the
rest of the testing infrastructure.

* Move `withShorterPathForNewBuildStore` to `TestM` monad
* Move responsibility for passing `--store-dir` to `cabalGArgs` function
* Move `findDependencyInStore` into `TestM`, and remove requirement to
  pass path to store directory.
* Introduce `testStoreDir` function which returns the store location
  (and honours `withShorterPathForNewBuildStore`)
* Migrate tests which use `withShorterPathForNewBuildStore`.

This patch makes `haddock-project` use `--local` option by default.
Since its the default, it is removed. Also `--gen-index`,
`--gen-contents`, `--hyperlinked-source` and `--quickjump` are removed
since they are always turned on.

Added a haddock-project test.

Also adds ellipsis to lines in *.out files.

- -XTypeInType is deprecated
- skip failing JS test on Windows
  Cf. https://github.com/haskell/cabal/pull/8754#issuecomment-1435535763
- deal with lift2A in Prelude since base-4.18 (GHC 9.6)
- disable everfailing Backpack tests

Failures are tracked in issues
  https://github.com/haskell/cabal/issues/7610
  https://github.com/haskell/cabal/issues/7987
  https://github.com/haskell/cabal/issues/7989
  https://github.com/haskell/cabal/issues/8028
  https://github.com/haskell/cabal/issues/8032

I introduced TestCode which allows to report more status information
than bare ExitCode.

This looks like an accident from a6e427ac
It causes cases like this to fail:

$ cat foo.c
int foo() { return 42; }
$ cat Lib.hs
module Lib where

foreign import ccall "foo" foo :: Int

bar = foo
$ cat cabal-csrc-repl.cabal
cabal-version:      2.4
name:               cabal-csrc-repl
version:            0.1.0.0
library
    exposed-modules:  Lib
    build-depends:    base ^>=4.14.0.0
    C-sources:        foo.c
    default-language: Haskell2010
$ cabal v2-repl
Resolving dependencies...
Build profile: -w ghc-8.10.1 -O1
In order, the following will be built (use -v for more details):
 - cabal-csrc-repl-0.1.0.0 (lib) (first run)
Configuring library for cabal-csrc-repl-0.1.0.0..
Preprocessing library for cabal-csrc-repl-0.1.0.0..
GHCi, version 8.10.1: https://www.haskell.org/ghc/  :? for help
[1 of 1] Compiling Lib              ( Lib.hs, interpreted )
Ok, one module loaded.
*Lib> foo
ghc: ^^ Could not load '_foo', dependency unresolved. See top entry above.

- We had to add gpdScannedVersion to permit solver to report
  about too new packages in the index.
  https://github.com/haskell/cabal/issues/6652
- It's hard to track what happening with Setup interface selection in
  ProjectPlanning.
  https://github.com/haskell/cabal/issues/6651 would help to
  make sense of it.

The cabal command interface will drift more and more from
./Setup interface. This is first step: don't assume
they are the same.

This removes need to "patch" setup commands to work with cabal:
the `act-as-setup` SHOULD behave as (simple) ./Setup

There were few setupAndCabalTests which weren't `build-type: Simple`.
For those I made a separate `cabal.test.hs`.

Also added a OutputNormalizer for global tmp directory.
`v2-build` sdists `build-type: Custom` packages to get the list of files
to watch. I guess it's ok to have that functionality,
yet it could be eventually removed, as `v2-sdist`
does not invoke `./Setup.hs` script.

* Restructure Includes3 tests so that I can also test Hackage case.

Signed-off-by: Edward Z. Yang <ezyang@mit.edu>

* Compute correct install directories for instantiated Backpack components

Previously, we would compute elabInstallDirs once when configuring a
component, and then reuse the exactly same install directories for
every instantiation of the package.  But this is wrong, since we're
installing the header/object files for each instantiation to a different
directory.  We refactor install directory computation into a helper
function and then call it again at instantiation time to refresh
the install directories.

For some reason, this bug ONLY manifests for packages installed from
Hackage; it seems install dirs are not respected for inplace packages.

Fixes #6005

Signed-off-by: Edward Z. Yang <ezyang@mit.edu>

* Test fix

Signed-off-by: Edward Z. Yang <ezyang@mit.edu>

* Copy backpack version-guard from other backpack testcases

Herbert Valerio Riedel authored 7 years ago and Oleg Grenrus committed 7 years ago

This provides a provisional (i.e. hacky) retrofitted implementation of
the forward-compat scheme described in #4899 for the cabal-2.2 branch

This hack works by constructing a dummy package description in case
the package description fails to be parsed via the standard parser,
and we detect a new-style cabal-spec declaration.

Signed-off-by: Edward Z. Yang <ezyang@cs.stanford.edu>

Edward Z. Yang authored 8 years ago and Edward Z. Yang committed 8 years ago

- We switched to using regex-tdfa, as regex-posix is buggy on Windows.

Signed-off-by: Edward Z. Yang <ezyang@cs.stanford.edu>

Edward Z. Yang authored 8 years ago and Edward Z. Yang committed 8 years ago

Signed-off-by: Edward Z. Yang <ezyang@cs.stanford.edu>

Signed-off-by: Edward Z. Yang <ezyang@cs.stanford.edu>

See cabal-testsuite/README.md for a detailed description
of the new architecture.

Signed-off-by: Edward Z. Yang <ezyang@cs.stanford.edu>

Edward Z. Yang authored 8 years ago and Edward Z. Yang committed 8 years ago

The key idea is that once we put PackageTests in its own package, we can
ensure that its Setup.hs is compiled with the same version of Cabal
library as package-tests is compiled with.  This means that LBI reading
will *always succeed* which is quite nice.

Signed-off-by: Edward Z. Yang <ezyang@cs.stanford.edu>