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

shellcheck: add manpage and docs #81877

Merged
merged 1 commit into from Mar 6, 2020

Conversation

Profpatsch
Copy link
Member

@Profpatsch Profpatsch commented Mar 6, 2020

The shellcheck source code contains a manpage, so let’s add that to
the output. For good measure, also copy the README to the doc output.

The overrideMeta thing is taking care of setting the right position,
so that nix edit points to this file instead of to the original
haskellPackages definition.

Motivation for this change
Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • 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 nixpkgs-review --run "nixpkgs-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)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

The shellcheck source code contains a manpage, so let’s add that to
the output. For good measure, also copy the README to the doc output.

The overrideMeta thing is taking care of setting the right position,
so that `nix edit` points to this file instead of to the original
haskellPackages definition.
@Ma27 Ma27 merged commit b8d7d4f into NixOS:master Mar 6, 2020

installPhase = ''
install -Dm755 ${bin}/bin/shellcheck $bin/bin/shellcheck
install -Dm644 README.md $doc/share/shellcheck/README.md
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

Maybe, I don’t want to touch that tbh.

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

3 participants