Commit graph

2547 commits

Author SHA1 Message Date
pennae
e42a5c78e7 doc: make sure section depths are consecutive
skipping heading levels (eg from # to ###, or starting at ###) is legal
in pandoc, but not in nixos-render-docs. pandoc acts as though section
levels *were* consecutive, nixos-render-docs prefers to tell people not
to do that kind of thing because it can make documents more fragile.
2023-06-10 18:17:04 +02:00
pennae
830f5b33dd doc: add missing section IDs 2023-06-10 18:17:04 +02:00
7c6f434c
e4d2ceab3d
Merge pull request #234201 from 7c6f434c/fix-untagged-version
coding-conventions: include the preceding upstream version
2023-06-08 14:36:01 +00:00
Basile Clément
66f57b6c18
Improve fetchFromGitLab manual (#236111)
* doc/builders: update fetchers documentation

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-06-07 10:51:48 +02:00
Julian Arni
858583a958
doc/language-frameworks/haskell: fix argument order of setBuildTargets (#236252) 2023-06-06 18:28:23 +02:00
figsoda
2bfb2f045a pypi2nix: remove
It has been broken since 2021 and upstream has been archived
2023-06-03 16:44:43 +02:00
Michael Raskin
5b90f7a6a9 coding-conventions: include the preceding upstream version when packaging a commit without a version attached 2023-06-02 13:27:25 +02:00
Alyssa Ross
caa0a24ab0 doc: clarify that meta.timeout is only for Hydra
I read this and expected it to be a timeout that was always applied
when building the derivation, but it's actually a Hydra-specific
thing.
2023-05-30 10:27:44 +00:00
github-actions[bot]
53e76520b9
Merge master into haskell-updates 2023-05-28 00:14:04 +00:00
Yueh-Shun Li
48c5962048 doc/language-frameworks/go.section.md: fix spelling
Change "platform dependant" to "platform-dependent"

The word "dependant" (with suffix -ant) is used as a noun
in British English, while the adjetive is "dependent" (-ent).
Both are "dependent" in American English.

Reference:
https://www.merriam-webster.com/words-at-play/spelling-variants-dependent-vs-dependant
https://dictionary.cambridge.org/dictionary/english/dependant
2023-05-28 07:50:02 +10:00
github-actions[bot]
490b8d0c9a
Merge master into haskell-updates 2023-05-27 00:13:30 +00:00
Rebecca Turner
ec2938bfa5
Document incremental build support for Haskell 2023-05-25 14:36:18 -07:00
Rebecca Turner
33258207fa
maintainers: Gabriel439 -> Gabriella439 2023-05-25 14:35:51 -07:00
Connor Baker
222d966273 cudaPackages.cudnn: remove patch version from name to conform with cudaPackages standard 2023-05-24 12:56:22 -04:00
Atemu
3009b12817 doc:fhs-envs: reword 2023-05-22 11:34:04 -03:00
Atemu
e57efc6cb7 doc:fhs-envs: format example properly
That sort of formatting wouldn't be accepted into Nixpkgs. We shouldn't format
an example like that.
2023-05-22 11:34:04 -03:00
Atemu
8912c50fc7 doc:fhs-envs: mention that runScript must be escaped by the caller 2023-05-22 11:34:04 -03:00
figsoda
999652eb33 doc/python: remove usages of fetchPypi aliases 2023-05-21 11:28:13 -04:00
Nicolas Benes
142c24711e doc: fix typo 2023-05-20 22:09:52 +02:00
Martin Weinelt
b0a993e6ba
Merge pull request #232594 from mweinelt/python-docs
doc/languages-frameworks/python: update formatting and interpreters
2023-05-20 21:02:31 +02:00
Martin Weinelt
35650d8be3
doc/languages-frameworks/python: update formatting and interpreters
Updates all interpreter references with 3.10/3.11, which are the
current version, that we recurse into for their package set.

Update all code examples with an explicit `format` and expand lists
with multiple items as we do in the python package set. Also set
`pythonImportsCheck` where tests are disabled.
2023-05-20 03:31:35 +02:00
Jan Tojnar
8bf1967964 doc/stdenv/Dependencies: fix inference rule var name
t0 is mentioned in the conclusion so we cannot use placeholder in the premise.
2023-05-18 18:10:10 +02:00
Alyssa Ross
5e06b3cb19 treewide: don't use rustPlatform.rust
This will be deprecated in the next commit.
2023-05-12 15:31:21 +00:00
Jacek Galowicz
cc8e4ed375
Merge pull request #225313 from hercules-ci/testers-runNixOSTest
testers.runNixOSTest: init
2023-05-12 16:04:26 +02:00
Kira Bruneau
d4652d33d6
Merge pull request #229770 from Misterio77/init-buildDartPackage
buildDartApplication: init
2023-05-11 14:43:20 -04:00
Robert Hensing
ac1134f321 testers.runNixOSTest: init
An up to date alternative to pkgs.nixosTest
2023-05-11 19:12:07 +02:00
Weijia Wang
ee5b4b9d52
Merge pull request #231112 from farnoy/shortenPerlShebangs-manual-buildInputs
doc: update shortenPerlShebang example to use nativeBuildInputs
2023-05-10 22:38:11 +03:00
Hraban Luyat
7282c4012d docs: typo in cuda docs, forgot a colon (:) 2023-05-10 14:32:27 -04:00
Jakub Okoński
9948a0d6c9
doc: update shortenPerlShebang example to use nativeBuildInputs 2023-05-10 18:34:17 +02:00
Robert Hensing
216315c6c4
Merge pull request #197547 from hercules-ci/module-class-and-flake-import
module system: Improve error messages around faulty imports
2023-05-06 20:16:34 +02:00
figsoda
955f4f6512
Merge pull request #230177 from SuperSandro2000/lib-fromJSON-2
treewide: switch builtins.fromJSON(builtins.readFile ./file.json) to …
2023-05-06 14:12:43 -04:00
Robert Hensing
eab660d91e lib.modules: configurationClass -> class
This simplifies the documentation. `configuration` is implied by `_type`.
2023-05-06 18:32:59 +02:00
Robert Hensing
89491bef8d lib.modules: in evalModules return move _module.class -> configurationClass 2023-05-06 18:32:59 +02:00
Robert Hensing
4c7aa7d831 doc/module-system: _module is not internal 2023-05-06 18:32:59 +02:00
Robert Hensing
fd88c79418 lib.modules: Change class declaration in module to _class 2023-05-06 18:32:59 +02:00
Robert Hensing
8054785157 lib/modules: Move class out of specialArgs 2023-05-06 18:32:58 +02:00
Robert Hensing
8f02e95aff module-system.chapter.md: Elaborate on extendModules performance 2023-05-06 18:32:58 +02:00
Robert Hensing
5fac39307d module-system.chapter.md: Add mental model to type and extendModules 2023-05-06 18:32:58 +02:00
Robert Hensing
03a465f048 fixup! doc: Add Module System chapter start 2023-05-06 18:32:12 +02:00
Robert Hensing
ee1e14be0c doc: Add Module System chapter start 2023-05-06 18:29:05 +02:00
Robert Hensing
79703eef08 nixos,nixpkgs: Add module classes
This allows modules that declare their class to be checked.
While that's not most user modules, frameworks can take advantage
of this by setting declaring the module class for their users.
That way, the mistake of importing a module into the wrong hierarchy
can be reported more clearly in some cases.
2023-05-06 18:29:04 +02:00
Sandro Jäckel
00000001b4
treewide: switch builtins.fromJSON(builtins.readFile ./file.json) to lib.importJSON ./file.json #2 2023-05-06 16:20:13 +02:00
Et7f3
caf436a52b ocamlPackages.buildDunePackage: deprecate useDune2 2023-05-06 08:11:25 +02:00
Gabriel Fontes
d161ef5631
buildFlutterApplication: add docs 2023-05-05 13:32:50 -03:00
Gabriel Fontes
782c8b44dd
buildDartApplication: init
This adds a function for easily packaging non-flutter dart apps.
2023-05-05 13:32:45 -03:00
Adam Joseph
ed312cb4f7
doc/default.nix: make the manual build on more than one core (#225921)
* doc/default.nix: make the manual build on more than one core

Let's build the manual with more than one core.  Maybe people will take better care of it now that it is less painful to build.
2023-04-25 14:37:50 +02:00
Sandro Jäckel
aad577bd30 nodejs*: normalise names to better fit other packages
Versioned package attributes are usually named like $pname_$version
eg: nodejs-14_x -> nodejs_14
2023-04-25 11:28:17 +02:00
Adam Joseph
372e0f8efc
doc/stdenv/meta.chapter.md: document meta.badPlatforms (#225276)
* doc/stdenv/meta.chapter.md: document meta.badPlatforms

We don't have any documentation for the `meta.badPlatforms` attribute.

This commit adds documentation for it.
2023-04-24 10:06:50 +02:00
Adam Joseph
8669061b61
Merge pull request #225272 from amjoseph-nixpkgs/pr/docs/broken-vs-badPlatforms
doc/stdenv/meta.chapter.md: explain difference between broken and badPlatforms
2023-04-24 05:09:01 +00:00
Adam Joseph
75bbbbd39b remove trailing whitespace 2023-04-23 21:32:40 -07:00
Adam Joseph
401430319c
Update doc/stdenv/meta.chapter.md
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-04-24 04:31:38 +00:00
Adam Joseph
467ee31e58
Update doc/stdenv/meta.chapter.md
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-04-24 04:30:37 +00:00
sternenseemann
2fe11e6fee haskell.compiler.ghc94: 9.4.4 -> 9.4.5
https://www.haskell.org/ghc/blog/20230418-ghc-9.4.5-released.html
2023-04-22 17:47:11 +02:00
Doron Behar
a82c8611ce
buildGoModule: don't inherit build hooks when building go-modules (#225349)
* buildGoModule: don't inherit postBuild hook when building go-modules

This is a slight revert of 5ce647b8bf
(#212800).

Inheriting these hooks in the `.go-modules` derivation can be confusing:
One doesn't expect them to run when generating the fixed output modules
derivation, but only on the main derivation. A `postBuild` hook that
adds some files to $out will cause a very hard to debug issue[1].

This commit adds support for a dedicated `modPostBuild` hook that will
be used only by the derivation building `.go-modules`. Additionally,
`go.section.md` now explains these attributes behavior better.

[1]:
https://discourse.nixos.org/t/cant-update-a-go-package-getting-go-inconsistent-vendoring/27063/6

Co-authored-by: Sandro <sandro.jaeckel@gmail.com>
2023-04-22 11:08:54 +10:00
Atemu
445ef28548
Merge pull request #225748 from Atemu/buildFHSEnvBubblewrap-by-default
buildFHSEnv: use bubblewrap by default
2023-04-16 13:03:36 +02:00
Atemu
f63a12f296 tree-wide: buildFHSUserEnv -> buildFHSEnv 2023-04-16 10:15:13 +02:00
gilice
5d20d9ff9f doc/stdenv: don't use name in examples, highlight preferring pname 2023-04-15 16:06:29 +02:00
Matthieu Coudron
351cec5db3
use subcommands in plugin updaters (#223164)
* update.py: introduce subparsers for plugin updaters

This is preliminary work to help create more powerful plugin updaters.
Namely I would like to be able to "just add" plugins without refreshing
the older ones (helpful when github temporarily removes a user from
github due to automated bot detection).

Also concerning the lua updater, we pin some of the dependencies, and I
would like to be able to unpin the package without editing the csv
(coming in later PRs).

* doc/updaters: update command to update editor plugins

including vim, kakoune and lua packages

Co-authored-by: figsoda
2023-04-14 22:02:17 +02:00
Andrew Morgan
a95ed9fe76
Fix a small typo in the manual
environements -> environments
2023-04-14 17:11:13 +01:00
Silvan Mosberger
83c76b9237
Merge pull request #226057 from tweag/fix-function-location-revision
doc: Fix the function locations always pointing to master
2023-04-14 17:17:46 +02:00
Valentin Gagarin
18ffde7567
Merge pull request #197247 from kip93/vmTools-docs
Documentation: add vmTools
2023-04-14 00:30:10 +02:00
Adam Joseph
756e220e1e doc/.gitignore: add media
These files are generated when you run `nix-shell --command make`
and are likely to be committed by accident.  Let's help people avoid
that.
2023-04-13 12:24:04 -07:00
Silvan Mosberger
019fd45537 doc: Fix the function locations always pointing to master
Instead of revisions as they should. This is (most-likely) caused by a
simple typo, because Hydra is where the revision should come from, but
it doesn't set `.revision` as the attribute, but rather `.rev`!
2023-04-13 20:33:39 +02:00
Adam Joseph
19d48a9257 doc/stdenv/meta.chapter.md: explain difference between broken and badPlatforms
There has been a longstanding ambiguity between `broken` and
`badPlatforms`, which seem to serve overlapping purposes.

This commit adds to the documentation two examples of constraints
which cannot be expressed by `platforms` and `badPlatforms`.

This commit also mentions `NIXPKGS_ALLOW_BROKEN=1` for overriding
`broken`.
2023-04-11 13:21:51 -07:00
geri1701
8cbf65ece9
Fix typo in coding-conventions.chapter.md 2023-04-11 21:05:56 +02:00
Dmitry Kalinkin
df3bf8ff76
Merge pull request #218331 from xworld21/texlive-new-dependency-resolution
texlive.combine: move dependencies to attribute tlDeps, resolve them …
2023-04-09 23:59:45 -04:00
Leandro Emmanuel Reina Kiperman
a6c19474bd Update vmTools docs after rebase 2023-04-10 00:43:31 +02:00
Leandro Reina
6c4d780599 Remove unused reference 2023-04-09 21:56:55 +02:00
Leandro Reina
0eff947d0b doc: add vmTools 2023-04-09 21:55:50 +02:00
Geraint Ballinger
8b2521bdae
nixos/darwin-builder: add disk space options (#224480) 2023-04-07 05:10:49 +02:00
figsoda
e7e93bd709 docs/rust: prefer ln -s over cp 2023-04-04 21:21:28 -04:00
7c6f434c
8ce248a734
Merge pull request #218870 from Uthar/lisp2
lisp-modules: replace with an implementation based on github:uthar/nix-cl
2023-04-03 06:00:48 +00:00
Vincenzo Mantova
57b2634ac1 texlive.combine: document how to create custom packages with pkgs and tlDeps attributes 2023-04-02 13:00:52 +01:00
ajs124
800426cf64
Merge pull request #222422 from mdarocha/remove-dotnet-3
dotnet-sdk_3: remove
2023-03-29 16:13:25 +02:00
Kasper Gałkowski
9a26e2dea9 merge master 2023-03-28 19:43:40 +02:00
pennae
052bb41410 doc: assign ids to many headings
without stable ids on headings we cannot generate stable links to these
headings. nrd complains about this, but the current docbook workflow
does not.

a few generated ids remain, mostly in examples and footnotes. most of
the examples are generated by nixdoc (which has since gained MD export
functions, and the MD export does generate IDs).
2023-03-27 22:39:11 +02:00
mdarocha
43f7cc0df7 dotnet-sdk_3: remove
Also remove all reference to outdated .NET versions.
2023-03-26 14:24:49 +02:00
Yureka
f3a1640e49 docs/rust: add note about git dependencies 2023-03-26 01:52:04 +01:00
superherointj
441cbfcfd2 erlang: normalize version name 2023-03-21 16:12:05 -04:00
Kasper Gałkowski
fdabf61974 lisp-modules: manual: add self links 2023-03-21 19:38:26 +01:00
Valentin Gagarin
99c5413961
Merge pull request #200951 from jtojnar/docs-update-script-commit-feature
docs/stdenv: Document updateScript features
2023-03-21 12:50:35 +01:00
Jan Tojnar
90074803e6 docs/stdenv: Document updateScript features
This was removed in c1b05442ff
for stabilization but it has worked quite well.
2023-03-21 11:59:08 +01:00
Jan Tojnar
d0e8c7087d docs/stdenv: Document updateScript execution 2023-03-21 11:59:08 +01:00
superherointj
1f24ebb428 elixir-ls: rename elixir_ls to elixir-ls 2023-03-20 17:57:35 -04:00
mdarocha
d093086a2b buildDotnetModule: add support for using combinePackages as dotnet-sdk
This allows packages that require several dotnet versions to build (like
BeatSaberModManager) to properly depend on the dotnet-sdk specific deps.
This in turns avoids having to regenerate the deps of those packages
after each dotnet-sdk update.

This also changes nuget-to-nix to accept a file with a list of
exclusions instead of a folder.
2023-03-19 20:53:39 +01:00
Adam Joseph
812b74cf0b
Merge pull request #187919 from amjoseph-nixpkgs/pr/manual/rust/buildRustX
doc/../rust.section.md: fix incorrect header depths
2023-03-19 09:30:14 +00:00
Adam Joseph
e369d78b70 remove references to crate2nix other than a link to its docs 2023-03-17 12:13:13 -07:00
Adam Joseph
618d8e6a62
Update doc/languages-frameworks/rust.section.md
Co-authored-by: Jörg Thalheim <Mic92@users.noreply.github.com>
2023-03-17 19:10:15 +00:00
Adam Joseph
4716768513
Update doc/languages-frameworks/rust.section.md
Co-authored-by: Jörg Thalheim <Mic92@users.noreply.github.com>
2023-03-17 19:09:50 +00:00
Bernardo Meurer
bae66663b2
Merge pull request #221645 from raboof/doc-stdenv-add-quotes-for-phases-with-newlines 2023-03-17 13:14:43 -03:00
Arnout Engelen
8ad8f9d266
doc/stdenv: add quotes to run phases with newlines
Without quotes newlines in environment variables get converted to spaces,
so any overridden phases would not work.
2023-03-17 13:30:57 +01:00
Adam Joseph
50f57ac692 doc/../rust.section.md: fix incorrect header depths
The headings for the Rust section are structured incorrectly in two ways:

1. The section "Compiling non-Rust packages that include Rust code" is totally specific to `buildRustPackage`.  It should be a child of the "Compiling Rust applications with Cargo" section.
1. The section "Setting up `nix-shell`" is totally specific to `buildRustCrate`.  It should be a child of the "Compiling Rust crates using Nix instead of Cargo" section.

- Rust
  - Compiling Rust applications with Cargo
    - ...
  - Compiling non-Rust packages that include Rust code
    - ...
  - Compiling Rust crates using Nix instead of Cargo
    - ...
  - Setting Up `nix-shell`
    - ...

- Rust
  - Compiling Rust applications with Cargo
    - ...
    - Compiling non-Rust packages that include Rust code
      - ...
  - Compiling Rust crates using Nix instead of Cargo
    - ...
    - Setting Up `nix-shell`
      - ...
2023-03-15 19:42:54 -07:00
Adam Joseph
efbbdc16e6 Revert "carnix,cratesIO: remove" in doc/languages-frameworks/rust.section.md
This reverts the part of commit
82fe76d1cd that affected
doc/languages-frameworks/rust.section.md
2023-03-15 19:41:48 -07:00
Kasper Gałkowski
e5eb0322a2 merge master 2023-03-14 17:07:39 +01:00
Martin Weinelt
bb14c4255b Merge remote-tracking branch 'origin/master' into staging-next 2023-03-13 17:14:19 +00:00
Vladimír Čunát
1dd94ad62f
Merge branch 'master' into staging-next 2023-03-12 09:06:28 +01:00
github-actions[bot]
f2032fa12b
Merge master into haskell-updates 2023-03-12 00:13:51 +00:00
Alyssa Ross
e636a55c15 doc: document fetchpatch's decode argument 2023-03-11 21:39:29 +00:00
Kasper Gałkowski
dae0dca5d1 lisp-modules: second version of wrapLisp
The previous approach of trying to make both the `override` mechanism from
`mkDerivation` and the `overrideScope'` mechanism from `newScope` work together
resulted in hard to understand code, and there was a bug where once overridden
packages would lose the changes on next override with `packageOverrides`.

It's not ideal still, because Lisps created by `mkDerivation` will lose their
`pkgs` after using `override`.
2023-03-11 19:09:25 +01:00
Kasper Gałkowski
84eea85ad9 lisp-modules: use wrapLisp to wrap Lisps
The previous approach of manually repeating a complex pattern inside Common Lisp
implementation package declarations was fragile and hard to change. After
reading python and lua modules code in Nixpkgs, I was able to come up with
something better.

The function `wrapLisp` doesn't need to be inside package declarations so all
the code for wrapping Lisps can be in `all-packages.nix`.

This works by wrapping the `override` function created from `mkDerivation` to
accept a new argument `packageOverrides`.

One problem with this is that `override.__functionArgs` disappears. But one can
look at the source code of a package to discover what can be overridden.
2023-03-11 15:11:38 +01:00