summaryrefslogtreecommitdiff
path: root/doc/using (follow)
Commit message (Expand)AuthorAgeFilesLines
* doc/using/overrides: manage package option expectations•••We haven't been good at managing expectations about this, so let's tell people what level of support they can expect. I think the place people are most likely to see it is the place where they learn about overriding in the first place, so I've added it here. Co-authored-by: Valentin Gagarin <valentin@gagarin.work> Alyssa Ross2024-08-161-0/+7
* 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>Valentin Gagarin2024-04-191-17/+12
* 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. Janne Heß2024-03-283-24/+34
* treewide: fix redirected and broken URLs•••Using the script in maintainers/scripts/update-redirected-urls.sh Anthony Roussel2023-11-111-1/+1
* 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)Arnout Engelen2023-11-091-1/+1
* 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> Lorenzo Manacorda2023-10-021-0/+18
* 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!asymmetric2023-09-141-1/+1
* Merge pull request #239636 from pennae/nixpkgs-manual-nrd•••doc: dedocbookify nixpkgs manualpennae2023-07-031-2/+4
|\
| * 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. pennae2023-07-011-1/+1
| * 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. pennae2023-07-011-2/+4
* | doc/using/overrides: Relate addition to preceding textRobert Hensing2023-07-011-1/+3
* | doc/using/overrides: it is possible to use previous arguments in .overrideArtturin2023-06-301-0/+6
* | 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> Artturin2023-06-301-4/+12
|/
* 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`. Naïm Favier2023-01-011-1/+1
* doc,nixos/doc: unescape double quotes•••Leftovers from the CommonMark conversion. Naïm Favier2022-12-271-1/+1
* 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. Colin Arnott2022-12-041-2/+2
* doc: Use POSIX syntax to source file•••Avoids bashism in case another shell is active. Victor Engmark2022-11-291-1/+1
* doc: Quote variable referencesVictor Engmark2022-11-291-5/+5
* doc: Fix grammarVictor Engmark2022-11-291-1/+1
* nixpkgs/doc: remove unused `unfree.xml`•••This section was broken out into its own file in efb55d2a42e 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. Arnout Engelen2022-07-281-0/+5
* doc: Promote config Options Reference to sub-chapter section•••It was hidden in the insecure packages section. - Lift it out. - Add an id Robert Hensing2022-06-121-8/+9
* Merge pull request #171163 from hercules-ci/nixpkgs-config-doc•••Add generated `nixpkgs.config` doc to Nixpkgs manualRobert Hensing2022-05-191-0/+8
|\
| * doc: Add Nixpkgs config options referenceRobert Hensing2022-05-021-0/+8
* | stdenv.mkDerivation: public -> finalPackageRobert Hensing2022-05-021-1/+1
* | doc/using/overrides: Update for overlay style mkDerivation overrideAttrsRobert Hensing2022-05-021-2/+6
|/
* nixpkgs/doc: update overlay/lapack sectionMarkus Kowalewski2022-02-111-2/+18
* 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> Anders Kaseorg2021-11-041-1/+1
* nixpkgs/manual: add mvapich to overlays/mpi sectionMarkus Kowalewski2021-09-161-0/+2
* 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 Jan Tojnar2021-06-071-1/+1
* 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. Jan Tojnar2021-06-072-7/+7
* docs/using: shellSession -> ShellSession•••Co-authored-by: Jan Tojnar <jtojnar@gmail.com> fricklerhandwerk2021-04-252-6/+6
* doc/using: convert to markdownfricklerhandwerk2021-04-236-875/+609
* Remove repeating words from docFlorian Engel2021-03-141-1/+1
* doc: FormatRobert Hensing2021-03-042-155/+103
* 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>WORLDofPEACE2021-02-231-6/+6
* doc: fix syntax error in BLAS/LAPACK overlay example•••Attribute-values pairs were not properly terminated by a semicolon. Daniël de Kok2021-02-121-2/+3
* doc: remove mentions of flashplayerBernardo Meurer2021-02-081-2/+2
* nixpkgs/manual: add a paragraph about MPI switching mechanismMarkus Kowalewski2021-01-231-0/+35
* 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. Profpatsch2021-01-111-2/+2
* 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. zimbatm2020-11-301-0/+1
* doc: clarify whitelistedLicenses•••see the following for more info: https://github.com/NixOS/nixpkgs/blob/076860e0340a5e4a909b9a710e186508b14d1c90/pkgs/stdenv/generic/check-meta.nix#L229 Graham Bennett2020-11-281-0/+3
* doc: Improve code listings•••By adding prompts and removing unnecessary indentation. Jan Tojnar2020-09-232-9/+9
* doc/using/overlays.xml: add BLISDaniël de Kok2020-09-071-5/+19
* doc/using/overlays.xml: fix some small glitchesDaniël de Kok2020-08-101-7/+9
* doc/using/overlays.xml: add AMD BLIS/LIBFLAME to the BLAS/LAPACK listDaniël de Kok2020-08-101-0/+13
* 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 Jan Tojnar2020-07-051-2/+2
* Fix typos in documentation (#91934)Sami Bouhlel2020-07-011-3/+3
* nixos/manual: spelling s/environent/environment/g in configuration.xmlNicolas Berbiche2020-06-081-1/+1
* doc/using/overlays.xml: update LD_LIBRARY_PATH exampleBenjamin Hipple2020-04-221-1/+1
* 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. Matthew Bauer2020-04-221-10/+21