nixpkgs doc: add and clean some paragraphs #16579
Conversation
|
There are a few typos: comparasion -> comparison, availible -> available, diffrent -> different. |
|
Thanks for pointing at these, I had them corrected. |
|
|
||
| <para>The nixpkgs package repository is not restrictive in | ||
| comparison to other distributions. Non free packages are allowed but | ||
| will not be built by Hydra. Packaging binaries is allowed, patching |
There was a problem hiding this comment.
The first sentence in this paragraph I would drop since it doesn't add anything really.
Next, you will have to make a clearer distinction between free and non-free software. Indeed, we package non-free software and then we typically need to patch the binaries.
In the case of free software it is different. Here we want all software to be build from source. There are cases that we do use binaries, but those are, at least how I see it, exceptions, and they are typically only included because of, say, a complex build procedure.
There was a problem hiding this comment.
Thanks, I made a edit according to your suggestions. Could you also review that?
The quickstart chapter is renamed to packaging guide. Paragraphs regarding same topic in the guide and chapter about submitting changes have been rewritten. Some bullet points was collapsed into paragraphs. A new section about poilicies have been added. Both chapters are now indented. One reference to the mailing list have been in-lined.
|
Would it be possible to leave the guidelines out of this for now? To me, these guidelines are not that helpful in the common case. |
|
@joachifm do you mean leave out the policy section and the first paragraph I added to the quick-start guide? About the policy section I think it is useful to get an idea of what can be accepted in nixpkgs so I don't see why this cannot be included. I think everyone should be able to know this before starting a package. |
|
What I mean is to propose the guidelines in a separate PR. I don't think everybody will realize that what appears to be mainly a cleanup PR also codifies repo wide policies. |
| binary cache. | ||
|
|
||
| For example: <command>nixos-version</command> returns | ||
| <command>15.05.git.0998212 (Dingo)</command>. So you can do: |
There was a problem hiding this comment.
How about:
For example: <command>nixos-version --hash</command> returns <literal>d7450443c42228832c68fba203a7c15cfcfb264e</literal>. So you can do:
Motivation for this change
Things done
(nix.useSandbox on NixOS,
or option
build-use-sandboxinnix.confon non-NixOS)
nix-shell -p nox --run "nox-review wip"./result/bin/)The quickstart chapter is renamed to packaging guide. Paragraphs
regarding same topic in the guide and chapter about submitting changes
have been rewritten. A new section about poilicies have been added. Both
chapters are now indented.