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

Move man/dhall.1 to data files #1921

Merged
merged 1 commit into from
Jul 14, 2020
Merged

Move man/dhall.1 to data files #1921

merged 1 commit into from
Jul 14, 2020

Conversation

vmchale
Copy link
Collaborator

@vmchale vmchale commented Jul 13, 2020

This means that after running cabal install dhall (from e.g. hackage) the manpage will be installed to share/.... This is what hlint does, for instance.

Copy link
Collaborator

@german1608 german1608 left a comment

Choose a reason for hiding this comment

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

👍

Copy link
Collaborator

@sjakobi sjakobi left a comment

Choose a reason for hiding this comment

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

Does Cabal offer any guidance on how to expose man pages or similar files? Are there any related tickets?

The documentation for data-files says

A list of files to be installed for run-time use by the package.

Since the man page is not used at run-time by the package, I wonder whether this might actually be an abuse of this feature…

@vmchale
Copy link
Collaborator Author

vmchale commented Jul 13, 2020

Well, it's common enough :p, see e.g. https://github.com/ndmitchell/hlint/blob/master/hlint.cabal#L23

@Gabriella439
Copy link
Collaborator

@sjakobi: My understanding is that this is an idiomatic use of data-files. The description for the option is misleading, but anything under data-files gets installed under a share directory, which plays a role analogous to /usr/local/share. So in other words, ./docs and ./man subdirectories are normal and expected underneath such a share directory.

Copy link
Collaborator

@sjakobi sjakobi left a comment

Choose a reason for hiding this comment

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

Thanks for the explanation! :)

@mergify mergify bot merged commit 9d932f5 into master Jul 14, 2020
@mergify mergify bot deleted the move-manpages branch July 14, 2020 08:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants