about summary refs log tree commit diff
path: root/doc/using
AgeCommit message (Collapse)AuthorFilesLines
2023-11-11treewide: fix redirected and broken URLsAnthony Roussel1-1/+1
Using the script in maintainers/scripts/update-redirected-urls.sh
2023-11-09doc: avoid 'simply' (#266434)Arnout Engelen1-1/+1
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-10-02doc: minimal documentation of supported platformsLorenzo Manacorda1-0/+18
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-09-14doc: link, instead of just mentioning, Nix manual (#255126)asymmetric1-1/+1
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-07-03Merge pull request #239636 from pennae/nixpkgs-manual-nrdpennae1-2/+4
doc: dedocbookify nixpkgs manual
2023-07-01doc: pull option docs out of doc-supportpennae1-1/+1
this leaves doc-support as a simple wrapper around function docs. this wrapper will go away very soon as well.
2023-07-01doc: render nixpkgs manual with nrdpennae1-2/+4
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-01doc/using/overrides: Relate addition to preceding textRobert Hensing1-1/+3
2023-06-30doc/using/overrides: it is possible to use previous arguments in .overrideArtturin1-0/+6
2023-06-30stdenv: let overrideAttrs accept attrset OR functionArtturin1-4/+12
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-01-01lib/customisation.overrideDerivation: propagate evaluation conditionNaïm Favier1-1/+1
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`.
2022-12-27doc,nixos/doc: unescape double quotesNaïm Favier1-1/+1
Leftovers from the CommonMark conversion.
2022-12-04doc: use sri hash syntaxColin Arnott1-2/+2
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-11-29doc: Use POSIX syntax to source fileVictor Engmark1-1/+1
Avoids bashism in case another shell is active.
2022-11-29doc: Quote variable referencesVictor Engmark1-5/+5
2022-11-29doc: Fix grammarVictor Engmark1-1/+1
2022-07-28nixpkgs/doc: remove unused `unfree.xml`Arnout Engelen1-0/+5
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.
2022-06-12doc: Promote config Options Reference to sub-chapter sectionRobert Hensing1-8/+9
It was hidden in the insecure packages section. - Lift it out. - Add an id
2022-05-19Merge pull request #171163 from hercules-ci/nixpkgs-config-docRobert Hensing1-0/+8
Add generated `nixpkgs.config` doc to Nixpkgs manual
2022-05-02doc: Add Nixpkgs config options referenceRobert Hensing1-0/+8
2022-05-02stdenv.mkDerivation: public -> finalPackageRobert Hensing1-1/+1
2022-05-02doc/using/overrides: Update for overlay style mkDerivation overrideAttrsRobert Hensing1-2/+6
2022-02-11nixpkgs/doc: update overlay/lapack sectionMarkus Kowalewski1-2/+18
2021-11-04treewide: Fix unsafe concatenation of $LD_LIBRARY_PATH, round 2Anders Kaseorg1-1/+1
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-09-16nixpkgs/manual: add mvapich to overlays/mpi sectionMarkus Kowalewski1-0/+2
2021-06-07doc: Use markdown syntax for xrefsJan Tojnar1-1/+1
Syntax is taken from MyST: https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing
2021-06-07doc: prepare for commonmarkJan Tojnar2-7/+7
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-04-25docs/using: shellSession -> ShellSessionfricklerhandwerk2-6/+6
Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
2021-04-23doc/using: convert to markdownfricklerhandwerk6-875/+609
2021-03-14Remove repeating words from docFlorian Engel1-1/+1
2021-03-04doc: FormatRobert Hensing2-155/+103
2021-02-23stdenv/check-meta: change to allowlist and blocklist (#114127)WORLDofPEACE1-6/+6
* 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-12doc: fix syntax error in BLAS/LAPACK overlay exampleDaniël de Kok1-2/+3
Attribute-values pairs were not properly terminated by a semicolon.
2021-02-08doc: remove mentions of flashplayerBernardo Meurer1-2/+2
2021-01-23nixpkgs/manual: add a paragraph about MPI switching mechanismMarkus Kowalewski1-0/+35
2021-01-11doc: stdenv.lib -> libProfpatsch1-2/+2
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.
2020-11-30tree-wide: do not use pkgs.extend in nixpkgszimbatm1-0/+1
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-28doc: clarify whitelistedLicensesGraham Bennett1-0/+3
see the following for more info: https://github.com/NixOS/nixpkgs/blob/076860e0340a5e4a909b9a710e186508b14d1c90/pkgs/stdenv/generic/check-meta.nix#L229
2020-09-23doc: Improve code listingsJan Tojnar2-9/+9
By adding prompts and removing unnecessary indentation.
2020-09-07doc/using/overlays.xml: add BLISDaniël de Kok1-5/+19
2020-08-10doc/using/overlays.xml: fix some small glitchesDaniël de Kok1-7/+9
2020-08-10doc/using/overlays.xml: add AMD BLIS/LIBFLAME to the BLAS/LAPACK listDaniël de Kok1-0/+13
2020-07-05licenses: Make single-version-only GPL explicitJan Tojnar1-2/+2
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-01Fix typos in documentation (#91934)Sami Bouhlel1-3/+3
2020-06-08nixos/manual: spelling s/environent/environment/g in configuration.xmlNicolas Berbiche1-1/+1
2020-04-22doc/using/overlays.xml: update LD_LIBRARY_PATH exampleBenjamin Hipple1-1/+1
2020-04-22doc/overlays.xml: fix missing documentation for blas/lapackMatthew Bauer1-10/+21
This adds some more information to the documentation as well as addressing review from https://github.com/NixOS/nixpkgs/pull/85636.
2020-04-21doc/overlays.xml: update documentation for BLAS/LAPACKMatthew Bauer1-1/+39
This expands the documentation and explains how to assert LP64.
2020-04-20doc/overlays.xml: add information on BLAS/LAPACK switchingMatthew Bauer1-0/+76
2019-11-24Merge branch 'wrapper-pname-support-19.09' into wrapper-pname-supportJohn Ericson1-1/+1