| Age | Commit message (Collapse) | Author | Files | Lines |
|---|
|
Match admonition syntax in
https://nixos.org/manual/nixpkgs/unstable/#chap-contributing
|
|
Discussed and proposed at https://discourse.nixos.org/t/rules-around-adding-to-someones-pr/22671/3
|
|
helsinki-systems/feat/document-no-breaking-commits
doc: Document that the staging branches may be restricted
|
|
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>
|
|
|
|
doc/contributing: enforce full commit hashes on github
|
|
|
|
both of these render distinctly from plain literals in the manpage, and
manpages even semantically distinguish between the two.
|
|
|
|
Use `nix-shell` instead, but also give an example of the correct
flakes version of the commands.
|
|
|
|
treewide: markdown option docs
|
|
|
|
|
|
|
|
… and link from the coding-conventions chapter to it.
Closes #48569.
|
|
|
|
|
|
`git rm` should always be preferred over "normal" `rm`.
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
|
|
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.
|
|
docs: Make coding conventions use pname/version
|
|
lib/modules: Finally remove deprecated types.optionSet
|
|
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.
|
|
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 :)
|
|
|
|
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.
|
|
|
|
Source:
https://matrix.to/#/!kjdutkOsheZdjqYmqp:nixos.org/$mff3KCoPY5sfgsUhKn0e4va7hnz7KMXARaO2_UaLNM4?via=nixos.org&via=matrix.org&via=nixos.dev
|
|
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]+)+ =
```
|
|
The file was renamed/modified in 3f40ca4 but the documentation was not
updated. Closes #155049.
|
|
doc: remove reference to unix-man-urls.lua
|
|
docs: improve section `Stable release branches`
|
|
|
|
- Explain branch naming scheme for stable release branches
- Split into subsections `Automatically backporting ...` and
`Manually backporting...`.
|
|
|
|
Make it clear that we prefer using `pname` and `version` separated and
not the `name` attribute.
|
|
|
|
Co-authored-by: Cole Helbling <cole.e.helbling@outlook.com>
|
|
doc: Add support for manpage references
|
|
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
|
|
doc/coding-conventions: Increase passthru test timeout 3s -> 60s
|
|
Add the -a param to the docs
|
|
|
|
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.
|
|
|
|
Officially, only the manpage role is supported at the moment.
Unlike in rST, the syntax uses braces instead of colons:
{manpage}`nix.conf(5)`
|
|
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
|
|
|
|
Syntax is taken from MyST:
https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing
|
|
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.
|
