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

doc: doCheck: add the special case of 'buildPython*' #55541

Closed

Conversation

@Anton-Latukha
Copy link
Contributor

commented Feb 10, 2019

Motivation for this change

By default doCheck = false, buildPython* has doCheck = true - it is a special case that should be mentioned in doCheck section.

Forming paragraph for special cases. Rephrased cross compile case.

This build is fresh after the fixes to the changes of the NixPkgs Manual build:

  1. Changes to the NixPkgs Manual build process: #53055
  2. Issue about Manual build being broken: #55014
  3. Recently merged fix: #55040
Things done
  • Built on platform(s)
    • NixOS
  • Assured whether relevant documentation is up to date
  • Fits CONTRIBUTING.md.

Copy link
Member

left a comment

I don't think it should be mentioned in the stdenv part. buildPython* is just a function that calls stdenv but with potentially different attribute values. We do that in many places. I'm of the opinion that Take a note for special cases is sufficient. Details regarding buildPython* can be found in its own section.

@Anton-Latukha

This comment has been minimized.

Copy link
Contributor Author

commented Feb 13, 2019

@FRidh For deep understanding this is the right harder approach, but this 'look yourself for special cases' approach makes documentation way harder and sometimes not useful for users and casual contributor. So I thought simple notes are a way to bridge manual together for the reader.

AFAIK this doCheck Python special case and cross-compilation special case are the only two major special cases. Maybe then since cross-compilation has its own Chapter 5. Cross-compilation, it should be removed from stdenv? As additional point - anyway, as I look - cross-comp text touched in this PR is not true (https://nixos.org/nixpkgs/manual/#sec-cross-cookbook) cross-comp can run rests if configured right.

I can send PR with this discussed changes.

@mmahut

This comment has been minimized.

Copy link
Member

commented Aug 20, 2019

Are there any updates on this pull request, please?

@Anton-Latukha

This comment has been minimized.

Copy link
Contributor Author

commented Aug 21, 2019

The PR resulted in a dead tie.

My point was that when you troubleshoot and refer to documentation - there is nothing mentioned in there doCheck, but there is a special case for doCheck that is hidden in buildPython* documentation. So I wanted to cross-mention the special case.

The maintainer point is that it is a buildPython* question, so documentation stayed in place.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.