doc/python: add section about replaced/stubbed/avoided packages #336775
Conversation
ofborg
bot
added
10.rebuild-darwin: 0
10.rebuild-linux: 1-10
10.rebuild-linux: 1
labels
| | cmake | cmake (stub) | The package normally downloads cmake from the internet. The stub provides our cmake with the usual setup hook. | | ||
| | ninja | ninja (stub) | The package normally downloads ninja from the internet. The stub provides our cmake with the usual setup hook. | |
There was a problem hiding this comment.
This seems more like an implementation detail than actionable advice for package authors, right?
There was a problem hiding this comment.
Well, jain. It is probably a good hint to kinda know the difference between pkgs.ninja and pkgs.python3Packages.ninja and what to do when you encounter it.
There was a problem hiding this comment.
For example with this information people know that they don't need to remove the dependency which would otherwise be necessary because downloading things in the sandbox is well known to not work.
|
I'm currently extending And I think including this information in the document is also necessary. |
SuperSandro2000
force-pushed
the
stubs-doc
branch
from
814681b
to
006266b
Compare
|
|
||
| This list is useful for reviewers as well as for self-checking when submitting packages. | ||
|
|
||
| ## Dependencies to avoid or replace {#python-dependencies-avoid-replace} |
There was a problem hiding this comment.
To scope it within nixpkgs contributions, rather than for example downstream usage like ad-hoc shells
| ## Dependencies to avoid or replace {#python-dependencies-avoid-replace} | |
| ### Dependencies to avoid or replace {#python-dependencies-avoid-replace} |
| | cmake | cmake (stub) | The package normally downloads cmake from the internet. The stub provides our cmake with the usual setup hook. | | ||
| | ninja | ninja (stub) | The package normally downloads ninja from the internet. The stub provides our ninja with the usual setup hook. | | ||
| | pytest-cov | pytest-cov-stub | coverage is only useful for developers. | | ||
| | pytest-runner | | Dependencies cannot be downloaded and should be provided through nativeCheckInputs. | |
There was a problem hiding this comment.
| | cmake | cmake (stub) | The package normally downloads cmake from the internet. The stub provides our cmake with the usual setup hook. | | |
| | ninja | ninja (stub) | The package normally downloads ninja from the internet. The stub provides our ninja with the usual setup hook. | | |
| | pytest-cov | pytest-cov-stub | coverage is only useful for developers. | | |
| | pytest-runner | | Dependencies cannot be downloaded and should be provided through nativeCheckInputs. | | |
| | cmake | `python3Packages.cmake` (stub) | The package normally downloads cmake from the internet. The stub provides our cmake with the usual setup hook. | | |
| | ninja | `python3Packages.ninja` (stub) | The package normally downloads ninja from the internet. The stub provides our ninja with the usual setup hook. | | |
| | pytest-cov | `python3Packages.pytest-cov-stub` | coverage is only useful for developers. | | |
| | pytest-runner | - | Dependencies cannot be downloaded and should be provided through nativeCheckInputs. | |
Description of changes
Things done
nix.conf? (See Nix manual)sandbox = relaxedsandbox = truenix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage./result/bin/)Add a 👍 reaction to pull requests you find important.