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

Ignore haddocks #10734

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

philderbeast
Copy link
Collaborator

I tried the cabal haddock-project command. It dumped thousands of untracked files into the source tree for haskell/cabal. This PR ignores that folder.

$ tree haddocks
haddocks
├── array
│   ├── array.haddock
│   ├── array.txt
│   ├── Data-Array-Base.html
...
    ├── synopsis.png
    ├── transformers.haddock
    └── transformers.txt

67 directories, 3487 files

There's the --output[=DIRECTORY] option but haddocks is the default directory for the output.

$ cabal haddock-project --help
Generate Haddocks HTML documentation for the cabal project.

Usage: cabal haddock-project [FLAGS]
   or: cabal haddock-project COMPONENTS [FLAGS]

Flags for haddock-project:
...
 --output[=DIRECTORY]           Output directory
...

Template B: This PR does not modify behaviour or interface

E.g. the PR only touches documentation or tests, does refactorings, etc.

Include the following checklist in your PR:

  • Patches conform to the coding conventions.
  • Is this a PR that fixes CI? If so, it will need to be backported to older cabal release branches (ask maintainers for directions).

@mergify mergify bot added the ready and waiting Mergify is waiting out the cooldown period label Jan 9, 2025
@philderbeast
Copy link
Collaborator Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge+no rebase ready and waiting Mergify is waiting out the cooldown period
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants