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

iproute: Rename the attribute to iproute2 #103894

Merged
merged 1 commit into from Dec 7, 2020

Conversation

primeos
Copy link
Member

@primeos primeos commented Nov 15, 2020

This is done because the project is actually named iproute2:

Our package name already reflects that and for consistency the attribute
name should also be iproute2.

However, it is important to note that some distributions use "iproute"
(but that might be for technical reasons):

Motivation for this change

This has actually bothered me for a long time... Would be interested to know how others feel about it.

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.

This is done because the project is actually named iproute2:
- https://wiki.linuxfoundation.org/networking/iproute2
- https://git.kernel.org/pub/scm/network/iproute2/iproute2.git
- https://en.wikipedia.org/wiki/Iproute2

Our package name already reflects that and for consistency the attribute
name should also be iproute2.

However, it is important to note that some distributions use "iproute"
(but that might be for technical reasons):
- https://repology.org/project/iproute2/versions
Copy link
Contributor

@nh2 nh2 left a comment

Choose a reason for hiding this comment

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

Looks sensible to me.

Do you want people to use it already before the deprecation kicks in? Then a release notes entry would be good.

@primeos
Copy link
Member Author

primeos commented Dec 7, 2020

Do you want people to use it already before the deprecation kicks in? Then a release notes entry would be good.

Sorry, forgot to reply to that :o I'm currently aiming for the following (open to feedback/suggestions):

  • Wait a bit to see if anyone complains or provides further feedback after the merge (seems unlikely but since I'm in no rush)
  • A treewide PR to rename all usages in Nixpkgs to iproute2 (~500 occurrences IIRC) and formally "deprecate" iproute by moving it into aliases.nix
    • This PR or a followup PR could also contain a release notes entry

I'll go ahead and merge this then :)

@primeos primeos merged commit 1000615 into NixOS:master Dec 7, 2020
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