1
0
Fork 1
mirror of https://github.com/NixOS/nixpkgs.git synced 2024-11-22 05:31:22 +00:00
Commit graph

64 commits

Author SHA1 Message Date
Jan Tojnar f24037746d
Merge pull request #149867 from erikarvstedt/docs-stable-release
docs: improve section `Stable release branches`
2021-12-30 16:29:39 +01:00
Erik Arvstedt af46a4d635
docs: improve section Stable release branches
- Explain branch naming scheme for stable release branches
- Split into subsections `Automatically backporting ...` and
  `Manually backporting...`.
2021-12-28 12:09:28 +01:00
Guillaume Girol a15fbab8e9 doc: minimize mentions of nix-env -i without -A in nixpkgs manual 2021-12-18 12:00:00 +00:00
Sandro Jäckel dded550fcd
doc: fix typo 2021-10-28 10:48:34 +02:00
Sandro f289d93a41
doc/contributing: add lib.optional (#121251)
Co-authored-by: Cole Helbling <cole.e.helbling@outlook.com>
2021-10-05 23:13:26 +02:00
Jan Tojnar 1e75936926
Merge pull request #130047 from NixOS/doc-manpage-role
doc: Add support for manpage references
2021-09-07 21:29:26 +02:00
Arnout Engelen d09e0be1c4
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
2021-08-14 09:47:21 +02:00
davidak 2859cc8aa0
Merge pull request #130207 from hercules-ci/passthru-sensible-timeout
doc/coding-conventions: Increase passthru test timeout 3s -> 60s
2021-08-02 07:43:02 +02:00
Ryan Mulligan 9e55528940
Merge pull request #126001 from est31/master
Add the -a param to the docs
2021-07-28 12:00:47 -07:00
Niklas Hambüchen fe5f3f65e2 manuals: Describe how to link NixOS tests from packages 2021-07-27 17:39:33 +02:00
Robert Hensing 840fd0a4f8 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.
2021-07-14 19:03:58 +02:00
Jan Tojnar 04b59b0328 doc: Linkify man page references 2021-07-13 02:21:22 +02:00
Jan Tojnar c9139dfa1a doc: Add support for MyST roles
Officially, only the manpage role is supported at the moment.

Unlike in rST, the syntax uses braces instead of colons:

    {manpage}`nix.conf(5)`
2021-07-13 02:10:57 +02:00
Niklas Hambüchen 3c29ced243 CONTRIBUTING.md: Move to repo root, where it is more visible.
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
2021-06-26 04:51:38 +02:00
Jonathan Ringer 0a6008f4e5 doc/manual: Add backport criteria 2021-06-09 00:13:49 -07:00
Jan Tojnar 3c78ad2561
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
2021-06-07 06:34:59 +02:00
Jan Tojnar 6ecc641d08
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.
2021-06-07 06:34:59 +02:00
est31 49bd30eb33 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.
2021-06-06 21:45:57 +02:00
Jan Tojnar ce6b1a4f8f
doc: Document markup syntax
Not depicted:

- Diagrams using Lua filter and dot
- fenced code attributes (enabled by the attributes extension)
2021-06-06 20:05:00 +02:00
Sandro c3f5d24b8d
Merge pull request #125494 from siraben/remove-stdenv-lib 2021-06-05 16:16:28 +02:00
Jan Tojnar 7497b4721c doc: Fix make in nix-shell
When running make manually, makeFlags will not be passed. Let’s just use an environment variable.
2021-06-05 13:25:48 +02:00
Ben Siraphob 68b5b850d5 coding-conventions: remove reference to stdenv.lib 2021-06-03 19:54:53 +07:00
Stefan Frijters 585f63b364
doc/coding-conventions: Add documentation for fetchpatch optional arguments 2021-05-28 14:22:46 +02:00
Domen Kožar 51c7afa95e
backport action: document the workflow 2021-05-25 09:47:33 +02:00
Alyssa Ross dc3dea22be doc/submitting-changes: should -> must
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.
2021-05-23 20:26:32 +00:00
Sandro f66a5695b4
Merge pull request #121252 from NixOS/SuperSandro2000-patch-1
doc/contributing: add unnecessary string conversions
2021-05-17 02:40:29 +02:00
Luke Granger-Brown 147c701583
Merge pull request #120534 from davidak/package-tests
doc: add instructions for creating package tests
2021-05-01 22:31:02 +01:00
Sandro 08ab1d9572
doc/contributing: add unnecessary string conversions 2021-04-30 11:31:48 +02:00
Sandro 226b043cef
doc/contributing: clarify stdenv.lib deprecation 2021-04-30 11:05:39 +02:00
Patrick Hilhorst 04f82b9ebd doc/submitting-changes: remove incorrect remark
Tests don't only apply to NixOS modules, see for example tests/vscodium
2021-04-26 11:47:42 -04:00
davidak c357fbeb51 doc: add instructions for creating package tests 2021-04-24 18:39:45 +02:00
Bobby Rong 0fd55565d3 doc/contributing/*.xml: Convert to markdown 2021-04-23 12:53:58 +08:00
Samuel Dionne-Riel 5ce39b7ee1
Merge pull request #116475 from davidak/doc-remove-packages
doc: add instructions to remove a package
2021-04-21 20:14:24 -04:00
davidak c0b5d5bb9e doc: add instructions to remove a package
Co-authored-by: Sandro <sandro.jaeckel@gmail.com>
Co-authored-by: Ben Siraphob <bensiraphob@gmail.com>
2021-04-20 22:29:52 +02:00
Evils 7b5850ee1b docs: correct some english 2021-04-20 02:52:09 +02:00
Pamplemousse 1adef4a878 documentation: Add content about Vulnerability roundups
Signed-off-by: Pamplemousse <xav.maso@gmail.com>
2021-03-17 13:39:24 -07:00
Robert Hensing 7d551ead60 doc: Format 2021-03-04 18:10:57 +01:00
Thomas Bereknyei 9c4839fe86 docs: clarify staging
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.
2021-02-19 07:56:09 +01:00
Robert Hensing 1d0d9d26c6
Merge pull request #109663 from Pamplemousse/documentation
documention corrections
2021-01-26 15:37:45 +01:00
V 7616206b77
doc: add function argument order convention (#110060)
* 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
2021-01-20 19:07:16 -05:00
Pamplemousse c803b2333b documentation: correct documentation help
`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>
2021-01-19 18:22:18 -07:00
Alyssa Ross c06b2b3d67 doc: add "prefer lib over stdenv.lib" convention
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).
2021-01-10 08:24:52 +01:00
Jan Tojnar ba11a96653
doc: Add staging workflow diagram 2020-12-09 05:26:55 +01:00
Jan Tojnar cc3228e0bb
doc: Clean up submitting changes 2020-12-05 13:03:22 +01:00
Jan Tojnar 035960e4f6
doc: convert Submitting changes to Markdown 2020-12-05 12:43:25 +01:00
Jan Tojnar 5ad6509278
doc: Rename submitting-changes to chapter 2020-12-05 12:33:00 +01:00
Domen Kožar a0e24a6d40
Merge pull request #101806 from unode/docs
docs: Add 'how to request merging rights'
2020-12-01 17:12:20 +01:00
Jonathan Ringer 0e89c426c7 doc/contributing: remove label instructions
ofborg largely does this now
2020-11-14 16:39:43 -08:00
zowoq 3f20417b4c doc/*: fix indentation 2020-11-12 14:24:00 +10:00
Renato Alves 5c931c7299
docs: Add link to the GitHub issue on how to become a committer 2020-10-29 11:32:41 +01:00