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

iputils: Completed missing meta.longDescription #64772

Merged
merged 1 commit into from Jul 16, 2019

Conversation

craigem
Copy link
Contributor

@craigem craigem commented Jul 15, 2019

Motivation for this change

Provided a more complete and fleshed out meta.longDescription from the project's README

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)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

Provided a more complete and fleshed out meta.longDescription from the project's README
@Yarny0
Copy link
Contributor

Yarny0 commented Jul 15, 2019

(Tiny) review per https://nixos.org/nixpkgs/manual/#sec-reviewing-contributions and top comment in https://raw.githubusercontent.com/NixOS/nixpkgs/master/.github/PULL_REQUEST_TEMPLATE.md .

  • Notifying maintainers @primeos @lheckemann
  • Not much to see here as it only touches the package's meta.longDescription.
  • I like it as it helps people finding some well-known binaries in https://nixos.org/nixos/packages.html . Yet, I have mixed feelings about it: This functionality could possibly be provided by using the programs.sqlite database (which is also queried by the command-not-found script). However, such a concept should probably not be implemented in the course of the pull request at hand.

@teto
Copy link
Member

teto commented Jul 15, 2019

there is nix-index / nix-locate to find binaries. I am curious what prompted you to add the longDescription setting ?

EDIT: I wonder about the pertinence of longDescription in nixpkgs.

@craigem
Copy link
Contributor Author

craigem commented Jul 16, 2019

Great questions @Yarny0 and @teto. Thanks for taking the time to review this PR.

To answer the "why" succinctly, I am preparing to build a NixOS image for the Librem5 phone (current efforts based on replicating the PureOS qemu-x86_64 image) and as part of my QA process, I'm comparing the packages they've used versus what is/isn't available in nixpkgs, what needs packaging, patching and what needs upgrading.

As a result, I'm hitting packages with missing meta data (not always just longDescription, see PR #64725), data I already have to hand as a result of my QA process and I just need to take a minute to do a PR to fill it out.

So this PR is really just an out spring of other work, that seemed both a trivial and useful side effect.

In my 12 months of using NixOS, missing meta data has been a frequent niggle, so now, armed with all the information already, when the missing meta data seems useful to myself, it's probably useful to others so I've been adding it.

So in the case of IP utils, I already had the more complete information and felt it would have been useful so I've created this PR.

Hope that helps :-)

@teto
Copy link
Member

teto commented Jul 16, 2019

who am I to block one of our modern heroes ?! sorry I made you lose time, go back to building that damn image and make my (our?) dream come true: nixos on a smartphone !

@teto teto merged commit 2af6760 into NixOS:master Jul 16, 2019
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