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

idris-modules: clarify usage of with-packages #32925

Closed
wants to merge 2 commits into from
Closed

idris-modules: clarify usage of with-packages #32925

wants to merge 2 commits into from

Conversation

samvher
Copy link

@samvher samvher commented Dec 21, 2017

Motivation for this change

It took me a really long time (almost a day) to figure out how to use this, being unfamiliar with the way idris uses packages and with limited experience with nix expressions. The usage turned out to be rather simple but it would help if it's spelled out more. Also, if I actually include prelude and base in the desired libraries I get an error so I think that remark can be removed.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option build-use-sandbox in nix.conf on non-NixOS)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Fits CONTRIBUTING.md.

It took me a really long time (almost a day) to figure out how to use this, being unfamiliar with the way idris uses packages and with limited experience with nix expressions. The usage turned out to be rather simple but it would help if it's spelled out more. Also, if I actually include prelude and base in the desired libraries I get an error so I think that remark can be removed.
$ nix-shell -p "idrisPackages.with-packages [ idrisPackages.lightyear ]"

Note that you still have to explicitly make the packages available to
Copy link
Member

Choose a reason for hiding this comment

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

try not to write "you"

@samvher
Copy link
Author

samvher commented Dec 21, 2017

I changed the text to not use "you".

@mpickering
Copy link
Contributor

Looks good to me.

@infinisil
Copy link
Member

Needs to be updated, the docs have moved, and some stuff has changed

@infinisil
Copy link
Member

Superseded by #50182

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants