Commit Graph

2491 Commits

Author SHA1 Message Date
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
github-actions[bot]
d7f991bb53
Merge master into staging-next 2023-01-29 00:02:27 +00:00
Noah Fontes
3bec41fb5e
doc/python: fix attr name for unittestCheckHook flags
The name should end in Array per the current conventions.

This change also contains some minor formatting fixes, as the heading
levels were inconsistent.
2023-01-28 13:19:41 -08:00
Hadi
9c4e43ab70 androidenv: Implement cmdline-tools and patcher
- Replace cmdline-tools with tools because tools is obsolete now.
- Depend emulator package to systemImages

androidenv: fix issues on the PR

androidenv: reformat

androidenv: support excluding of `tools` package

androidenv: provide `tools`, and `build-tools`, dependencies

androidenv: replace includeTools with toolsVersion

androidenv: fix a typo

androidenv: add tests to check licenses and installed packages

androidenv: check if tests are running! this commit should fail!

androidenv: fix problems in the review https://github.com/NixOS/nixpkgs/pull/208793

androidenv: add test-suite to handle more tests around

androidenv: fix the test after couldn't running them with ofborg

Update pkgs/development/mobile/androidenv/build-tools.nix

Co-authored-by: Sandro <sandro.jaeckel@gmail.com>

androidenv: Resolving https://github.com/NixOS/nixpkgs/pull/208793#discussion_r1065851539

Update pkgs/development/mobile/androidenv/cmdline-tools.nix

Co-authored-by: Sandro <sandro.jaeckel@gmail.com>

Update pkgs/development/mobile/androidenv/tools.nix

Co-authored-by: Sandro <sandro.jaeckel@gmail.com>

androidenv: fix a typo
2023-01-27 18:15:47 -05:00
Martin Weinelt
52029b8e00 Merge remote-tracking branch 'origin/master' into staging-next 2023-01-27 23:50:36 +01:00
Guillaume Girol
b55a8d3ad6
Merge pull request #205646 from symphorien/ocamlconflict
ocamlPackages.findlib: detect conflicts of version early
2023-01-27 20:18:39 +00:00
pennae
0a6e6cf7e6 nixos/manual: render module chapters with nixos-render-docs
this converts meta.doc into an md pointer, not an xml pointer. since we
no longer need xml for manual chapters we can also remove support for
manual chapters from md-to-db.sh

since pandoc converts smart quotes to docbook quote elements and our
nixos-render-docs does not we lose this distinction in the rendered
output. that's probably not that bad, our stylesheet didn't make use of
this anyway (and pre-23.05 versions of the chapters didn't use quote
elements either).

also updates the nixpkgs manual to clarify that option docs support all
extensions (although it doesn't support headings at all, so heading
anchors don't work by extension).
2023-01-27 20:07:34 +01:00
Matthew Kenigsberg
2334404fb0 fix: doc typo 2023-01-26 16:45:59 -07:00
github-actions[bot]
578f1ba854
Merge master into staging-next 2023-01-26 18:01:29 +00:00
Naïm Favier
beb3d48b1e
Merge pull request #212642 from ncfavier/doc-check-phase 2023-01-26 14:47:53 +01:00
Naïm Favier
edb26159db
doc/stdenv: clarify default check target 2023-01-25 18:26:18 +01:00
github-actions[bot]
20df8d00cc
Merge master into staging-next 2023-01-25 12:01:34 +00:00
Nick Cao
0ea2d480e4
postgresqlTestHook: run postgresqlTestSetupPost hook after setting up 2023-01-25 18:46:27 +08:00
github-actions[bot]
7a89380b7e
Merge master into staging-next 2023-01-24 18:01:00 +00:00
Naïm Favier
4580a6608d
doc: fix broken links 2023-01-24 13:27:27 +01:00
Vladimír Čunát
411405c9f6
Merge branch 'master' into staging-next
Trivial conflict in release notes, except that the xml/docbook parts
are horrible for (semi-)automatic conflict resolution.
Fortunately that's generated anyway.
2023-01-24 12:22:38 +01:00
mdarocha
5234f4ce93 dotnet-sdk_5: remove package
It's EOL and not used in nixpkgs anymore
2023-01-23 19:16:58 +01:00
github-actions[bot]
44319c878e
Merge master into staging-next 2023-01-23 00:02:15 +00:00
Noah Snelson
a67632bda0 doc/langauge-frameworks/beam: fix broken link to elixir-ls 2023-01-22 17:24:48 -05:00
github-actions[bot]
feb2240b37
Merge master into staging-next 2023-01-22 18:01:03 +00:00
Naïm Favier
2f4e98edef doc/manpage-urls.json: add gnunet.conf 2023-01-21 18:08:38 +01:00
Naïm Favier
712b3371b6 doc/manpage-urls.json: add mpd 2023-01-21 18:08:38 +01:00
Guillaume Girol
d26caea94b doc: adapt to nativeCheckInputs 2023-01-21 16:42:10 +01:00
Guillaume Girol
90c78aee6c Merge branch 'nativeCheckInputs' into staging-nativeCheckInputs 2023-01-21 12:00:00 +00:00
Artturin
27fe8b4a39 cross-compilation.chapter.md: correct doCheck conditional 2023-01-20 22:17:19 +02:00
Robert Hensing
a1cd06f900
Merge pull request #211082 from hercules-ci/fix-issue-16182
Fix issue 16182  `Error: _assignFirst found no valid variant!`
2023-01-19 19:22:04 +01:00
Dominik Schrempf
eda69033eb
doc/haskell: nits
These are some suggested changes to the new documentation of Haskell in
the Nixpkgs manual. They cover sections until, but excluding, the
section "Available package versions". I am not an English native
speaker, so please correct me and savage these changes!

Also, please let me know if the suggestions are welcome, then I will
continue with the next chapter.
2023-01-18 07:17:46 +01:00
Robert Hensing
01d7f19346 multi-outputs.sh: Improve _assignFirst error message
Closes #16182

This improves the error message

    Error: _assignFirst found no valid variant!

which occurred when the set of outputs was not sufficient to set
the various outputDev, outputBin, etc variables. Specifically, this
would mean that "out" is not among the outputs, which is valid for
a derivation.

This changes the message to something like

    error: _assignFirst: could not find a non-empty variable to assign to outputDev. The following variables were all unset or empty: dev out.
          If you did not define an "out" output, make sure to define all the specific required outputs: define an output for one of the unset variables.

While this isn't a full explanation of what stdenv can and can not do,
I think it's vast improvement over the 0 bits of information that it
used to provide. This at least gives a clue as to what's going on, and
even suggests a fix, although probably multiple such fixes are required
in an instance where someone starts with a no-out derivation from scratch
(and decide to persist).
2023-01-16 12:57:01 +01:00
maralorn
fecbf169e2 haskell/docs: Fix a link 2023-01-15 22:15:40 +01:00
maralorn
26ef8978d8 haskell/docs: New sections about available versions and hls + Various small improvements
Co-authored-by: sternenseemann <sternenseemann@systemli.org>
2023-01-15 20:07:02 +01:00
sternenseemann
0a66465b22 doc/haskell: (re-)init haskell manual section
This restarts a Haskell section in the nixpkgs manual. The content
presented here has been written from scratch, although some parts of it
take inspiration from the existing haskell4nix documentation.

It is by no means complete, the idea is mostly to get the ball rolling
in some way. Upcoming tasks are hinted at in the comments in the
documentation file.
2023-01-14 22:33:35 +01:00
github-actions[bot]
79cb2f7e61
Merge master into staging-next 2023-01-14 11:12:34 +00:00
K900
3ae365afb8
Merge pull request #208867 from K900/qt-doc-fixes
treewide: remove outdated multiple versions of Qt stuff
2023-01-14 10:30:49 +03:00
github-actions[bot]
49722fd14a
Merge master into staging-next 2023-01-13 18:01:34 +00:00
K900
bf5a65096c pkgs/all-packages: remove unused alias, add comment 2023-01-12 20:51:24 +03:00
Martin Weinelt
c1e6c6af69 Merge remote-tracking branch 'origin/master' into staging-next 2023-01-11 03:51:33 +01:00
pennae
798b7fdc5c doc/filters: fix myst-reader role detection
matching on only `{...}` does not trigger if the role tag is preceded by
something usually considered a semantic separator that isn't a separator
as markdown knows it, e.g. punctuation characters.
2023-01-10 10:31:51 +01:00
Valentin Gagarin
5e07823679
Merge pull request #208252 from helsinki-systems/doc/doDist
doc/stdenv: Add information about the doDist variable
2023-01-10 03:53:48 +01:00
Valentin Gagarin
0a94eb26e4
Merge pull request #209493 from henrik-ch/overview_version
updating stable nixos version in preface.
2023-01-10 03:50:30 +01:00
github-actions[bot]
33aa224777
Merge master into staging-next 2023-01-09 18:01:24 +00:00
figsoda
90239b150c
Merge pull request #209569 from figsoda/maintainers
docs: prefer `maintainers: add` commits to be in the same pull request
2023-01-09 09:20:17 -05:00
github-actions[bot]
e4fc9a910a
Merge master into staging-next 2023-01-09 12:01:24 +00:00
Naïm Favier
bff4bb5540
Merge pull request #208762 from ncfavier/link-manpages-options-doc 2023-01-09 11:57:01 +01:00
Max Hausch
540c14338d
doc/stdenv: Add information about the doDist variable 2023-01-09 08:17:53 +01:00
figsoda
3d1afabefc docs: prefer maintainers: add commits to be in the same pull request 2023-01-07 17:00:32 -05:00
Henrik Karlsson
2d4103ae77 updating stable nixos version in preface. 2023-01-05 22:24:19 +00:00
github-actions[bot]
47507cf77a
Merge staging-next into staging 2023-01-04 06:01:44 +00:00
Valentin Gagarin
895a4d1cd1
Merge pull request #208868 from mweinelt/quick-start-deadlink 2023-01-04 06:49:32 +01:00
Gabriella Gonzalez
6d89aa8f1d
darwin.builder: auto-login as the builder user (#208772)
… as suggested by @NiklasGollenstede in:

https://github.com/NixOS/nixpkgs/pull/206951#issuecomment-1369020601

This simplifies the user experience for logging into and
debugging the machine and also simplifies the instructions for
shutting down the machine gracefully.
2023-01-03 21:12:56 -08:00
Guillaume Girol
6043e3af4e ocamlPackages.findlib: detect conflicts of version early
just like pythonCatchConflictHook
2023-01-03 20:30:34 +01:00
github-actions[bot]
e076f677a1
Merge staging-next into staging 2023-01-03 18:01:45 +00:00
Niklas Hambüchen
83481b8708 doc: python: Run hooks in checkPhase 2023-01-03 18:00:31 +01:00
Martin Weinelt
8b79bf0432
doc/contributing/quick-start: Replace dead thunderbird link
The thunderbird derivation is using `buildMozillaMach` these days,
shared with Firefox and Librefox, so it is probably the correct
, although more complicated, successor.
2023-01-03 14:18:41 +01:00
Robert Hensing
f61d4d346b
Merge pull request #205190 from NixOS/lib.path.relativeNormalise
lib.path.subpath.{isValid,normalise}: init
2023-01-03 13:46:11 +01:00
K900
8f48e1cadb doc/languages-frameworks/qt: remove outdated information 2023-01-03 15:38:02 +03:00
Silvan Mosberger
98fbcf1788 lib.path.subpath.isValid: init
The first path library function
2023-01-03 13:20:36 +01:00
github-actions[bot]
d8b859a780
Merge staging-next into staging 2023-01-02 18:01:43 +00:00
Winter
15013b3054
darwin.builder: prefer shutting down over halting VM (#208450)
This is preferable because it prevents things like disk corruption (requiring the user to delete the disk image when starting up) that I consistently ran into.
2023-01-02 07:36:41 -08:00
Naïm Favier
a8d4cf149c
doc: separate manpage URLs from the Pandoc filter
Move the manpage-to-URL mapping to `doc/manpage-urls.json` so that we can
reuse that file elsewhere, and generate the `link-manpages.lua` filter from
that file.

Also modify the Pandoc filter so that it doesn't wrap manpages that are
already inside a link.

Keeping a Lua filter is essential for speed: a Python filter would
increase the runtime `md-to-db.sh` from ~20s to ~30s (but Python is not
to blame; marshalling Pandoc types to and from JSON is a costly operation).
Parsing in Lua seems tedious, so I went with the Nix way.
2023-01-02 14:11:22 +01:00
Jan Tojnar
5810109b42 Merge branch 'staging-next' into staging
- readline6 attribute removed from all-packages.nix in d879125d61
- readline attribute was bumped to readline82 in 50adabdd60
2023-01-02 03:04:32 +01:00
Naïm Favier
161f6dbf59
Merge pull request #204840 from ncfavier/check-meta-deep 2023-01-01 14:30:12 +01:00
Naïm Favier
8796411139
Merge pull request #208176 from ncfavier/markdown-no-trailing 2023-01-01 14:15:05 +01: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
Gabriella Gonzalez
930b0dfbc1 darwin.builder: Remove trailing ' from host key
The trailing `'` was included by mistake and is not supposed
to be there:

```ShellSession
$ base64 -w0 /etc/ssh/ssh_host_ed25519_key.pub
c3NoLWVkMjU1MTkgQUFBQUMzTnphQzFsWkRJMU5URTVBQUFBSUpCV2N4Yi9CbGFxdDFhdU90RStGOFFVV3JVb3RpQzVxQkorVXVFV2RWQ2Igcm9vdEBuaXhvcwo=
```

The reason it did not cause issues before is because
Nix ignores everything after the `=`:

3dbf9b5af5/src/libutil/util.cc (L1539-L1540)

… so it's harmless but still worth fixing.
2022-12-29 07:19:16 -06:00
Naïm Favier
22ea90a4d8
.editorconfig: apply trailing whitespace removal
editorconfig-checker -disable-indent-size **/*.md
2022-12-29 01:40:50 +01:00
Sergei Trofimovich
092d57c076 Merge remote-tracking branch 'origin/staging-next' into staging
Conflicts:
    pkgs/development/tools/language-servers/ansible-language-server/default.nix
2022-12-28 09:35:37 +00:00
Naïm Favier
3f6fed2e59
doc,nixos/doc: unescape ellipses
Leftovers from the CommonMark conversion.
2022-12-27 17:13:49 +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
Naïm Favier
d11832fd96
doc,nixos/doc: unescape apostrophes
Leftovers from the CommonMark conversion.
2022-12-27 17:13:47 +01:00
Jörg Thalheim
ea415d1a38
Merge pull request #207038 from NixOS/make-disk-image-for-uefi
make-disk-image: documentation, UEFI variables recording, improved determinism
2022-12-26 11:02:28 +00:00
figsoda
b6c0e7f563
Merge pull request #205935 from figsoda/cargo-lock
rustPlatform.importCargoLock: add allowBuiltinFetchGit option
2022-12-25 19:38:36 -05:00
Anderson Torres
593381845f doc/contributing/coding-conventions: add subsection for language servers 2022-12-25 10:57:29 -03:00
Jan Tojnar
72c37eddec Merge branch 'staging-next' into staging 2022-12-25 01:30:47 +01:00
Raito Bezarius
22adcaa449 nixos/lib/make-disk-image: docs, UEFI vars recording, more determinism
- Extensive documentation in NixOS manual
- Deterministic mode that fixes various identifiers relative to disk
  partitions and filesystems in ext4 case
- UEFI variable recording
2022-12-24 19:15:29 +01:00
Silvan Mosberger
8496683ec9 lib: Allow doc rendering for lib/<name>/default.nix 2022-12-23 21:10:43 +01:00
Silvan Mosberger
b3792b44c5 lib: correctly render docs for nested identifiers
Applies https://github.com/nix-community/nixdoc/pull/27 and fixes up the
location information rendering, allowing lib functions to be nested in
further scopes

Needed for later commits
2022-12-23 21:10:16 +01:00
Robert Hensing
84c1409627
Merge pull request #207268 from ncfavier/systemd-scriptArgs
nixos/systemd: document what `scriptArgs` is for
2022-12-23 01:20:44 +01:00
Naïm Favier
feb9ba5839
doc/link-unix-man-references: add a bunch of systemd pages 2022-12-22 16:03:31 +01:00
Naïm Favier
5782c3d802
doc/lib-functions: print libset name before description 2022-12-22 11:31:11 +01:00
Naïm Favier
ce952286ca
doc/lib-functions: preserve libsets order 2022-12-22 11:31:11 +01:00
Naïm Favier
e1bb8f1e74
doc/lib-functions: add versions, cli 2022-12-22 11:31:11 +01:00
Naïm Favier
8906aa28e4
doc/lib-functions: remove warnings
Building the nixpkgs manual currently triggers a bunch of deprecation
warnings, because every attribute in `lib` is evaluated to see if it's
an attrset to generate locations for.

Instead, share the lib subsets to include in the documentation
between `lib-function-docs` and `lib-function-locations` so they can
coordinate.

Also generate the list of sections instead of duplicating it in
`library.xml`.
2022-12-22 11:31:08 +01:00
Domen Kožar
bcc8d11f01
Merge pull request #206951 from MercuryTechnologies/gabriella/macos-builder
darwin.builder: init
2022-12-21 12:20:12 +00:00
jakobkukla
ecdbd2a3fa doc: remove missing arg from emulateApp example 2022-12-20 04:28:20 +01:00
Gabriella Gonzalez
44c6fdabc2 Add documentation 2022-12-19 17:03:45 -08:00
David McFarland
824d40aa04 build-dotnet-module: restore for current runtime by default 2022-12-19 15:36:25 -04:00
github-actions[bot]
dc7ebb0163
Merge staging-next into staging 2022-12-18 18:01:41 +00:00
figsoda
403e25e3e3 doc: fix typos 2022-12-17 18:21:48 -05:00
github-actions[bot]
4804305f6e
Merge staging-next into staging 2022-12-17 06:02:03 +00:00
Jason Miller
8392158289
cudaPackages: add cudaFlags (#205351)
* cudaPackages: add cudaFlags

* cudaNames -> cudaMicroarchitectureNames

* update documentation, remove config for static library removal

* doc link added to flags

* fix whitespace in assignment
2022-12-16 22:00:36 -08:00
Winter
f1292b31d6 doc/languages-frameworks/javascript: use --ignore-scripts flag in example
Presenting an example with a patch (without even providing that patch!) is not ideal. Since `npm pack` now obeys `--ignore-scripts`, we can use that instead.
2022-12-13 19:40:27 -05:00
figsoda
cce3dc63a0 rustPlatform.importCargoLock: add allowBuiltinFetchGit option 2022-12-13 11:27:26 -05:00
github-actions[bot]
8506553217
Merge staging-next into staging 2022-12-13 00:02:51 +00:00
Robert Hensing
a70a69156c
Merge pull request #205768 from hercules-ci/remove-numbers-from-manuals
doc: Remove all section numbers
2022-12-12 22:11:28 +01:00
Robert Hensing
c23666473c doc: Remove all section numbers
Simplicity.

We use anchors nowadays. Nobody should be printing this.
2022-12-12 13:04:39 +01:00
github-actions[bot]
285157a0f9
Merge staging-next into staging 2022-12-11 06:01:42 +00:00
Robert Hensing
43dcea7885
Merge pull request #204626 from fricklerhandwerk/ifd-policy
document Import From Derivation (IFD) policy
2022-12-11 02:37:09 +01:00
Robert Hensing
16f5747575
Merge pull request #175649 from Artturin/opt-in-structured-attrs
stdenv: support opt-in __structuredAttrs
2022-12-10 21:12:43 +01:00
Valentin Gagarin
d9f9ead58a
Update doc/contributing/coding-conventions.chapter.md
Co-authored-by: Mostly Void <dit7ya@users.noreply.github.com>
2022-12-10 11:46:53 +01:00
Artturin
fda61e9066 add docs for prependToVar and appendToVar 2022-12-10 04:22:11 +02:00
Naïm Favier
4e5ebcc3ed
vim-full: rename from vim_configurable
Avoids confusion: `vim-full`'s build-time features are configurable, but both
`vim` and `vim-full` are *customizable* (in the sense of user configuration).
2022-12-09 09:55:55 +01:00
Valentin Gagarin
a2b6bd7b35
Merge pull request #126213 from ryantm/lib-doc-gen
doc: auto-generate asserts and attrset library docs
2022-12-09 09:33:35 +01:00
Robert Hensing
470e6fd1cd
Merge pull request #201902 from ck3mp3r/dockertools-architecture-in-config-200725
Adding ability to set image architecture when creating OCI images using DockerTools
2022-12-08 23:54:50 +01:00
Ryan Mulligan
ac1ae0a58e doc: auto-generate asserts and attrset library docs
If all the docs are auto-generated, it should be easier to convert
them to Commonmark.

Co-Authored-By: Valentin Gagarin <valentin.gagarin@tweag.io>
Co-Authored-By: Silvan Mosberger <contact@infinisil.com>
2022-12-08 22:58:22 +01:00
Jörg Thalheim
0b8b0c65cc
Merge pull request #205187 from Mic92/cue-validator
cue: init writeCueValidator
2022-12-08 21:38:55 +00:00
Raito Bezarius
f25d48180a cue: add documentation on writeCueValidator 2022-12-08 22:19:06 +01:00
Christian Kemper
f6ae4479ea dockerTools: allowing architecture to be specified
... for buildImage, buildLayeredImage and streamLayeredImage,
adding docs and tests.
2022-12-08 20:29:09 +01:00
zowoq
7d04753e2f doc/go: fix link 2022-12-08 02:29:18 +10:00
Manuel
5d8e07c835
doc: add hint about lib.fakeSha256 to go section (#204132)
* doc: add hint about lib.fakeSha256 to go section

Found it here: https://stackoverflow.com/a/71934521/1633985

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-12-07 17:03:35 +01:00
Valentin Gagarin
db1a83aaa4 docs: fixup wording and formatting on JavaScript 2022-12-07 16:47:31 +01:00
Valentin Gagarin
53b5a47c12 document Import From Derivation (IFD) policy 2022-12-07 16:47:30 +01:00
Valentin Gagarin
5b9b93b9be
Merge pull request #204257 from raboof/nixpkgs-manual-update-meta-attributes
manual: update meta-attributes section
2022-12-05 09:46:46 +01:00
Jörg Thalheim
c0491d5fd2
Merge pull request #204343 from urandom2/sridoc
doc: use sri hash syntax
2022-12-04 10:04:57 +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
figsoda
75c01e730d
Merge pull request #203520 from figsoda/nextest
rustPlatform.buildRustPackage: add cargo-nextest support
2022-12-03 19:03:34 -05:00
Arnout Engelen
cfdd900d66
manual: update meta-attributes section
Promote the `maintainers = with maintainers; [ ]` syntax as that is most common
in nixpkgs, and remove the `nix-env` example which doesn't work like that anymore.
2022-12-03 10:04:15 +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
figsoda
0f386d1896 docs/rust: document cargoNextestHook and useNextest 2022-11-28 18:30:30 -05:00
Silvan Mosberger
a566d0842e
Merge pull request #172736 from infinisil/docker-nix-shell 2022-11-26 20:21:59 +01:00
Winter
125bd1f0b5 doc/languages-frameworks/javascript: update deps hash in example 2022-11-23 20:52:08 -05:00
figsoda
82fe76d1cd carnix,cratesIO: remove 2022-11-22 14:10:25 -05:00
Winter
93334f5234 npmHooks.npmInstallHook: pass install flags to prune 2022-11-21 15:00:08 -05:00
Sandro
3a05360e53
Merge pull request #200082 from panicgh/fetchgit-sparse-checkout 2022-11-21 20:00:56 +01:00
Artturi
80212614a3
Merge pull request #187921 from amjoseph-nixpkgs/pr/manual/rust/buildRustY
doc/../rust.section.md: prominently mention `buildRustXX` names
2022-11-21 19:08:38 +02:00
Robert Hensing
29352751cf
Merge pull request #196251 from hercules-ci/testers-build-failure-and-equal-contents
`testers`: Add `testBuildFailure` and `testEqualContents`
2022-11-21 06:17:00 +01:00
Martin Weinelt
18ab6d062b
sphinxHook: inherit from python3Packages 2022-11-20 15:39:34 +01:00
Artturin
341e6fd558 splice.nix: start deprecating nativeDrv and crossDrv 2022-11-19 00:04:54 +02:00
Nicolas Benes
f6b07f0e2f fetchgit: make sparseCheckout a list of strings
The `sparseCheckout` argument allows the user to specify directories or
patterns of files, which Git uses to filter files it should check-out.

Git expects a multi-line string on stdin ("newline-delimited list", see
`git-sparse-checkout(1)`), but within nixpkgs it is more consistent to
use a list of strings instead. The list elements are joined to a
multi-line string only before passing it to the builder script.

A deprecation warning is emitted if a (multi-line) string is passed to
`sparseCheckout`, but for the time being it is still accepted.
2022-11-15 19:45:33 +01:00
Jocelyn Thode
2f933d60fb doc/vim: Clarify buildVimPlugin/buildVimPluginFrom2Nix 2022-11-14 14:59:13 -05:00
John Ericson
cd27a5b436
Merge pull request #82131 from Ericson2314/bsd-cross
FreeBSD packages: Init at 13.1
2022-11-13 21:35:17 -05:00
github-actions[bot]
f3a93620b1
Merge master into staging-next 2022-11-10 12:01:27 +00:00
Shamrock Lee
da31bd5673 patchRcPathBash, patchRcPathCsh, patchRcPathFish, patchRcPathPosix: init
Init patchRcPath hooks, which provides
utilities to patch shell scripts to be sourced by users.

Add test cases and documentation.
2022-11-10 09:23:52 +08:00
github-actions[bot]
d99020653d
Merge master into staging-next 2022-11-09 18:01:11 +00:00
Winter
16722903aa buildNpmPackage: init 2022-11-09 10:35:59 -05:00
github-actions[bot]
81316207ec
Merge master into staging-next 2022-11-09 00:02:55 +00:00
github-actions[bot]
4517d658d3
Merge master into staging-next 2022-11-08 18:01:16 +00:00
Ryan Mulligan
f3d0e1d5c3 nixpkgs/doc: fix admonition syntax
Match admonition syntax in

https://nixos.org/manual/nixpkgs/unstable/#chap-contributing
2022-11-08 07:30:20 -08:00
Ryan Mulligan
962a810513 nixpkgs/doc/stdenv: fix admonition class
Change to match the formatting of the other admonitions that use
classes.

This was breaking the mmdoc output.
2022-11-07 13:32:21 -08:00
github-actions[bot]
a9864a3f5a
Merge master into staging-next 2022-11-06 06:01:30 +00:00
Anderson Torres
4b59590ac5
Revert "lib,doc: remove obvious usages of toString on paths" 2022-11-05 21:57:23 -03:00
github-actions[bot]
a46c8c1b26
Merge master into staging-next 2022-11-06 00:02:47 +00:00
Artturin
66cf79f282 lib,doc: remove obvious usages of toString on paths
It gives a warning on the lazy-trees branch of Nix
(NixOS/nix#6530)

one of these was also giving me an error (the one in lib/trivial probably)

```
$ nix build
warning: applying 'toString' to path '/home/artturin/nixgits/my-nixpkgs/nixos/modules/installer/sd-card/sd
-image-aarch64.nix' and then accessing it is deprecated, at /home/artturin/nixgits/my-nixpkgs/lib/modules.
nix:349:99
warning: applying 'toString' to path '/home/artturin/nixgits/my-nixpkgs/.git' and then accessing it is dep
recated, at /home/artturin/nixgits/my-nixpkgs/lib/sources.nix:35:32
warning: applying 'toString' to path '/home/artturin/nixgits/my-nixpkgs/nixos/modules/system/etc/etc.nix'
and then accessing it is deprecated, at «stdin»:0
warning: applying 'toString' to path '/home/artturin/nixgits/my-nixpkgs/nixos/modules/system/etc/etc-activ
ation.nix' and then accessing it is deprecated, at «stdin»:0
warning: applying 'toString' to path '/home/artturin/nixgits/my-nixpkgs/nixos/modules/installer/sd-card/sd
-image-aarch64.nix' and then accessing it is deprecated, at «stdin»:0
error: cannot decode virtual path '/nix/store/virtual0000000000000000000000005-source'
(use '--show-trace' to show detailed location information)
```
2022-11-06 00:00:39 +02:00
John Ericson
66aa02f190 lib/systems: Support FreeBSD
A tricky thing about FreeBSD is that there is no stable ABI across
versions. That means that putting in the version as part of the config
string is paramount.

We have a parsed represenation that separates name versus version to
accomplish this. We include FreeBSD versions 12 and 13 to demonstrate
how it works.
2022-11-04 16:49:28 -04:00
github-actions[bot]
08b08d0caf
Merge staging-next into staging 2022-11-04 00:03:34 +00:00
Guillaume Girol
3befade691 doc: fix python module override example 2022-11-03 19:54:51 +01:00
github-actions[bot]
a8e550e843
Merge staging-next into staging 2022-11-01 00:03:36 +00:00
0x4A6F
b37df78bfe
doc/languages-frameworks/rust: example for disabling tests (#198705) 2022-10-31 22:39:34 +01:00
github-actions[bot]
85d6819fff
Merge staging-next into staging 2022-10-31 18:03:46 +00:00
figsoda
0426b36f9f doc/vim: update docs for nvim-treesitter 2022-10-31 09:44:02 -04:00
John Ericson
0c09b3d17c
Merge pull request #197937 from danielbarter/cc-wrapper-hook
cc-wrapper: adding a cc-wrapper-hook to the cc-wrapper
2022-10-28 17:30:03 +01:00
Robert Hensing
e20a362908 testers.testEqualContents: init 2022-10-27 14:06:38 +02:00
Robert Hensing
44d0f37833 testers.testBuildFailure: init 2022-10-27 14:06:38 +02:00
Daniel Barter
77bd639c4c cc-wrapper: adding a cc-wrapper-hook to the cc-wrapper 2022-10-26 09:33:43 -07:00
Silvan Mosberger
c0c3c3f1c4
Merge pull request #197905 from infinisil/lib-filesystem-docs
lib: Automatically generate lib.filesytem docs
2022-10-26 18:11:32 +02:00
Silvan Mosberger
9bfc4bbd63 lib: Automatically generate lib.filesytem docs 2022-10-26 15:10:47 +02:00
Jan Tojnar
fa285355ee nixos/doc/manual/md-to-db.sh: Add support for <kbd> element 2022-10-26 01:46:44 +02:00
Emilia Bopp
8bec7996cc doc: fix syntax error in Lua documentation 2022-10-25 22:34:32 +02:00
Stanisław Pitucha
713369c44b doc/contributing: Explicitly allow trivial changes by non-authors
Discussed and proposed at https://discourse.nixos.org/t/rules-around-adding-to-someones-pr/22671/3
2022-10-23 15:23:02 +11:00
Janne Heß
1b768f41e9
Merge pull request #173506 from helsinki-systems/feat/document-no-breaking-commits
doc: Document that the staging branches may be restricted
2022-10-21 22:58:33 +02:00
Robert Hensing
c1311d1223 doc/stdenv: Move Other hooks after all hooks 2022-10-13 21:15:19 +02:00
Robert Hensing
53088569de doc/stdenv: Clarify that the wrappers come with hooks 2022-10-13 21:14:21 +02:00
Robert Hensing
f4c6286284 doc/stdenv: Improve language a bit 2022-10-13 21:14:04 +02:00
Robert Hensing
2db8de920e doc: Move non-stdenv hooks out of stdenv chapter 2022-10-13 15:40:27 +02:00
Robert Hensing
5b055190e3 doc/stdenv: Clarify status of the hooks 2022-10-13 13:36:47 +02:00
Adam Joseph
0d0c03fb0b
coding-conventions.chapter.md: update to account for #89885 (#191378)
https://github.com/NixOS/nixpkgs/pull/89885 ensures that fetches are
done securely (i.e. without `--insecure`) when the `hash` parameter is one of
the four special "fake" hashes.  However the manual was not updated in that PR.
This commit updates the manual to account for the already-merged changes from
that PR.

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-10-12 11:08:50 +02:00
Silvan Mosberger
8ec0837a72 Introduce dockerTools.buildNixShellImage 2022-10-07 22:04:22 +02:00
Дамјан Георгиевски
4e385bec15
add documentation for the pkgs.portableService tool (#193081)
* add documentation for the pkgs.portableService tool

as introduced in 499aebcf34

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-10-07 10:37:56 +02:00
Théo Zimmermann
2dc3552aa1 coqPackages.mkCoqDerivation: upgrade to Dune 3
And remove the version number from the corresponding attributes.
2022-10-02 14:42:28 +02:00
Robert Hensing
7f0d934f9a
Merge pull request #191540 from hercules-ci/nixosTest-modular
nixosTest: make modular
2022-09-28 10:27:45 +01:00
José Romildo
1f239257c5 maintainers/scripts/update.nix: make package name, pname and old version available to the update script 2022-09-26 22:16:19 -03:00
Ivv
2650d450a7
Merge pull request #190403 from IvarWithoutBones/dotnetmodule-fixes
buildDotnetModule: several usability improvements
2022-09-26 15:04:31 +02:00
Robert Hensing
6205d37747 nixos/testing: Improve option docs 2022-09-24 17:38:10 +01:00
Frederik Rietdijk
9e02095f4e Python docs: document attribute to use for non-PyPI projects 2022-09-22 13:31:58 +02:00
Robert Hensing
b2def3c2ce doc/postgresql-test-hook: Add example 2022-09-19 18:14:31 +01:00
Ivar Scholten
8e00d6ac26
buildDotnetModule: move nugetDeps throw to when its actually needed
Previously we had an assert that would complain when nugetDeps wasnt set,
which also didnt allow any passthru attributes (like fetch-deps) to be
build. That causes a cycle where you need nugetDeps to fetch the nuget
deps, but arent able to build the script to do so.
2022-09-18 18:00:37 +02:00
Ivar Scholten
03a1b62cb3
buildDotnetModule: dont require specifing a projectFile
In a lot of cases dotnet can figure this out by itself, so we can just
invoke it without the project argument.
2022-09-18 18:00:37 +02:00
Dennis Gosnell
533e1f0468
Merge pull request #190795 from cdepillabout/coq-add-docs
doc/language-frameworks/coq: add explanation of how to override packages
2022-09-16 09:09:09 -04:00
davidak
63f7b8c945
Merge pull request #190818 from IvarWithoutBones/testversion-doc
doc/testers: testVersion -> testers.testVersion, add example
2022-09-15 23:48:56 +02:00
Ivar Scholten
6c40872147
doc/testers: testVersion -> testers.testVersion, add example 2022-09-15 22:46:37 +02:00
Dennis Gosnell
6cc6850fe2
doc/language-frameworks/coq: add explanation of how to override packages 2022-09-15 09:18:20 -04:00
Matthieu Coudron
800323c0c0 doc(vim): take into account plug non-support
Apply suggestions from code review

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-09-11 20:33:01 +02:00
Matthieu Coudron
3944240476 doc(neovim): remove the mention of plug for neovim
This was removed to simplify configuration. One could create a function that converts the plug format to vim native package format (only plugin system supported for neovim)  and upstream it to nixpkgs if that's an issue
2022-09-11 18:11:16 +02:00
Matthieu Coudron
584bc20aa0 doc: present how to create a vim-plugin overlay
it is possible to maintain an out of tree list of neovim plugins with this method

Update doc/languages-frameworks/vim.section.md

Co-authored-by: Sandro <sandro.jaeckel@gmail.com>
2022-09-11 18:11:16 +02:00
Sandro
1bb33d6dbe
doc/contributing: fix whitespace 2022-09-07 01:01:48 +02:00
Anderson Torres
6be0f0e057
Merge pull request #189241 from SuperSandro2000/git-full-hash
doc/contributing: enforce full commit hashes on github
2022-09-05 21:26:05 -03:00