| Age | Commit message (Collapse) | Author | Files | Lines |
|---|
|
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...`.
|
|
|
|
|
|
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.
|
|
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.
|
|
Not depicted:
- Diagrams using Lua filter and dot
- fenced code attributes (enabled by the attributes extension)
|
|
|
|
When running make manually, makeFlags will not be passed. Let’s just use an environment variable.
|
|
|
|
|
|
|
|
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.
|
|
doc/contributing: add unnecessary string conversions
|
|
doc: add instructions for creating package tests
|
|
|
|
|
|
Tests don't only apply to NixOS modules, see for example tests/vscodium
|
|
|
|
|
|
doc: add instructions to remove a package
|
|
Co-authored-by: Sandro <sandro.jaeckel@gmail.com>
Co-authored-by: Ben Siraphob <bensiraphob@gmail.com>
|
|
|
|
Signed-off-by: Pamplemousse <xav.maso@gmail.com>
|
|
|
|
Specify that the merges from master to staging-next to staging are
performed by GitHub actions. This helps the reader understand the
relationship between the branches.
|
|
documention corrections
|
|
* doc: add function argument order convention
Ordering by usage is the de facto ordering given to arguments. It's
logical, and makes finding argument usage easier. Putting lib first is
common in NixOS modules, so it's reasonable to mirror this in nixpkgs
proper. Additionally, it's not a package as such, has zero dependencies,
and can be found used anywhere in a derivation.
* doc: clean up usage of lib
|
|
`PANDOC_LUA_FILTERS_DIR` is set in `makeFlags` in `doc/default.nix`,
and needs to be explicitely passed to `make` when called manually.
Signed-off-by: Pamplemousse <xav.maso@gmail.com>
|
|
I think we should have something in the manual people can point to
about this, to avoid rehashing it over and over in PRs. "stdenv.lib"
makes it look like lib is part of stdenv, which it isn't, and makes it
even more confusing as a newcomer to figure out what stdenv is (and
isn't).
|
|
|
|
|
|
|
|
|
|
docs: Add 'how to request merging rights'
|
