Commit graph

1698 commits

Author SHA1 Message Date
Jörg Thalheim 5f31fe07cc
Merge pull request #132351 from figsoda/rust-doc
doc: rust: improve documentation on cargoLock.lockFile
2021-08-02 21:23:09 +01: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
figsoda a3925908e4 doc: rust: improve documentation on cargoLock.lockFile 2021-08-01 17:01:13 -04:00
Alyssa Ross fc11b5eaa4
doc: rust: add missing semicolon 2021-07-30 08:37:25 +00: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
Martin Weinelt 12e2b98017
Merge branch 'master' into staging-next 2021-07-19 23:16:25 +02:00
Guillaume Girol 23462c6941
Merge pull request #130206 from symphorien/treesitter-doc
vimPlugins.nvim-treesitter: document plugins
2021-07-19 19:07:37 +00:00
Guillaume Girol f620722174 vimPlugins.nvim-treesitter: document plugins 2021-07-18 14:40:49 +02:00
github-actions[bot] fa7a791586
Merge master into staging-next 2021-07-16 00:01:36 +00: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
Mauricio Scheffer a7784fe00a buildFHSUserEnv: document profile parameter 2021-07-11 18:12:19 +01:00
Dmitry Kalinkin 280e629ee0
Merge branch 'master' into staging-next 2021-07-08 04:38:15 -04:00
slotThe 2c529c3cb8 Link to Libera, Matrix instead of Freenode
The project has moved away from Freenode as an IRC network[1], and there
is now a quite large channel on Libera.  As such, we should point users
towards that instead.

This also changes all examples to refer to libera instead of freenode
as, with the recent deletion of all freenode channels, it is perhaps
where most communities are to be found nowadays.

Finally, also link to the official Matrix room[2] as an alternative to
IRC.

Related: https://github.com/NixOS/nixpkgs/pull/129384

[1]: https://discourse.nixos.org/t/join-us-on-matrix-at-nix-nixos-org-migrating-from-freenode
[2]: https://github.com/NixOS/rfcs/pull/94
2021-07-06 16:35:37 +02:00
github-actions[bot] 3ddb8d5a79
Merge staging-next into staging 2021-07-06 00:02:03 +00:00
Niklas Hambüchen 7cfaba911d manual: Hardening: Remove now-nonexistent ArchWiki link.
The page has been replaced by the much more general page
https://wiki.archlinux.org/title/Security#Packages
which is barely talking about hardening flags any more.
2021-07-05 22:57:52 +02:00
Robert Schütz a2c9f04849 fixup! python3: 3.8 -> 3.9 2021-07-05 12:34:02 -07:00
Frederik Rietdijk 94cd70bae2 python3: 3.8 -> 3.9 2021-07-05 12:34:02 -07:00
Niklas Hambüchen ac36a0f9eb manual: hardening: Fix disabled flags prose being in previous section
This confused the hell out of me, as I didn't spot the

> The following flags are disabled by default ...

when reading about `pie`, because that sentence was hidden in the
previous hardening flag's section.

Also explain that `pie` hardening is on by default on musl.
2021-07-05 16:32:55 +02:00
Robert Schütz 1ec5651913 treewide: use pythonPackages.python-dateutil instead of pythonPackages.dateutil 2021-07-03 13:45:57 +02:00
Mario Rodas 39916f933e beam: update reference to nodejs package
nodejs-15_x has reached EOL, and removed from nixpkgs.
2021-07-01 04:20:00 +00:00
Chris Martin 023489f623 docs: update Steam instructions to use steam-run-native package
pkgs.steam-run-native is defined as exactly the expression that
these instructions tell you to write, so the instruction is no
longer necessary since we can just tell you to use that.
2021-07-01 02:43:10 -06:00
Luke Granger-Brown e8d4f67e8a
Merge pull request #128123 from Mazurel/master
hy: 0.19.0 -> 1.0a1 and improvements
2021-06-30 23:03:13 +01:00
Robert Hensing 4c4c00e9f1
Merge pull request #124875 from hercules-ci/lib-sources
lib.sources: docs, tests, refactoring
2021-06-28 14:02:37 +02:00
Mazurel 30a15dbc5e hy: 0.19.0 -> 1.0a1 and improvements 2021-06-27 12:34:28 +02:00
Domen Kožar 6556d64f45
Merge pull request #128163 from nh2/github-actions-backport-link-to-criteria
Make backport bot link to criteria, make `CONTRIBUTING.md` more prominent
2021-06-26 17:36:14 +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
Martin Weinelt b607aadaac
Merge branch 'master' into staging-next 2021-06-22 23:55:21 +02:00
Graham Fawcett d26902aef9
Refresh the Ocaml package examples; document useDune2 (#127520)
The current example in the manual no longer builds, mainly because
`useDune2 = true` is required, but also because the inputs have changed.
The new examples are copied verbatim from nixpkgs.
2021-06-22 18:53:27 +02:00
rnhmjoj ad5deab11a
doc/functions/generators: fix code block
Small fixup of 606bf6d.
2021-06-22 14:03:36 +02:00
github-actions[bot] dd892e7e2f
Merge master into staging-next 2021-06-18 12:04:55 +00:00
Jan Tojnar f07dcbef64
nixos/doc: Synchronize the Markdown generator with Nixpkgs
Switch to CommonMark with our extensions.
2021-06-18 00:07:00 +02:00
github-actions[bot] 8b9fa8d446
Merge staging-next into staging 2021-06-16 18:04:48 +00:00
Jan Tojnar 8d7b497e7f
Merge pull request #126591 from jtojnar/glib-networking-doc
doc/gnome: document GIO modules
2021-06-16 17:06:25 +02:00
github-actions[bot] de8250217d
Merge staging-next into staging 2021-06-13 00:10:27 +00:00
Ryan Mulligan 740d9fe090
Merge pull request #125671 from SFrijters/doc-improve-make-clean
doc: Clean up generated media directory
2021-06-12 16:51:03 -07:00
Alyssa Ross b0b5ef7286 stdenv: introduce dontAddStaticConfigureFlags
With removeUnknownConfigureFlags, it's impossible to express a package
that needs --enable-static, but will not accept --disable-shared,
without overriding the result of removeUnknownConfigureFlags _again_
in pkgs/top-level/static.nix.

It would be much better (and more in line with the rest of Nixpkgs) if
we encoded changes needed for static builds in package definitions
themselves, rather than in an ever-expanding list in static.nix.  This
is especially true when doing it in static.nix is going to require
multiple overrides to express what could be expressed with stdenv
options.

So as a step in that direction, and to fix the problem described
above, here I replace removeUnknownConfigureFlags with a new stdenv
option, dontAddStaticConfigureFlags.  With this mechanism, a package
that needs one but not both of the flags just needs to set
dontAddStaticConfigureFlags and then set up configureFlags manually
based on stdenv.hostPlatform.isStatic.
2021-06-11 14:16:05 -07:00
Ryan Mulligan 606bf6dc17 doc/functions/generators: convert to CommonMark 2021-06-11 06:06:42 -07:00
Jan Tojnar 653bd18d51
doc/gnome: document GIO modules
In particular, that glib-networking is required for TLS support.
2021-06-11 14:04:06 +02:00
Vladimír Čunát 2ee781417e
nixos/*: replace alsa* aliases
The attributes got renamed in PR #126440 and in some places this caused
evaluation errors, e.g. the tarball job was saying (locally)
> attribute 'alsaUtils' missing, at /build/source/nixos/modules/services/audio/alsa.nix:6:4
and I suspect that trunk-combined jobset's failure to evaluate was also caused.
2021-06-10 09:46:55 +02:00
Jonathan Ringer 0a6008f4e5 doc/manual: Add backport criteria 2021-06-09 00:13:49 -07:00
Ryan Mulligan c682532fce doc/functions/prefer-remote-fetch: convert to CommonMark 2021-06-07 20:18:39 -07:00
Ryan Mulligan e560790890
Merge pull request #125957 from ryantm/md-debug
doc/functions/debug: convert to CommonMark
2021-06-07 19:57:22 -07:00
Ryan Mulligan fbfdc8fc0b doc/functions/debug: convert to CommonMark 2021-06-07 19:56:38 -07:00
Ryan Mulligan 2f92034d30
Merge pull request #125838 from jtojnar/strict-commonmark
doc: Parse as CommonMark
2021-06-07 06:02:29 -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 adecb00f5a
doc: Build as CommonMark
We were using Pandoc’s Markdown parser. This is non-standard and might cause issues when we finally switch to some other tool.

Since RFC 0072 agreed on CommonMark, let’s switch to that.

We will use some extensions to make the limited syntax bearable but these are official so they should be more portable.
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