Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

`haddock-autolink` submodule: Licensing, inclusion

Open
  • Is something wrong?
#891 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
18/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
git, haskell
Domain
build-system, tooling

Research direction

Start with the containers/.gitmodules entry for docs/_extensions/haddock-autolink and inspect the referenced repository at the pinned revision. Review its licensing and hosting relationship to containers and ghc, then seek a maintainer decision on whether licensing or dependency ownership needs to change; done requires an agreed resolution for the issue's two concerns.

Written by the indexing model from the issue text.

Description

While cloning the main ghc repository (using git clone https://gitlab.haskell.org/ghc/ghc.git --recurse-submodules) I noticed that the containers repository was being cloned. That's OK because the containers library is a submodule of the ghc repo.

However, I noticed that the haddock-autolink submodule of containers is also being cloned. This is because haddock-autolink is a submodule of the containers repo.

[submodule "containers/docs/_extensions/haddock-autolink"]
	path = containers/docs/_extensions/haddock-autolink
	url = https://github.com/m-renaud/haddock-autolink

( https://github.com/haskell/containers/blob/b216597c83755131aac0f335744e2f803eaa9399/.gitmodules )

Here is what I noticed:

  • The linked submodule https://github.com/m-renaud/haddock-autolink does not have a LICENSE (or equivalent) of any sort. Should containers require a license given that ghc uses containers which in turn uses haddock-autolink ?
  • All the submodules of ghc look to be hosted at https://gitlab.haskell.org/ghc/ . haddock-autolink seems to be a notable exception. Might it be a good idea to incorporate this submodule into the containers repo itself? (especially because it is a small one). Ideally all the source dependencies of ghc should be more firmly in its control so we don't need to worry about the long term availability/maintenance of the haddock-autolink repo which is under control of a different entity than ghc presumably.

Request maintainers of containers suggest if any of these two issues need to be addressed.

cc: @m-renaud

Dominant language
Haskell
Stars
355
Forks
194
Avg merge
2d 12h
Merged PRs (30d)
6

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from haskell/containers

All issues in haskell/containers

Similar issues

More Haskell issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.