Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Cabal-described and cabal-install to doctests #9572

Merged
merged 4 commits into from
Dec 30, 2023

Conversation

philderbeast
Copy link
Collaborator

Fixes #8734.

Include the following checklist in your PR:

Copy link
Collaborator

@ulysses4ever ulysses4ever left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Terrific work, thank you!

@philderbeast
Copy link
Collaborator Author

Thanks for the quick review and approval, @ulysses4ever and @geekosaur.

@philderbeast
Copy link
Collaborator Author

Label merge+no rebase is necessary when the pull request is from an organisation.

@mergify mergify bot added the merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days label Dec 30, 2023
@mergify mergify bot merged commit 555b25a into haskell:master Dec 30, 2023
46 checks passed
@philderbeast
Copy link
Collaborator Author

@ulysses4ever I didn't remove this comment;

cabal/Makefile

Lines 90 to 92 in c32dcfa

# TODO: Cabal-described should be added here but its doctests currently broken, see:
# https://github.com/haskell/cabal/issues/8734
# Just as well, cabal-install(-solver) doctests (the target below) bitrotted and need some care.

I'll do that on #9565.

philderbeast added a commit to cabalism/cabal that referenced this pull request Jan 18, 2024
philderbeast added a commit to cabalism/cabal that referenced this pull request Jan 19, 2024
philderbeast added a commit to cabalism/cabal that referenced this pull request Feb 15, 2024
philderbeast added a commit to cabalism/cabal that referenced this pull request Feb 28, 2024
philderbeast added a commit to cabalism/cabal that referenced this pull request Mar 2, 2024
philderbeast added a commit to cabalism/cabal that referenced this pull request Mar 3, 2024
philderbeast added a commit to cabalism/cabal that referenced this pull request Mar 4, 2024
philderbeast added a commit to cabalism/cabal that referenced this pull request Mar 4, 2024
philderbeast added a commit to cabalism/cabal that referenced this pull request Mar 18, 2024
philderbeast added a commit to cabalism/cabal that referenced this pull request Mar 19, 2024
philderbeast added a commit to cabalism/cabal that referenced this pull request Mar 26, 2024
erikd pushed a commit to erikd/cabal that referenced this pull request Apr 22, 2024
mergify bot pushed a commit that referenced this pull request May 13, 2024
mergify bot added a commit that referenced this pull request May 13, 2024
* Import packages from project-cabal/pkgs

- Move constraints to project-cabal/constraints.config
- Remove duplicate package groups
- Groups coverage, doctest and validate are the same as the default group
- Remove duplicate validate-libonly package group
- Both validate and validate-libonly are the same
- Move Cabal & Cabal-syntax to pkgs/cabal.config
- Add install package group
- Add benchmarks package group
- Add tests package group
- Both default and libonly groups were the same set of packages that I renamed to tests
- Put install group before tests and benchmarks
- Don't repeat packages
- Add TODO and REVIEW comments on allow-newer exceptions
- Move latest.ghc configuration
- Put program-options first & separate imports
- Remove optional-packages
- Don't reiterate default value for tests and benchmarks
- Don't reiterate default value for optimization
- Add ghc-options.config
- Rename to ghc-latest.config
- Use -Werror in ghc-options.config
- Don't include ghc-options.config for doctest project
- Add project-config/pkgs.config
- Add project-config/pkgs.config importing all package groups
- Move Cabal-described to the cabal package group
- Remove cabal.project.buildinfo
- Have cabal.project.doctest import cabal.project
- Split integration tests into their own package group.
- Add back trailing newlines at EOF in projects
- Integration-tests.config needed for libonly
- Add a README for projects.

(cherry picked from commit 0876e18)

# Conflicts:
#	cabal.project.release

* Build all local packages with -Werror

- Satisfy -Wmissing-signatures in test-runtime-deps
- Satisfy -Wx-partial in HackageBenchmark
- Satisfy -Wunused-imports in QuickCheck.Instances.Cabal
- Use partial pattern for filtering in list comprehension
- Don't error on deprecated import

(cherry picked from commit 8453ee0)

* Add an intercepting cabal-testsuite/cabal.project

- Reduce duplication in test flag setup
- Avoid "New config" picking cabal's own project

Before this change, this was the test failure:

Unit Tests
  UnitTests.Distribution.Client.Configure
    Configure tests
      New config:                     FAIL
        Exception: project-cabal/pkgs/cabal.config: withBinaryFile: does not exist (No such file or directory)
        Use -p '/New config/' to rerun this test only.
      Replacement + new config:       OK
      Old + new config:               OK
      Old + new config, no appending: OK
      Old + new config, backup check: OK
      Local program options:          OK

1 out of 6 tests failed (0.02s)

(cherry picked from commit d336275)

* Remove dangling doctest TODO left over from #9572

(cherry picked from commit 619befd)

* Remove allow-newer exception for cryptohash-sha256:base

(cherry picked from commit ed5d404)

* Remove projects; weeder, doctest & libonly

* Remove cabal.project.libonly

It was only referenced once in a stale Makefile comment about doctests.

* Remove weeder

- remove weeder's configuration
- remove its recipe from Makefile
- remove its project

* Delete cabal.project.doctest

- Adding --ghc-options="-Wwarn" is sufficient to avoid the numerous <interactive> failures seen otherwise
- write-ghc-environment-files has a default of never

(cherry picked from commit 72be26b)

* Update cabal.project.release

---------

Co-authored-by: Phil de Joux <[email protected]>
Co-authored-by: Hécate <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days merge+no rebase
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doctests for Cabal-described and cabal-install fail
3 participants