MirrorHub/nixpkgs
0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2024-11-17 07:13:23 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
384155 commits 244 branches 124 tags 6.1 GiB
Commit graph

79 commits

Author SHA1 Message Date
Florian Klink
1cefcfab2d nixos/doc: move fetchpatch documentation to fetcher documentation 
… and link from the coding-conventions chapter to it.

Closes #48569.
 2022-06-03 14:37:31 +02:00
Arnout Engelen
1c73a0773c
doc: clarify what a 'mass rebuild' is 2022-05-09 12:31:21 +02:00
Matthias Beyer
bdcb818804 Replace "rm" call with "git rm" 
`git rm` should always be preferred over "normal" `rm`.

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
 2022-05-03 13:38:50 +02:00
Doron Behar
94eb0d16a3
Merge pull request #149667 from doronbehar/doc/pname-version-conventions 
docs: Make coding conventions use pname/version
 2022-04-14 12:00:59 +03:00
Silvan Mosberger
99d9d45630
Merge pull request #164651 from Infinisil/remove-optionSet 
lib/modules: Finally remove deprecated types.optionSet
 2022-03-25 17:41:57 +01:00
Naïm Favier
bf7d13dc4f
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.
 2022-03-25 01:00:36 +01:00
Silvan Mosberger
96698efe0c lib/modules: Finally remove deprecated types.optionSet 
types.optionSet has been deprecated for almost 10 years now
(0e333688ce)! A removal
was already attempted in 2019
(27982b408e), but it was promptly
reinstantiated since some third-party uses were discovered
(f531ce75e4).

It's finally time to remove it for good :)
 2022-03-18 04:51:27 +01:00
Robert Hensing
3e39e243db doc/reviewing-contributions: Recommend mkRenamedOptionModuleWith 2022-03-09 14:53:53 +01:00
AndersonTorres
3f19fc37a3 Move misc/vim-plugins to applications/editors/vim/plugins 2022-02-24 20:26:07 -03:00
Guillaume Girol
02a8d5984c doc: discourage setting phases, document/encourage runHook instead. 
Source:
https://matrix.to/#/!kjdutkOsheZdjqYmqp:nixos.org/$mff3KCoPY5sfgsUhKn0e4va7hnz7KMXARaO2_UaLNM4?via=nixos.org&via=matrix.org&via=nixos.dev
 2022-02-12 12:00:00 +00:00
Robert Hensing
daca830722 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]+)+ =
```
 2022-01-26 14:40:20 +01:00
Nicolas Benes
5c8d6d6cee doc: fix broken link 
The file was renamed/modified in 3f40ca4 but the documentation was not
updated. Closes #155049.
 2022-01-15 16:07:55 +01:00
Renaud
3d6fc382d6
Merge pull request #152451 from ncfavier/unix-man-urls 
doc: remove reference to unix-man-urls.lua
 2022-01-03 16:05:37 +01:00
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
Naïm Favier
8583c5f48b
doc: remove reference to unix-man-urls.lua 2021-12-28 13:26:35 +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
Doron Behar
01ec4349f2 docs: Make coding conventions use pname/version 
Make it clear that we prefer using `pname` and `version` separated and
not the `name` attribute.
 2021-12-08 18:40:01 +02: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