about summary refs log tree commit diff
path: root/doc/contributing
Commit message (Collapse)AuthorAge
...
* | doc/contributing: replace outdated 'nix run' commandsJohannes Maier2022-07-03
| | | | | | | | | | Use `nix-shell` instead, but also give an example of the correct flakes version of the commands.
* | doc/contributing/coding-conventions: add a section about file managersAndersonTorres2022-06-26
| |
* | Merge pull request #176146 from pennae/module-docs-markdownRobert Hensing2022-06-21
|\ \ | | | | | | treewide: markdown option docs
| * | treewide: attempt at markdown option docspennae2022-06-12
| | |
* | | maintainers: document new maintainers and team changesGraham Christensen2022-06-20
| | |
* | | Merge #162960: staging docs: explain that purple arrows are manualVladimír Čunát2022-06-14
|\ \ \ | |/ / |/| |
| * | submitting-changes.chapter.md: avoid being specificAdam Joseph2022-04-20
| | | | | | | | | | | | | | | | | | There is some doubt as to exactly how to enumerate all the merges from one branch to another reliably. In the meantime, let's be a little more vague.
| * | submitting-changes.chapter.md: explain that purple arrows are manualAdam Joseph2022-03-05
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The documentation for this diagram explains that the blue arrows are automatic processes which happen every six hours. There is no explanation about how the purple arrows happen or how often. As a new contributor to nixpkgs, I incorrectly assumed that the purple arrows were also automatic processes (they aren't), which left me sort of confused about what the whole scheme was accomplishing. Recently I went through the github history to see how often these events happen, and realized that the purple arrows are (a) triggered manually by a nixpkgs project member and (b) happen much, much, much less frequently than every six hours. Now everything makes a lot more sense. I suggest the wording change in this commit, or something similar, to save future contributors the same confusion that I experienced.
* | | nixos/doc: move fetchpatch documentation to fetcher documentationFlorian Klink2022-06-03
| |/ |/| | | | | | | | | … and link from the coding-conventions chapter to it. Closes #48569.
* | doc: clarify what a 'mass rebuild' isArnout Engelen2022-05-09
| |
* | Replace "rm" call with "git rm"Matthias Beyer2022-05-03
| | | | | | | | | | | | `git rm` should always be preferred over "normal" `rm`. Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
* | Merge pull request #149667 from doronbehar/doc/pname-version-conventionsDoron Behar2022-04-14
|\ \ | | | | | | docs: Make coding conventions use pname/version
| * | docs: Make coding conventions use pname/versionDoron Behar2021-12-08
| | | | | | | | | | | | | | | Make it clear that we prefer using `pname` and `version` separated and not the `name` attribute.
* | | Merge pull request #164651 from Infinisil/remove-optionSetSilvan Mosberger2022-03-25
|\ \ \ | | | | | | | | lib/modules: Finally remove deprecated types.optionSet
| * | | lib/modules: Finally remove deprecated types.optionSetSilvan Mosberger2022-03-18
| | |/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | types.optionSet has been deprecated for almost 10 years now (0e333688cea468a28516bf6935648c03ed62a7bb)! A removal was already attempted in 2019 (27982b408e465554b8831f492362bc87ed0ec02a), but it was promptly reinstantiated since some third-party uses were discovered (f531ce75e4178c6867cc1d0f7fec96b2d5c3f1cb). It's finally time to remove it for good :)
* | | fetchpatch: add `relative`Naïm Favier2022-03-25
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* | | doc/reviewing-contributions: Recommend mkRenamedOptionModuleWithRobert Hensing2022-03-09
|/ /
* | Move misc/vim-plugins to applications/editors/vim/pluginsAndersonTorres2022-02-24
| |
* | doc: discourage setting `phases`, document/encourage runHook instead.Guillaume Girol2022-02-12
| | | | | | | | | | Source: https://matrix.to/#/!kjdutkOsheZdjqYmqp:nixos.org/$mff3KCoPY5sfgsUhKn0e4va7hnz7KMXARaO2_UaLNM4?via=nixos.org&via=matrix.org&via=nixos.dev
* | 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 broken linkNicolas Benes2022-01-15
| | | | | | | | | | The file was renamed/modified in 3f40ca4 but the documentation was not updated. Closes #155049.
* | Merge pull request #152451 from ncfavier/unix-man-urlsRenaud2022-01-03
|\ \ | | | | | | doc: remove reference to unix-man-urls.lua
| * | doc: remove reference to unix-man-urls.luaNaïm Favier2021-12-28
| | |
* | | Merge pull request #149867 from erikarvstedt/docs-stable-releaseJan Tojnar2021-12-30
|\ \ \ | |/ / |/| | docs: improve section `Stable release branches`
| * | docs: improve section `Stable release branches`Erik Arvstedt2021-12-28
| |/ | | | | | | | | | | - Explain branch naming scheme for stable release branches - Split into subsections `Automatically backporting ...` and `Manually backporting...`.
* / doc: minimize mentions of nix-env -i without -A in nixpkgs manualGuillaume Girol2021-12-18
|/
* 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>
* Merge pull request #130047 from NixOS/doc-manpage-roleJan Tojnar2021-09-07
|\ | | | | doc: Add support for manpage references
| * doc: Linkify man page referencesJan Tojnar2021-07-13
| |
| * doc: Add support for MyST rolesJan Tojnar2021-07-13
| | | | | | | | | | | | | | | | Officially, only the manpage role is supported at the moment. Unlike in rST, the syntax uses braces instead of colons: {manpage}`nix.conf(5)`
* | 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
| |/ |/|
* | CONTRIBUTING.md: Move to repo root, where it is more visible.Niklas Hambüchen2021-06-26
| | | | | | | | | | | | | | We found that many users found it difficult to locate this document. Github supports it in the root, see: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors
* | doc/manual: Add backport criteriaJonathan Ringer2021-06-09
| |
* | 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.
* | doc: Document markup syntaxJan Tojnar2021-06-06
|/ | | | | | | Not depicted: - Diagrams using Lua filter and dot - fenced code attributes (enabled by the attributes extension)
* Merge pull request #125494 from siraben/remove-stdenv-libSandro2021-06-05
|\
| * coding-conventions: remove reference to stdenv.libBen Siraphob2021-06-03
| |
* | doc: Fix make in nix-shellJan Tojnar2021-06-05
|/ | | | When running make manually, makeFlags will not be passed. Let’s just use an environment variable.
* doc/coding-conventions: Add documentation for fetchpatch optional argumentsStefan Frijters2021-05-28
|
* backport action: document the workflowDomen Kožar2021-05-25
|
* doc/submitting-changes: should -> mustAlyssa Ross2021-05-23
| | | | | | | To me, as a native English speaker, this doesn't change the meaning of the sentence at all. But to a non-native speaker, this can read like the staging-next rules are only recommendations. Let's make this clearer.
* 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
| |