summary refs log tree commit diff
path: root/doc/contributing/coding-conventions.chapter.md
Commit message (Collapse)AuthorAge
* doc/coding-conventions: Fix version attribute suffix to match realityRobert Hensing2022-01-26
| | | | | | | | | | | | | The current doc is wildly out of touch with reality. A regex search shows the following stats. ``` Style example Frequency Regex used nix-2-5: 8 [a-zA-Z]-[0-9]+(-[0-9]+)+ = nix-2_5: 17 [a-zA-Z]-[0-9]+(_[0-9]+)+ = nix_2_5: 689 [a-zA-Z]_[0-9]+(_[0-9]+)+ = nix_2-5: 1 [a-zA-Z]_[0-9]+(-[0-9]+)+ = ```
* doc: fix typoSandro Jäckel2021-10-28
|
* doc/contributing: add lib.optional (#121251)Sandro2021-10-05
| | | Co-authored-by: Cole Helbling <cole.e.helbling@outlook.com>
* nixpkgs-docs: when to prefer passthru.tests over installCheckPhaseArnout Engelen2021-08-14
| | | | | | | | | | 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
* Merge pull request #130207 from hercules-ci/passthru-sensible-timeoutdavidak2021-08-02
|\ | | | | doc/coding-conventions: Increase passthru test timeout 3s -> 60s
| * doc/coding-conventions: Increase passthru test timeout 3s -> 60sRobert Hensing2021-07-14
| | | | | | | | | | | | | | | | | | | | | | | | | | 3s is too small a margin for a loaded slow system to start a bloated program. This leads to problems when tests are written on decent dev hardware but later run on build farms of potentially slower hardware, particularly in the case of non x86. The chance of needing the timeout is actually very small, so those rare 57s are a reasonable price to pay for fewer timeouts on build farms, each of which should be investigated and usually fixed by increasing the timeout.
* | Merge pull request #126001 from est31/masterRyan Mulligan2021-07-28
|\ \ | | | | | | Add the -a param to the docs
| * | Add the -a param to the docsest312021-06-06
| | | | | | | | | | | | | | | | | | | | | | | | | | | The patch utility does not understand git formatted patches. For text files, there is no problem, but binary files use the git format. The -a param makes git diff put binary files into the patch in raw format that can be understood by the patch tool.
* | | manuals: Describe how to link NixOS tests from packagesNiklas Hambüchen2021-07-27
| |/ |/|
* | doc: Use markdown syntax for xrefsJan Tojnar2021-06-07
| | | | | | | | | | | | Syntax is taken from MyST: https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing
* | doc: prepare for commonmarkJan Tojnar2021-06-07
|/ | | | | | | | | | | | | | We are still using Pandoc’s Markdown parser, which differs from CommonMark spec slightly. Notably: - Line breaks in lists behave differently. - Admonitions do not support the simpler syntax https://github.com/jgm/commonmark-hs/issues/75 - The auto_identifiers uses a different algorithm – I made the previous ones explicit. - Languages (classes) of code blocks cannot contain whitespace so we have to use “pycon” alias instead of Python “console” as GitHub’s linguist While at it, I also fixed the following issues: - ShellSesssion was used - Removed some pointless docbook tags.
* coding-conventions: remove reference to stdenv.libBen Siraphob2021-06-03
|
* doc/coding-conventions: Add documentation for fetchpatch optional argumentsStefan Frijters2021-05-28
|
* Merge pull request #121252 from NixOS/SuperSandro2000-patch-1Sandro2021-05-17
|\ | | | | doc/contributing: add unnecessary string conversions
| * doc/contributing: add unnecessary string conversionsSandro2021-04-30
| |
* | Merge pull request #120534 from davidak/package-testsLuke Granger-Brown2021-05-01
|\ \ | | | | | | doc: add instructions for creating package tests
| * | doc: add instructions for creating package testsdavidak2021-04-24
| |/
* / doc/contributing: clarify stdenv.lib deprecationSandro2021-04-30
|/
* doc/contributing/*.xml: Convert to markdownBobby Rong2021-04-23