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

ruby: install ri docs to devdoc output #61022

Merged
merged 3 commits into from May 8, 2019
Merged

Conversation

alyssais
Copy link
Member

@alyssais alyssais commented May 5, 2019

Motivation for this change

This allows getting access to Ruby documentation through ri by doing

nix-shell -p ruby ruby.devdoc

or by installing the ruby.devdoc package.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option 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 nix-review --run "nix-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Assured whether relevant documentation is up to date
  • Fits CONTRIBUTING.md.

Cc: @manveru

Even if building a Ruby with documentation, there's no reason for its
baseruby to waste time building its own documentation as well.
@alyssais alyssais changed the base branch from master to staging May 6, 2019 17:49
This allows getting access to Ruby documentation through ri by doing

    nix-shell -p ruby ruby.devdoc

or by installing the ruby.devdoc package.

A setup hook will add a shim to LOAD_PATH to point ri to the devdoc
output instead of out.
Now that RI docs are installed to a seperate output, we don't need to worry
about bloating the main output, so it's reasonable for this to be enabled by
default.
@alyssais
Copy link
Member Author

alyssais commented May 8, 2019

@manveru has tested this out and agrees with the approach — see discussion in #nixos-ruby.

@alyssais alyssais merged commit 6ea86b7 into NixOS:staging May 8, 2019
@alyssais alyssais deleted the ruby-devdoc branch May 8, 2019 12:18
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

1 participant