Commit graph

2577 commits

Author SHA1 Message Date
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
Kasper Gałkowski a0bdaf345b lisp-modules: replace "_" in package names with "__" for reversibility 2023-03-10 20:10:39 +01:00
github-actions[bot] 4bda2ab514
Merge master into haskell-updates 2023-03-09 00:13:40 +00:00
github-actions[bot] 7072ae38b6
Merge master into staging-next 2023-03-08 18:01:34 +00:00
figsoda 37094157ea
Merge pull request #219447 from figsoda/docs 2023-03-08 12:33:56 -05:00
github-actions[bot] 8749e1376b
Merge master into haskell-updates 2023-03-05 00:16:36 +00:00
github-actions[bot] 8480c21d06
Merge master into staging-next 2023-03-04 12:01:17 +00:00
Ryan Lahfa 0397ee1113
Merge pull request #218043 from addict3d/parameterise-guest-memsize-1
nixos/lib/make-disk-image: expose memSize parameter
2023-03-04 11:25:23 +01:00
figsoda b373d299ba docs/rust: improve docs for nightly usage 2023-03-03 22:46:28 -05:00
Kasper Gałkowski 092acca8b3 lisp-modules: make ql-import.lisp automatically pull the latest Quicklisp dist 2023-03-02 19:04:47 +01:00
Kasper Gałkowski 7a1ccaa997 lisp-modules: Add manual section 2023-03-02 19:04:41 +01:00
sternenseemann b7d8c46302 haskellPackages.ghc: 9.2.6 -> 9.2.7
https://www.haskell.org/ghc/blog/20230227-ghc-9.2.7-released.html

Also updates some of the printouts in the manual. We should probably
make it clear in the text that these may be outdated, since we are doing
a terrible job keeping up…
2023-03-01 18:41:14 +01:00
github-actions[bot] 40707bbbb3
Merge staging-next into staging 2023-02-27 18:02:06 +00:00
Artturi 1c6a1e5650
Merge pull request #218500 from alyssais/pythonForBuild 2023-02-27 18:17:27 +02:00
github-actions[bot] 288c9d7892
Merge staging-next into staging 2023-02-27 06:01:44 +00:00
Martin Weinelt 0d09b95ad1 doc/python: Explain opt-out out of bulk updates 2023-02-27 02:21:07 +00:00
Alyssa Ross 2bfa93e01c
treewide: python{ => .pythonForBuild}.interpreter
It won't be enough to fix cross in all cases, but it is in at least
one: pywayland.  I've only made the change in cases I'm confident it's
correct, as it would be wrong to change this when python.interpreter
is used in wrappers, and possibly when it's used for running tests.
2023-02-26 20:26:17 +00:00
Nick Bathum 59462da917
nixos/lib/make-disk-image: expose memSize parameter
Generating large disk images can fail from out-of-memory in vm-run.
2023-02-26 12:08:58 -05:00
github-actions[bot] 55aecca307
Merge staging-next into staging 2023-02-24 00:02:56 +00:00
github-actions[bot] 7fb1a9172f
Merge master into staging-next 2023-02-24 00:02:22 +00:00
Weijia Wang a395950650
Merge pull request #217870 from Artturin/envfixes1
rPackages,emscriptenPackages: s/overrideDerivation/overrideAttrs
2023-02-23 20:49:53 +02:00
Valentin Gagarin ac573e5046
Merge pull request #217865 from ncfavier/doc-ignore-result
doc: add `result` to .gitignore
2023-02-23 19:04:17 +01:00
github-actions[bot] 3cdd771820
Merge staging-next into staging 2023-02-23 18:01:49 +00:00
Naïm Favier 07ee3496ca
doc: add result to .gitignore
Ensure the local `result` symlink from an earlier build isn't copied to
the store.
2023-02-23 18:41:42 +01:00
Artturin 06567334be emscriptenPackages: s/overrideDerivation/overrideAttrs
https://nixos.org/manual/nixpkgs/stable/#sec-pkg-overrideDerivation

> Do not use this function in Nixpkgs as it evaluates a Derivation before modifying it, which breaks package abstraction and removes error-checking of function arguments
2023-02-23 18:45:38 +02:00
Alyssa Ross 52c286ee5b
Merge remote-tracking branch 'origin/master' into staging-next
Conflicts:
	pkgs/development/libraries/pmdk/default.nix
2023-02-23 13:51:34 +00:00
Artturin 6b2a05e190 treewide: manual fixups for
treewide: use toString on list NIX_CFLAGS_COMPILE
treewide: move NIX_CFLAGS_COMPILE to the env attrset
2023-02-22 21:23:04 +02:00
Artturi cdcca1cdcd
Merge pull request #215715 from Artturin/removegirworkarounds2 2023-02-18 20:12:57 +02:00
github-actions[bot] 05782cfb75
Merge master into staging-next 2023-02-18 18:01:22 +00:00
maralorn b5fa92b2e6 doc/haskell: Add clarifications in section about versions 2023-02-18 15:15:11 +01:00
Artturin cadffcfe50 treewide: remove issue #56943 workarounds
checked with diffoscope+difflog and launching the programs

i have fixed that issue in my other gir PRs
2023-02-17 20:26:13 +02:00
github-actions[bot] 1c50878b7b
Merge master into staging-next 2023-02-17 18:01:15 +00:00
Robert Hensing b72592ee04
Merge pull request #215973 from pennae/nrd-manual-structure
nixos/manual: specify manual structure in markdown
2023-02-17 18:01:23 +01:00
github-actions[bot] e6eaa85312
Merge master into staging-next 2023-02-17 00:02:11 +00:00
milahu 121fbb3cf7
docs: Building a stdenv package in nix-shell (#216650)
* docs: Building a stdenv package in nix-shell
2023-02-16 19:21:12 +01:00
github-actions[bot] bf5abe92d4
Merge master into staging-next 2023-02-15 18:01:14 +00:00
sternenseemann c5a0a5ac5e curl: add pkg-config metadata for libcurl.pc
I did not add the validatePkgConfig setup hook to curl, as I suspect it
may cause trouble when bootstrapping.
2023-02-15 13:52:15 +01:00
Alyssa Ross 200610b849
Merge remote-tracking branch 'origin/staging-next' into staging
Conflicts:
	pkgs/development/libraries/gtest/default.nix
	pkgs/development/libraries/hidapi/default.nix
2023-02-14 09:53:03 +00:00
superherointj a7fb18c804 beam/fetchMixDeps: disable --only flag when mixEnv is empty
* mixEnv being empty will include all dependencies.
2023-02-14 00:36:31 -05:00
pennae bfc6975cbc nixos/manual: remove holdovers from docbook times
these files provided mainly or exclusively xml-related tooling and
support for editing the manual. since docbook is now an implementation
detail (except for still being allowed in option docs, for now) these
tools are no longer necessary, useful, or even functional.

xmlformat.conf is still used by the nixpkgs documentation, so we have to
keep it. there's no reason it can't go live with the nixpkgs docs though.
2023-02-12 14:23:38 +01:00
Artturi aaa9ea8ec6
Merge pull request #208537 from Artturin/makesetuphooksupportstrictdeps 2023-02-10 20:08:32 +02:00
Guillaume Girol 0a598d6ea5
doc: add a simpler explanation of dependencies (#213403)
Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
Co-authored-by: pennae <82953136+pennae@users.noreply.github.com>
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-02-10 18:41:31 +01:00
pennae d041641b1a nixos/manual: remove md-to-db
with manual chapters no longer needing pandoc for their conversion to
xml we can get rid of this source of confusion, and its huge cache of
xml files.
2023-02-10 06:40:15 +01:00
pennae 1c9f55ec64 nixos/manual: convert <kbd> elements to bracketed spans
since support for kbd elements was added with explicit intent in #175128
it seems like a good idea to support this in nixos-render-docs instead
of just dropping it in favor of `*F12*` etc. since it's a very rare
thing in the manual and purely presentational it makes sense to use
bracketed spans instead of a new myst role.

the html-elements.lua plugin is now somewhat misnamed, but it'll go away
very soon so we don't want to bother renaming it.
2023-02-10 06:40:01 +01:00
pennae a15d7335a5 nixos/manual: remove .title fenced divs
pandoc drops .title classes when rendering to docbook, so these are
effectively just paragraphs anyway. without support for including them
in a table of contents the complexity of parsing them in
nixos-render-docs won't be warranted.
2023-02-10 06:40:00 +01:00
Tom McLaughlin 700e6e588e Doc tweak: "Build" -> "Substitute" 2023-02-07 16:17:52 -08:00
Tom McLaughlin d1a2a16a3a Introduce mkBinaryCache function 2023-02-07 16:16:07 -08:00
Valentin Gagarin a2cef3dfbf
Merge pull request #215181 from SuperSandro2000/contributing-pname 2023-02-07 21:48:25 +01:00
Sandro Jäckel fcfa4dd73b
doc/contributing: remove last references to name
pname+version should be used everywhere, so lets clean this up
2023-02-07 20:40:26 +01:00
Artturin 680309fc9c add docs for makeSetupHook 2023-02-07 21:02:02 +02:00
Valentin Gagarin 13088e285e
Merge pull request #215121 from ncfavier/doc-gitignore 2023-02-07 16:26:51 +01:00
Valentin Gagarin abef26ab3f
Merge pull request #215114 from ncfavier/fixup-212642 2023-02-07 16:25:27 +01:00
Naïm Favier 5a5decd2eb
doc: use gitignoreSource
Running `make -C doc` to build the manual locally leaves .xml artifacts
in the tree. These are ignored by git, but they still get included in
the build when not using flakes, which causes the corresponding chapters
not to be built.
2023-02-07 13:58:34 +01:00
Naïm Favier f98c4eac33
doc/stdenv: fixup #212642 2023-02-07 12:47:28 +01:00
John Ericson 6d0b3086f7
Merge pull request #214304 from obsidiansystems/pkg-config-meta
meta.pkgConfigModules: Init convention
2023-02-06 11:44:29 -05:00
Domen Kožar 3b837710a9
Merge pull request #214612 from stephank/feat/swift-docs
doc: add section on swift
2023-02-06 14:17:41 +01:00
Jason Yundt b1bb9bb6c8 treewide: fix backwards smart apostrophes
According to the Unicode Standard, you should use U+2019 RIGHT SINGLE
QUOTATION MARK for apostrophes [1]. Before this change, some of the text
in this repo would use U+2018 LEFT SINGLE QUOTATION MARKs instead.

[1]: https://www.unicode.org/versions/Unicode15.0.0/ch06.pdf#G12411
2023-02-06 07:24:42 -05:00
Linus Heckemann 59b752087d
Merge pull request #214763 from lheckemann/doc-requirefile
fetchers: document requireFile
2023-02-05 18:28:01 +01:00
Linus Heckemann 2e88127a0d fetchers: document requireFile 2023-02-05 15:33:51 +01:00
Stéphan Kochen cbc76260f7 doc: add section on swift 2023-02-04 22:30:10 +01:00
John Ericson 6e4a1b18d9 meta.pkgConfigModules: Init convention
See docs.

Follow-up work:

- Existing packages should be converted

- `defaultPkgConfigPackages` should assert on `meta.pkgConfigModules`
  and let `tests.pkg-config` alone test the build results.

CC @sternenseemann

Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2023-02-03 09:37:31 -05:00
André Schröder b2c8b539ac nixos/doc: fix typo in python.section.md 2023-02-01 23:00:16 +01:00
github-actions[bot] dd1ff149da
Merge master into staging-next 2023-01-31 00:02:31 +00:00
pennae 5b6dcece88
Merge pull request #212684 from pennae/nixos-render-docs
nixos-render-docs: init, use for some manual rendering to docbook
2023-01-30 19:26:07 +01:00
github-actions[bot] 1a06f52c21
Merge master into staging-next 2023-01-30 12:01:22 +00:00
Robert Hensing 663c41affd
Merge pull request #212282 from hercules-ci/pkg-config-packages
defaultPkgConfigPackages: init
2023-01-30 09:48:53 +01:00
Robert Hensing b6bec17eb9 testers.hasPkgConfigModule: Extract and add tests, docs 2023-01-30 00:35:34 +01:00
github-actions[bot] 7b3f0537af
Merge master into staging-next 2023-01-29 18:01:12 +00:00
Artturi c2e37a404c
Merge pull request #208793 from hadilq/androidenv/cmdline-tools-and-patcher
androidenv: Implement cmdline-tools and patcher
2023-01-29 18:11:41 +02:00
Robert Hensing a010129bf8 pkg-configPackages -> defaultPkgConfigPackages
This better reflects the purpose of the package set, while leaving
room for a fancier, more complete implementation of the concept,
with a nicer name.
2023-01-29 09:51:55 +01:00
Robert Hensing 159ad20b89 doc: Add pkg-config section 2023-01-29 09:51:54 +01:00