Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
H
haddock
Manage
Activity
Members
Labels
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Model registry
Operate
Environments
Terraform modules
Analyze
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Jade
haddock
Commits
56af824c
Commit
56af824c
authored
3 years ago
by
Hécate Moonlight
Browse files
Options
Downloads
Patches
Plain Diff
Update the contribution guide
parent
118dd4ed
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
CONTRIBUTING.md
+3
-7
3 additions, 7 deletions
CONTRIBUTING.md
with
3 additions
and
7 deletions
CONTRIBUTING.md
+
3
−
7
View file @
56af824c
...
@@ -36,16 +36,13 @@ cd haddock
...
@@ -36,16 +36,13 @@ cd haddock
### Git Branches
### Git Branches
For improvements to the documentation generator,
Pull requests are to be opened against the
`main`
branch, from which are forked
please base your pull request on the latest GHC version branch
GHC-specific branches (like
`ghc-9.2`
,
`ghc-9.4`
, etc).
(
`ghc-9.2`
for instance).
### Building the packages
### Building the packages
#### Using `cabal`
#### Using `cabal`
Requires cabal
`>= 3.4`
and GHC
`== 9.2`
:
First update the package list:
First update the package list:
```
bash
```
bash
...
@@ -60,7 +57,7 @@ cabal v2-build all --enable-tests
...
@@ -60,7 +57,7 @@ cabal v2-build all --enable-tests
cabal v2-test all
cabal v2-test all
```
```
### Updating golden testsuite outputs
### Updating golden test
suite outputs
If you've changed Haddock's output, you will probably need to accept the new
If you've changed Haddock's output, you will probably need to accept the new
output of Haddock's golden test suites (
`html-test`
,
`latex-test`
,
output of Haddock's golden test suites (
`html-test`
,
`latex-test`
,
...
@@ -72,6 +69,5 @@ cabal v2-test html-test latex-test hoogle-test hypsrc-test \
...
@@ -72,6 +69,5 @@ cabal v2-test html-test latex-test hoogle-test hypsrc-test \
--test-option='--accept'
--test-option='--accept'
```
```
[
SSCCE
]:
http://sscce.org/
[
SSCCE
]:
http://sscce.org/
[
CoC
]:
./CODE_OF_CONDUCT.md
[
CoC
]:
./CODE_OF_CONDUCT.md
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment