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

Document extra-packages a bit better and clean up related entries (closes #5448) #8535

Merged
merged 3 commits into from
Oct 16, 2022

Conversation

linearray
Copy link
Member

@linearray linearray commented Oct 15, 2022

Please review carefully, I have never used any of these and only documented them in the way it makes sense to me, which is not necessarily the correct one.

closes #5448


Please include the following checklist in your PR:

Please also shortly describe how you tested your change. Bonus points for added tests!

doc/nix-local-build.rst Outdated Show resolved Hide resolved
doc/nix-local-build.rst Outdated Show resolved Hide resolved
should be considered local packages.` (Not implemented)
Specifies a list of external packages from Hackage, which
should be considered local packages. The motivation for
:cfg-field:`extra-packages` is making libraries that are not
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this one possible motivation or the motivation?

Copy link
Member Author

Choose a reason for hiding this comment

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

Taken straight from the horse's mouth:
#3737 (comment)

I imagine there are other uses, but I don't know.

"A common use case" would be an alternative.

Copy link
Member Author

Choose a reason for hiding this comment

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

Just found #6952 and the related #7865 and it seems you can install extra executables with extra-packages too, but there are caveats. Not sure if it should go into the documentation, while those are unresolved.

Copy link
Collaborator

@ffaf1 ffaf1 left a comment

Choose a reason for hiding this comment

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

good job!

Copy link
Member

@jneira jneira left a comment

Choose a reason for hiding this comment

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

lgtm, thanks for improving docs

@linearray linearray merged commit 1d17627 into haskell:master Oct 16, 2022
@Mikolaj
Copy link
Member

Mikolaj commented Oct 19, 2022

@linearray: thanks a lot for the docs improvement. BTW, we normally use the merge_me label to merge PRs:

https://github.com/haskell/cabal/blob/master/CONTRIBUTING.md#github-pull-request-conventions

Please give it a try next time, it's pretty handy. :)

alexbiehl pushed a commit to alexbiehl/cabal that referenced this pull request Dec 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document extra-packages in user's guide
4 participants