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.

Sign up for GitHub

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

Jump to bottom

broot: disable (impure) br shell function nag, install bash/zsh/fish files for the br function #95209

Merged
merged 2 commits into from Aug 13, 2020
Merged

broot: disable (impure) br shell function nag, install bash/zsh/fish files for the br function #95209

merged 2 commits into from Aug 13, 2020

Conversation

danieldk
Copy link
Contributor

Motivation for this change

I think it makes a lot of sense to disable the nag screen. I am not so sure whether we should also provide shell functions or let home-manager et al. do the work. At any rate:

  • In bash, the user needs to source br.sh somewhere.
  • In zsh, the user needs to autoload -Uz br somewhere.
  • In fish, br should just work.
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.

cc @rycee since home-manager has a broot module.

@danieldk danieldk requested a review from lilyball August 11, 2020 19:05
@lilyball
Copy link
Member

Thank you, I've been meaning to do something similar since Canop/broot#265 got resolved with the BR_INSTALL env var.

My open question was how to deal with bash/zsh. I wasn't sure if we should wrap broot for fish specifically to disable nagging even if the user runs broot directly but allow it to nag for bash/zsh, or what. It looks like you're just deferring to "the user has to handle zsh/bash themselves" which seems like probably the most reasonable solution in the absence of any direct shell support for this sort of thing.

@danieldk
broot: install bash/zsh/fish files for the br function
8770c22 
- In bash, the user needs to source `br.sh` somewhere.
- In zsh, the user needs to `autoload -Uz br` somewhere.
- In fish, `br` should just work.
@danieldk danieldk requested a review from lilyball August 12, 2020 06:08
lilyball
lilyball approved these changes Aug 12, 2020
View reviewed changes
Copy link
Member

@lilyball lilyball left a comment

Choose a reason for hiding this comment

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

LGTM

#95209
1 package built:
broot

@danieldk danieldk merged commit e269397 into NixOS:master Aug 13, 2020
@danieldk danieldk deleted the broot-dont-nag branch August 13, 2020 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lilyball lilyball lilyball approved these changes

Assignees
No one assigned
Labels
10.rebuild-darwin: 1-10 10.rebuild-darwin: 1 10.rebuild-linux: 1-10 10.rebuild-linux: 1 11.by: package-maintainer
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@danieldk @lilyball