summaryrefslogtreecommitdiff
path: root/doc/contributing/coding-conventions.chapter.md (follow)
Commit message (Expand)AuthorAgeFilesLines
* nixpkgs/doc: fix admonition syntax•••Match admonition syntax in https://nixos.org/manual/nixpkgs/unstable/#chap-contributing Ryan Mulligan2022-11-081-1/+1
* coding-conventions.chapter.md: update to account for #89885 (#191378)•••https://github.com/NixOS/nixpkgs/pull/89885 ensures that fetches are done securely (i.e. without `--insecure`) when the `hash` parameter is one of the four special "fake" hashes. However the manual was not updated in that PR. This commit updates the manual to account for the already-merged changes from that PR. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>Adam Joseph2022-10-121-6/+14
* doc/contributing: enforce full commit hashes on githubSandro Jäckel2022-09-041-0/+3
* Correct instructions to obtain a hash for git reposMatthias Bartelmeß2022-08-041-1/+1
* doc/contributing/coding-conventions: add a section about file managersAndersonTorres2022-06-261-0/+4
* nixos/doc: move fetchpatch documentation to fetcher documentation•••… and link from the coding-conventions chapter to it. Closes #48569. Florian Klink2022-06-031-11/+2
* Merge pull request #149667 from doronbehar/doc/pname-version-conventions•••docs: Make coding conventions use pname/versionDoron Behar2022-04-141-5/+5
|\
| * docs: Make coding conventions use pname/version•••Make it clear that we prefer using `pname` and `version` separated and not the `name` attribute. Doron Behar2021-12-081-5/+5
* | fetchpatch: add `relative`•••Allows restricting patches to a specific subdirectory, à la `git diff --relative=subdir`. This cannot be done (cleanly) currently because the `includes` logic happens *after* `stripLen` is applied, so we can't match on `subdir/*`. This change adds a `relative` argument that makes this possible by filtering files before doing any processing, and setting `stripLen` and `extraPrefix` accordingly. Naïm Favier2022-03-251-2/+3
* | doc/coding-conventions: Fix version attribute suffix to match reality•••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]+)+ = ``` Robert Hensing2022-01-261-1/+1
|/
* doc: fix typoSandro Jäckel2021-10-281-1/+1
* doc/contributing: add lib.optional (#121251)•••Co-authored-by: Cole Helbling <cole.e.helbling@outlook.com>Sandro2021-10-051-0/+15
* 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 Arnout Engelen2021-08-141-1/+20
* Merge pull request #130207 from hercules-ci/passthru-sensible-timeout•••doc/coding-conventions: Increase passthru test timeout 3s -> 60sdavidak2021-08-021-1/+1
|\
| * doc/coding-conventions: Increase passthru test timeout 3s -> 60s•••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. Robert Hensing2021-07-141-1/+1
* | Merge pull request #126001 from est31/master•••Add the -a param to the docsRyan Mulligan2021-07-281-1/+1
|\ \
| * | Add the -a param to the docs•••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. est312021-06-061-1/+1
* | | manuals: Describe how to link NixOS tests from packagesNiklas Hambüchen2021-07-271-1/+27
| |/ |/|
* | doc: Use markdown syntax for xrefs•••Syntax is taken from MyST: https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing Jan Tojnar2021-06-071-2/+2
* | doc: prepare for commonmark•••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. Jan Tojnar2021-06-071-2/+2
|/
* coding-conventions: remove reference to stdenv.libBen Siraphob2021-06-031-3/+0
* doc/coding-conventions: Add documentation for fetchpatch optional argumentsStefan Frijters2021-05-281-0/+10
* Merge pull request #121252 from NixOS/SuperSandro2000-patch-1•••doc/contributing: add unnecessary string conversionsSandro2021-05-171-0/+12
|\
| * doc/contributing: add unnecessary string conversionsSandro2021-04-301-0/+12
* | Merge pull request #120534 from davidak/package-tests•••doc: add instructions for creating package testsLuke Granger-Brown2021-05-011-0/+70
|\ \
| * | doc: add instructions for creating package testsdavidak2021-04-241-0/+70
| |/
* / doc/contributing: clarify stdenv.lib deprecationSandro2021-04-301-1/+2
|/
* doc/contributing/*.xml: Convert to markdownBobby Rong2021-04-231-0/+514