Commit graph

56 commits

Author SHA1 Message Date
Valentin Gagarin
9b76c3bff5
doc: move note on configuring Nixpkgs in NixOS to the NixOS manual (#304307)
that NixOS manual section talks a lot about Nixpkgs package
configuration, which really should not be there but rather in the
Nixpkgs manual itself. but this is a rabbit hole for another time.

Co-authored-by: Dominic Mills <dominic.millz27@gmail.com>
2024-04-19 16:06:32 +02:00
Janne Heß
fcc95ff817 treewide: Fix all Nix ASTs in all markdown files
This allows for correct highlighting and maybe future automatic
formatting. The AST was verified to work with nixfmt only.
2024-03-28 09:28:12 +01:00
Anthony Roussel
e30f48be94
treewide: fix redirected and broken URLs
Using the script in maintainers/scripts/update-redirected-urls.sh
2023-11-11 10:49:01 +01:00
Arnout Engelen
97b0ae26f7
doc: avoid 'simply' (#266434)
While the word 'simply' is usually added to encourage readers, it often has the
opposite effect and may even appear condescending, especially when the reader
runs into trouble trying to apply the suggestions from the documentation. It is
almost always an improvement to simply drop the word from the sentence.

(there are more possible improvements like this, we can apply those in separate
PRs)
2023-11-09 21:48:05 +01:00
Lorenzo Manacorda
b19e9bebdc doc: minimal documentation of supported platforms
This commit adds minimal documentation of the supported platforms.
More exhaustive documentation would require producing a list of
platforms for each of the 7 tiers. This was attempted in #245368, but it
quickly became clear that that would be a long-term effort.

In the meantime, this commit adds the most important information to the
manual.

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-10-02 21:21:56 +02:00
asymmetric
b414f942e0
doc: link, instead of just mentioning, Nix manual (#255126)
Instead of just telling the reader to go find the relevant section of the Nix
manual, let's just link to it. Yay hypertext!
2023-09-14 17:09:39 +02:00
pennae
06140b7ecf
Merge pull request #239636 from pennae/nixpkgs-manual-nrd
doc: dedocbookify nixpkgs manual
2023-07-03 20:48:23 +02:00
pennae
70cbd8c6c0 doc: pull option docs out of doc-support
this leaves doc-support as a simple wrapper around function docs. this
wrapper will go away very soon as well.
2023-07-01 20:59:30 +02:00
pennae
be4d19ff1a doc: render nixpkgs manual with nrd
also updates nixdoc to 2.3.0. the nixdoc update is not a separate commit
because that would leave the manual build broken for one commit,
potentially breaking bisects and rebases.
2023-07-01 20:59:29 +02:00
Robert Hensing
0c9fb905cb
doc/using/overrides: Relate addition to preceding text 2023-07-01 15:25:17 +02:00
Artturin
fb643f3260 doc/using/overrides: it is possible to use previous arguments in .override 2023-06-30 23:28:00 +03:00
Artturin
0fdae31531 stdenv: let overrideAttrs accept attrset OR function
Makes overrideAttrs usable in the same way that `override` can be used.
It allows the first argument of `overrideAttrs` to be either a function
or an attrset, instead of only a function:

hello.overrideAttrs (old: { postBuild = "echo hello"; })
hello.overrideAttrs { postBuild = "echo hello"; }

Previously only the first example was possible.

Co-authored-by: adisbladis <adisbladis@gmail.com>
Co-authored-by: matthewcroughan <matt@croughan.sh>
2023-06-30 23:28:00 +03:00
Naïm Favier
4df10debe7
lib/customisation.overrideDerivation: propagate evaluation condition
The new derivation should evaluate only if the old derivation does.

Sadly this means that the old derivation cannot depend on the new one
any more, which was used by xorgserver on Darwin. But this is not a
problem as `overrideAttrs` can (and should) usually be used instead.

This change allowed catching an invalid `meta.platforms` in the linux_rpi
kernels, which use `overrideDerivation`.
2023-01-01 14:10:42 +01:00
Naïm Favier
e9e65810ac
doc,nixos/doc: unescape double quotes
Leftovers from the CommonMark conversion.
2022-12-27 17:13:49 +01:00
Colin Arnott
bac379f30a
doc: use sri hash syntax
The nixpkgs manual contains references to both sri hash and explicit
sha256 attributes. This is at best confusing to new users. Since the
final destination is exclusive use of sri hashes, see nixos/rfcs#131,
might as well push new users in that direction gently.

Notable exceptions to sri hash support are builtins.fetchTarball,
cataclysm-dda, coq, dockerTools.pullimage, elixir.override, and
fetchCrate. None, other than builtins.fetchTarball, are fundamentally
incompatible, but all currently accept explicit sha256 attributes as
input. Because adding backwards compatibility is out of scope for this
change, they have been left intact, but migration to sri format has been
made for any using old hash formats.

All hashes have been manually tested to be accurate, and updates were
only made for missing upstream artefacts or bugs.
2022-12-04 06:12:18 +00:00
Victor Engmark
9cf0ee43e7 doc: Use POSIX syntax to source file
Avoids bashism in case another shell is active.
2022-11-29 08:39:37 -05:00
Victor Engmark
22d3b5a9e9 doc: Quote variable references 2022-11-29 08:39:37 -05:00
Victor Engmark
852ef6e971 doc: Fix grammar 2022-11-29 08:39:37 -05:00
Arnout Engelen
0dd7792b4c
nixpkgs/doc: remove unused unfree.xml
This section was broken out into its own file in efb55d2a42 but
apparently never actually got included anywhere.

Since then a more detailed section on using unfree packages has been
introduced.

Copied the introduction and removed the rest of the file.
2022-07-28 16:54:32 +02:00
Robert Hensing
fa01afcf7f doc: Promote config Options Reference to sub-chapter section
It was hidden in the insecure packages section.
 - Lift it out.
 - Add an id
2022-06-12 08:27:15 +02:00
Robert Hensing
90344e9f40
Merge pull request #171163 from hercules-ci/nixpkgs-config-doc
Add generated `nixpkgs.config` doc to Nixpkgs manual
2022-05-19 20:51:38 +02:00
Robert Hensing
e40d2099d2 doc: Add Nixpkgs config options reference 2022-05-02 10:21:05 +02:00
Robert Hensing
0e00acafe9 stdenv.mkDerivation: public -> finalPackage 2022-05-02 08:49:33 +02:00
Robert Hensing
1bbb5a14c8 doc/using/overrides: Update for overlay style mkDerivation overrideAttrs 2022-05-02 08:49:31 +02:00
Markus Kowalewski
f415aae965
nixpkgs/doc: update overlay/lapack section 2022-02-11 17:51:39 +01:00
Anders Kaseorg
e12f4db556 treewide: Fix unsafe concatenation of $LD_LIBRARY_PATH, round 2
Naive concatenation of $LD_LIBRARY_PATH can result in an empty
colon-delimited segment; this tells glibc to load libraries from the
current directory, which is definitely wrong, and may be a security
vulnerability if the current directory is untrusted.  (See #67234, for
example.)  Fix this throughout the tree.

Followup to #76804.  Fixes #144646.

Signed-off-by: Anders Kaseorg <andersk@mit.edu>
2021-11-04 16:15:05 -07:00
Markus Kowalewski
05f3789ef8
nixpkgs/manual: add mvapich to overlays/mpi section 2021-09-16 15:16:47 +02: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
fricklerhandwerk
c30fe24120 docs/using: shellSession -> ShellSession
Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
2021-04-25 10:31:02 +02:00
fricklerhandwerk
d8b5ed331d doc/using: convert to markdown 2021-04-23 12:02:07 +02:00
Florian Engel
3329093c6a Remove repeating words from doc 2021-03-14 12:15:34 +01:00
Robert Hensing
7d551ead60 doc: Format 2021-03-04 18:10:57 +01:00
WORLDofPEACE
4b10920ed1
stdenv/check-meta: change to allowlist and blocklist (#114127)
* stdenv/check-meta: change to allowlist and blocklist

* Update pkgs/stdenv/generic/check-meta.nix

Co-authored-by: Graham Christensen <graham@grahamc.com>
2021-02-23 10:25:18 -05:00
Daniël de Kok
933c2425d9 doc: fix syntax error in BLAS/LAPACK overlay example
Attribute-values pairs were not properly terminated by a semicolon.
2021-02-12 10:37:16 +01:00
Bernardo Meurer
6eb8979452
doc: remove mentions of flashplayer 2021-02-08 09:38:42 -08:00
Markus Kowalewski
72f96278f7
nixpkgs/manual: add a paragraph about MPI switching mechanism 2021-01-23 12:15:18 +01:00
Profpatsch
b0c1583a0b doc: stdenv.lib -> lib
Part of: https://github.com/NixOS/nixpkgs/issues/108938

Changing the documentation to not refer to stdenv.lib is the first
step to make people use it directly.
2021-01-11 09:52:27 +01:00
zimbatm
bbc9af1f0a
tree-wide: do not use pkgs.extend in nixpkgs
Each invocation of pkgs.extends adds 130MB of allocation to the hydra
evaluator. We are already struggling with the amount of memory nixpkgs
requires.

`pkgs.extend` is a useful escape-hatch, but should be not be used inside
of nixpkgs directly.
2020-11-30 14:24:40 +01:00
Graham Bennett
6771aa3093
doc: clarify whitelistedLicenses
see the following for more info:
076860e034/pkgs/stdenv/generic/check-meta.nix (L229)
2020-11-28 10:25:13 +01:00
Jan Tojnar
e1af37634b
doc: Improve code listings
By adding prompts and removing unnecessary indentation.
2020-09-23 01:25:25 +02:00
Daniël de Kok
aeb5951978 doc/using/overlays.xml: add BLIS 2020-09-07 19:49:51 +02:00
Daniël de Kok
14ac67cbb3 doc/using/overlays.xml: fix some small glitches 2020-08-10 15:47:38 +02:00
Daniël de Kok
8ffc74313e doc/using/overlays.xml: add AMD BLIS/LIBFLAME to the BLAS/LAPACK list 2020-08-10 15:41:33 +02:00
Jan Tojnar
13b5ae55cd
licenses: Make single-version-only GPL explicit
I commonly see people use the former when they should use the latter.

Would be also in line with the SPDX change https://www.gnu.org/licenses/identify-licenses-clearly.html
2020-07-05 17:51:30 +02:00
Sami Bouhlel
c179ae6567 Fix typos in documentation (#91934) 2020-07-01 16:54:22 +01:00
Nicolas Berbiche
071c0f935c
nixos/manual: spelling s/environent/environment/g in configuration.xml 2020-06-08 16:34:50 -04:00
Benjamin Hipple
480a55a6b6
doc/using/overlays.xml: update LD_LIBRARY_PATH example 2020-04-22 21:54:41 -04:00
Matthew Bauer
4238b2b943 doc/overlays.xml: fix missing documentation for blas/lapack
This adds some more information to the documentation as well as
addressing review from https://github.com/NixOS/nixpkgs/pull/85636.
2020-04-22 12:43:14 -05:00
Matthew Bauer
3c41d61514 doc/overlays.xml: update documentation for BLAS/LAPACK
This expands the documentation and explains how to assert LP64.
2020-04-21 11:03:10 -05:00