colin/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
fcc95ff817
nixpkgs/doc/contributing/coding-conventions.chapter.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

64 lines
2.5 KiB
Markdown
Raw Normal View History

doc/contributing/*.xml: Convert to markdown
2021-04-23 04:46:02 +00:00
# Coding conventions {#chap-conventions}
doc/coding-conventions: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 15:48:35 +00:00
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
doc/contributing/*.xml: Convert to markdown
2021-04-23 04:46:02 +00:00
doc/coding-conventions: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 15:48:35 +00:00
## Syntax {#sec-syntax}
doc/contributing: add lib.optional (#121251) Co-authored-by: Cole Helbling <cole.e.helbling@outlook.com>
2021-10-05 21:13:26 +00:00
doc/coding-conventions: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 15:48:35 +00:00
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
doc/contributing/*.xml: Convert to markdown
2021-04-23 04:46:02 +00:00
## Package naming {#sec-package-naming}
doc/coding-conventions: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 15:48:35 +00:00
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
doc/contributing/*.xml: Convert to markdown
2021-04-23 04:46:02 +00:00
## File naming and organisation {#sec-organisation}
doc/coding-conventions: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 15:48:35 +00:00
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
doc/contributing/*.xml: Convert to markdown
2021-04-23 04:46:02 +00:00
### Versioning {#sec-versioning}
doc/coding-conventions: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 15:48:35 +00:00
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
doc/contributing/*.xml: Convert to markdown
2021-04-23 04:46:02 +00:00
## Fetching Sources {#sec-sources}
doc/coding-conventions: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 15:48:35 +00:00
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
doc/contributing/*.xml: Convert to markdown
2021-04-23 04:46:02 +00:00
## Obtaining source hash {#sec-source-hashes}
doc/coding-conventions: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 15:48:35 +00:00
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
doc/contributing/*.xml: Convert to markdown
2021-04-23 04:46:02 +00:00
### Obtaining hashes securely {#sec-source-hashes-security}
doc/coding-conventions: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 15:48:35 +00:00
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
doc/contributing/*.xml: Convert to markdown
2021-04-23 04:46:02 +00:00
## Patches {#sec-patches}
doc/coding-conventions: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 15:48:35 +00:00
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
doc: add instructions for creating package tests
2021-04-24 15:01:05 +00:00
## Package tests {#sec-package-tests}
doc/coding-conventions: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 15:48:35 +00:00
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
doc: add instructions for creating package tests
2021-04-24 15:01:05 +00:00
nixpkgs-docs: when to prefer passthru.tests over installCheckPhase And mention you can have either lightweight 'package' or more heavyweight 'NixOS' (module) tests. This was suggested at https://github.com/ryantm/nixpkgs-update/issues/260#issuecomment-821287971 and discussed further at https://github.com/NixOS/nixpkgs/pull/119731
2021-04-17 17:02:16 +00:00
### Writing inline package tests {#ssec-inline-package-tests-writing}
doc/coding-conventions: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 15:48:35 +00:00
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
nixpkgs-docs: when to prefer passthru.tests over installCheckPhase And mention you can have either lightweight 'package' or more heavyweight 'NixOS' (module) tests. This was suggested at https://github.com/ryantm/nixpkgs-update/issues/260#issuecomment-821287971 and discussed further at https://github.com/NixOS/nixpkgs/pull/119731
2021-04-17 17:02:16 +00:00
### Writing larger package tests {#ssec-package-tests-writing}
doc: add instructions for creating package tests
2021-04-24 15:01:05 +00:00
doc/coding-conventions: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 15:48:35 +00:00
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
doc: add instructions for creating package tests
2021-04-24 15:01:05 +00:00
### Running package tests {#ssec-package-tests-running}
doc/coding-conventions: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 15:48:35 +00:00
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
doc: add instructions for creating package tests
2021-04-24 15:01:05 +00:00
### Examples of package tests {#ssec-package-tests-examples}
doc/coding-conventions: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 15:48:35 +00:00
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
manuals: Describe how to link NixOS tests from packages
2021-06-25 23:31:10 +00:00
### Linking NixOS module tests to a package {#ssec-nixos-tests-linking}
doc/coding-conventions: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 15:48:35 +00:00
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
document Import From Derivation (IFD) policy
2022-12-05 15:24:52 +00:00
### Import From Derivation {#ssec-import-from-derivation}
doc/coding-conventions: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 15:48:35 +00:00
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
Reference in New Issue Copy Permalink