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

all-packages.nix: Documented some fetch functions #47680

Closed
wants to merge 1 commit into from
Closed

all-packages.nix: Documented some fetch functions #47680

wants to merge 1 commit into from

Conversation

roberth
Copy link
Member

@roberth roberth commented Oct 2, 2018 •
edited

Motivation for this change

This documentation was written 11 months ago by @FPtje during the NixCon 2017 hackathon. I've rebased it so it can be of use.

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 nox --run "nox-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)
  • Fits CONTRIBUTING.md.

bhipple
bhipple reviewed Oct 2, 2018
View reviewed changes
pkgs/top-level/all-packages.nix
rev = "ae0dcdc0c5d13483271065c360e378202d20170a";
sha256 = "0mla5lm51ryikc2rrk53max2m7a5ds6i1ai921l2h95wrha45nkr";
};
*/
Copy link
Contributor

Choose a reason for hiding this comment

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

It seems like the best place for this documentation would be in ../build-support/fetchgit/default.nix so that it can be maintained along with the actual functions, no? That decreases the risk of the documentation drifting out of sync with the implementation.

https://github.com/NixOS/nixpkgs/blob/master/pkgs/build-support/fetchgit/default.nix

Copy link
Member

Choose a reason for hiding this comment

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

👍

@FPtje
Copy link
Contributor

FPtje commented Oct 8, 2018

Nice work! I had forgotten about this.

@roberth roberth mentioned this pull request Nov 4, 2018
Open
@mmahut
Copy link
Member

mmahut commented Aug 9, 2019

Any updates on this pull request, please?

@stale
Copy link

stale bot commented Jun 1, 2020

Thank you for your contributions.
This has been automatically marked as stale because it has had no activity for 180 days.
If this is still important to you, we ask that you leave a comment below. Your comment can be as simple as "still important to me". This lets people see that at least one person still cares about this. Someone will have to do this at most twice a year if there is no other activity.
Here are suggestions that might help resolve this more quickly:

  1. Search for maintainers and people that previously touched the
    related code and @ mention them in a comment.
  2. Ask on the NixOS Discourse. 3. Ask on the #nixos channel on
    irc.freenode.net.

@stale stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 1, 2020
samuela
samuela reviewed Sep 24, 2020
View reviewed changes
pkgs/top-level/all-packages.nix
bower package manager (https://bower.io/)

Examples:
fetchbower "jquery" "2.2.2" "1.9.1 - 2" "10sp5h98sqwk90y4k6hbdviwqzvzwqf47r3r51pakch5ii2y7js1"
Copy link
Member

Choose a reason for hiding this comment

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

Why the two version inputs here?

@stale stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Sep 24, 2020
@stale
Copy link

stale bot commented Jun 7, 2021

I marked this as stale due to inactivity. → More info

@stale stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 7, 2021
@roberth
Copy link
Member Author

roberth commented Jul 18, 2021

These are probably horribly out of date and need to be updated for nix-doc. Doing it all over again is probably the same effort, but better result.

I've learned that

  • people don't take ownership of their work when you create the PR for them
    • neither did I
  • next time someone suggests making a nixpkgs fork for some purpose, I'll have to be highly critical of that idea

@roberth roberth closed this Jul 18, 2021
@wegank wegank deleted the docs-all-packages branch May 27, 2023 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@grahamc grahamc grahamc left review comments

@samuela samuela samuela left review comments

@bhipple bhipple bhipple left review comments

Assignees
No one assigned
Labels
2.status: merge conflict 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md 8.has: documentation 10.rebuild-darwin: 0 10.rebuild-linux: 0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
8 participants
@roberth @FPtje @mmahut @grahamc @samuela @bhipple @ryantm @GrahamcOfBorg