Giters

haskell / containers

Assorted concrete container types

Home Page:https://hackage.haskell.org/package/containers

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

`haddock-autolink` submodule: Licensing, inclusion

sidkshatriya opened this issue · comments

commented

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

commented

@m-renaud is definitely more qualified to answer this then I am, or probably anyone else. I know literally nothing about that submodule.

commented

For background: haddock-autolink is only used in the generation of the Markdown docs which live at https://haskell-containers.readthedocs.io/en/latest/ (but is also used by other doc sets outside of container).

To your questions: the code is very simple, so if desired could be inlined into containers, or hoisted to the haskell GitHub organization.

commented

@m-renaud It sounds like the most urgent matter is for you to add a suitable license for haddock-autolink. Would you be able to do that soon? Beyond that, I'm going to continue to hide under my rock and let you maintain that side of things.

commented

@treeowl sorry for the delay! PTAL at m-renaud/haddock-autolink#2 (BSD 3-Clause which to my understanding is compatible).

commented

@m-renaud What does PTAL mean? Can you submit a commit to get the license in the submodule?

commented

PTAL means "Please take another look" IIUC (if I understand correctly).

BTW the PR is not merged yet.