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

Conversation

@alyssais
Copy link
Member

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

@alyssais alyssais requested a review from zimbatm as a code owner May 5, 2019

@alyssais alyssais force-pushed the alyssais:ruby-devdoc branch from 608b844 to c2e6930 May 5, 2019

@ofborg ofborg bot added the 6.topic: ruby label May 6, 2019

@ofborg ofborg bot requested a review from vrthra May 6, 2019

ruby: disable docSupport for baseruby
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

@alyssais alyssais force-pushed the alyssais:ruby-devdoc branch from c2e6930 to 0e8df22 May 6, 2019

alyssais added some commits May 5, 2019

ruby: install ri docs to devdoc output
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.
ruby: enable docSupport by default
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 alyssais force-pushed the alyssais:ruby-devdoc branch from 0e8df22 to b34608d May 7, 2019

@alyssais

This comment has been minimized.

Copy link
Member Author

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

15 of 16 checks passed

ruby on x86_64-darwin Timed out, unknown build status
Details
Evaluation Performance Report Evaluator Performance Report
Details
grahamcofborg-eval ^.^!
Details
grahamcofborg-eval-check-maintainers matching changed paths to changed attrs...
Details
grahamcofborg-eval-check-meta config.nix: checkMeta = true
Details
grahamcofborg-eval-darwin nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./pkgs/top-level/release.nix -A darwin-tested
Details
grahamcofborg-eval-nixos nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./nixos/release-combined.nix -A tested
Details
grahamcofborg-eval-nixos-manual nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./nixos/release.nix -A manual
Details
grahamcofborg-eval-nixos-options nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./nixos/release.nix -A options
Details
grahamcofborg-eval-nixpkgs-manual nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./pkgs/top-level/release.nix -A manual
Details
grahamcofborg-eval-nixpkgs-tarball nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./pkgs/top-level/release.nix -A tarball
Details
grahamcofborg-eval-nixpkgs-unstable-jobset nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./pkgs/top-level/release.nix -A unstable
Details
grahamcofborg-eval-package-list nix-env -qa --json --file .
Details
grahamcofborg-eval-package-list-no-aliases nix-env -qa --json --file . --arg config { allowAliases = false; }
Details
ruby on aarch64-linux Success
Details
ruby on x86_64-linux Success
Details

@alyssais alyssais deleted the alyssais:ruby-devdoc branch May 8, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant
You can’t perform that action at this time.