Guillaume Desforges
6462ee61c7
Anchor link for builtin functions in HTML doc
2022-02-23 15:07:01 +01:00
Guillaume Desforges
2cc645a91a
Add html make target
2022-02-23 15:06:13 +01:00
Théophane Hufschmitt
54f07b66c8
Precise the doc for --include-outputs
...
Make it explicit that it only includes the existing outputs and not the ones that haven’t been realised
2022-02-23 09:17:08 +01:00
toonn
400d70a3a9
doc: Add detailed uninstall section for macOS
...
The multi-user installation on macOS, which is now the only option, has
gotten complicated enough that it discourages some users from checking
Nix out for fear of being left with a "dirty" system. Detailed
uninstallation instructions should make this less of an issue.
2022-02-22 16:28:24 +01:00
Eelco Dolstra
38eea2c503
Update release notes
2022-02-22 14:23:39 +01:00
Eelco Dolstra
26e99c817c
Merge pull request #6114 from Radvendii/welcomeText
...
add release notes for welcomeText
2022-02-18 10:52:03 +01:00
Taeer Bar-Yam
219fa2e43d
add release notes for welcomeText
2022-02-17 15:17:20 -05:00
Rahul Butani
d82cf4a016
manual: fix formatting for options with "machine-specific" defaults
2022-02-15 15:44:05 -06:00
tomberek
2bf96bd9f2
Merge branch 'master' into bundler_drv
2022-01-28 10:18:29 -05:00
Eelco Dolstra
35dbdbedd4
nix store ping: Report Nix daemon version
...
Fixes #5952 .
2022-01-25 21:15:58 +01:00
Tom Bereknyei
dc85e20684
bundler: notes and doc update to include bundlers repo
2022-01-25 03:48:44 -05:00
Eelco Dolstra
9faad4c5eb
Move rl-next.md to rl-2.5.md
2022-01-25 00:11:00 +01:00
Eelco Dolstra
edf0cde1a7
Merge pull request #5960 from zombiezen/patch-1
...
Correct `NIX_BUILD_PATH` default description
2022-01-24 12:46:43 +01:00
Eelco Dolstra
3782017272
Tweak release notes
2022-01-24 12:45:35 +01:00
Ross Light
7477974b93
Correct NIX_BUILD_PATH default description
...
Source: 067076287b/src/nix-build/nix-build.cc (L362-L381)
2022-01-21 18:45:19 -08:00
Rok Garbas
d463e11760
Adding docs regarding the docker image from master
2022-01-21 14:50:34 +01:00
lincoln auster [they/them]
7d4f86f032
release-notes: document commit-lockfile-summary option
...
This documents 3023c7700.
2022-01-18 16:10:44 -07:00
Eelco Dolstra
4dda1f92aa
Add command 'nix store copy-log'
...
Fixes #5222 .
2022-01-18 14:08:49 +01:00
Théophane Hufschmitt
dc4730ee94
Merge pull request #5720 from tomberek/flake_search
...
flakes: search up to git or filesystem boundary
2022-01-18 10:59:12 +01:00
tomberek
2dead20924
Apply suggestions from code review
...
Co-authored-by: Théophane Hufschmitt <7226587+thufschmitt@users.noreply.github.com>
2022-01-14 09:16:34 -05:00
Eelco Dolstra
5e9653c370
Tweak
2022-01-13 14:33:41 +01:00
Eelco Dolstra
66424cd29f
Merge branch 'patch-1' of https://github.com/TheodorRene/nix
2022-01-13 14:31:49 +01:00
Profpatsch
a51c457204
Release Notes 2.4: add --indirect
no-op change
...
Since
00d25e8457
which was first included in nix 2.4.
It is a backwards-compatible change since the flag will just be
ignored.
2022-01-12 23:19:15 +01:00
Theodor René Carlsen
89b4df8d92
Add link to explanation when introducing a new operator
...
The logical implication operator is included in this section but never explained. It might stump new readers with a pretty uncommon operator, and it's never referenced explicitly.
2022-01-11 17:01:43 +01:00
pennae
00c993f48b
add zipAttrsWith primop
...
nixpkgs can save a good bit of eval memory with this primop. zipAttrsWith is
used quite a bit around nixpkgs (eg in the form of recursiveUpdate), but the
most costly application for this primop is in the module system. it improves
the implementation of zipAttrsWith from nixpkgs by not checking an attribute
multiple times if it occurs more than once in the input list, allocates less
values and set elements, and just avoids many a temporary object in general.
nixpkgs has a more generic version of this operation, zipAttrsWithNames, but
this version is only used once so isn't suitable for being the base of a new
primop. if it were to be used more we should add a second primop instead.
2022-01-03 21:05:53 +01:00
Alexander Bantyev
a26351da02
Add ability to toggle show-trace from within the repl
2021-12-29 02:54:36 +03:00
tomberek
f404189368
Merge branch 'master' into flake_search
2021-12-23 15:22:52 -05:00
Eelco Dolstra
881b610266
Update release notes
2021-12-21 14:19:21 +01:00
Eelco Dolstra
c260640dec
Fix docker instructions
2021-12-16 21:48:38 +01:00
jesse
11ee875a6d
List aarch64 as supported macOS hardware
...
Resolves #5767
2021-12-15 10:55:34 -08:00
Théophane Hufschmitt
6234e1c811
Merge pull request #5702 from baloo/baloo/hide-non-reproducible-settings
...
reproducibility: hide non-reproducible settings from manual
2021-12-14 09:14:25 +01:00
Eelco Dolstra
18cb094aab
rl-2.5.md: Set date
2021-12-13 19:57:06 +01:00
Eelco Dolstra
f133001dc8
Move rl-next.md to rl-2.5.md
2021-12-13 16:48:44 +01:00
Eelco Dolstra
3f417c8d1c
Add release notes entry for #5149
2021-12-13 16:43:42 +01:00
Janne Heß
4194b68250
doc: Fix command for distributed builds
...
We also need to build impurely or the <nixpkgs> lookup will not work.
2021-12-10 12:58:12 +01:00
Amon Stopinšek
0bd93ed747
Fix link to nixos channel
...
The old link returned 404 errror.
2021-12-09 16:44:24 +00:00
Eelco Dolstra
167e864697
Merge pull request #5730 from abathur/darwin_document_fstab_settings
...
document some darwin mount settings
2021-12-07 22:24:40 +01:00
Alexander Bantyev
33926ed1e7
nix repl: add :log
...
Add a :log command that shows logs for a derivation.
Closes https://github.com/NixOS/nix/issues/3504
Co-authored-by: Taeer Bar-Yam <taeer@bar-yam.me>
2021-12-06 16:52:50 +03:00
Travis A. Everett
8093456111
document some darwin mount settings
2021-12-04 23:16:42 -06:00
Tom Bereknyei
b6cc0a704d
flakes: search up to git or filesystem boundary
...
While parsing a flakeref, upon not finding a flake.nix, search upwards
until git or filesystem boundary.
2021-12-03 10:55:30 -05:00
Eelco Dolstra
2e606e87c4
Merge pull request #5715 from Infinisil/groupBy-primop
...
Introduce `builtins.groupBy` primop
2021-12-03 13:21:14 +01:00
David Purdum
69b9198875
Fix docker command
...
`docker -ti run nixos` does not run on docker version 20.10.7 (my machine). This fixes it to read `docker run -ti nixos`.
2021-12-02 23:38:33 -05:00
Silvan Mosberger
90700736c7
Introduce builtins.groupBy primop
...
This function is very useful in nixpkgs, but its implementation in Nix
itself is rather slow due to it requiring a lot of attribute set and
list appends.
2021-12-02 21:54:51 +01:00
Arthur Gautier
21520297da
reproducibility: hide non-reproducible settings from manual
...
Because the manual is generated from default values which are themselves
generated from various sources (cpuid, bios settings (kvm), number of
cores). This commit hides non-reproducible settings from the manual
output.
2021-12-01 17:25:58 +01:00
Eli Flanagan
092c375cda
Update doc/manual/src/glossary.md
...
Co-authored-by: Eelco Dolstra <edolstra@gmail.com>
2021-11-30 13:19:42 -05:00
Eli Flanagan
a473e85c80
docs: document set theory symbols
...
These symbols confused me so I wanted to gloss them to help future users. You can see the context here: https://discourse.nixos.org/t/flakes-what-does-mean-big-bundle-of-questions
2021-11-30 11:13:46 -05:00
Eelco Dolstra
b96164f4af
Merge remote-tracking branch 'origin/build-with-clang'
2021-11-30 11:50:56 +01:00
Eelco Dolstra
ddf4fb750d
Merge pull request #5678 from t184256/document-libsodium
...
Document libsodium, which is now mandatory, as a dependency.
2021-11-29 11:11:10 +01:00
Eelco Dolstra
99804465af
Merge pull request #5679 from t184256/optional-libcpuid
...
Document libcpuid dependency and make it optional
2021-11-29 11:10:42 +01:00
Alexander Sosedkin
a9bd06d0ea
Make libcpuid dependency optional with --disable-cpuid
2021-11-28 00:52:35 +01:00
Alexander Sosedkin
b73a1c0638
Document libcpuid dependency
2021-11-28 00:52:35 +01:00
Alexander Sosedkin
33a227503a
Document libsodium, which is now mandatory, as a dependency
2021-11-27 23:11:11 +01:00
Tom Bereknyei
152e3cda0c
reproducibility: determinstic man page output for cores
2021-11-26 10:55:43 -05:00
Pamplemousse
288c252570
Documentation: alternative stdenv
for hacking
...
Signed-off-by: Pamplemousse <xav.maso@gmail.com>
2021-11-26 10:04:56 +01:00
Eelco Dolstra
986906e687
Update names
2021-11-25 17:09:11 +01:00
Silvan Mosberger
09471d2680
Make lists be comparable
...
Makes lists comparable using lexicographic comparison.
Increments builtins.langVersion in order for this change to be
detectable
2021-11-24 13:40:46 +01:00
Lorenz Leutgeb
e1192116d3
doc: Fix escape for operator "logical or"
...
See https://matrix.to/#/!KqkRjyTEzAGRiZFBYT:nixos.org/$hhMb6AdRIXfRkv_LsNsiQJuch7AQ_b6szr4tfawFy-4
2021-11-18 15:08:01 +01:00
Eelco Dolstra
e88fb63e28
Merge pull request #5585 from jtojnar/env-a
...
doc: De-emphasize nix-env without -A
2021-11-18 14:34:45 +01:00
Jan Tojnar
ca4d8ce9e2
doc: De-emphasize nix-env without -A
...
The manual uses `nix-env -i` without `-A` prominently, teaching a bad practice to newcomers.
2021-11-17 17:04:25 +01:00
Jan Tojnar
e96faadcd6
Fix XDG_CONFIG_DIRS fallback
...
According to XDG Base Directory Specification,
it should fall back to /etc/xdg when the env var is not present.
2021-11-17 14:31:15 +01:00
Eelco Dolstra
51ffc19f02
Merge branch 'add-docker-image-to-hydra-jobs' of https://github.com/garbas/nix
2021-11-16 13:00:54 +01:00
Kevin Amado
eae54f2d52
fix many doc typos
2021-11-13 22:28:20 -05:00
Rok Garbas
a118a70649
Documenting how to use/build Nix' Docker image
2021-11-11 16:07:01 +01:00
Théo Zimmermann
d589782fb0
Fix some typos in CLI guideline.
2021-11-08 08:24:15 +01:00
Jan Tojnar
e5d4c2235f
docs: Correct fallback user config path
...
This is in line with XDG Base Directory Specification, where ~/.config is supposed to be used when XDG_CONFIG_HOME is unset.
It also better matches the reality, where ~/.config/nix.conf does not seem to be used.
2021-11-04 11:41:29 +01:00
Dimitris Apostolou
c34cc5e488
Fix typos
2021-11-03 18:11:20 +02:00
Simon Legner
1968760f4a
command-ref/nix-shell: fix --pure, --keep
2021-11-02 22:00:08 +01:00
Eelco Dolstra
b61b307bad
Remove references to building from the source tarball
2021-11-02 15:29:47 +01:00
Eelco Dolstra
6a93e186f4
Fix 2.4 migration examples
2021-11-01 22:44:07 +01:00
Eelco Dolstra
bc4b7521f4
Rename rl-2.5.md to rl-next.md
...
Having a generically named file for release notes for the next release
makes things easier for PRs.
2021-10-28 14:36:47 +02:00
Eelco Dolstra
9c6ac9eb0e
2.4 release notes: Add some migration notes
2021-10-27 17:33:32 +02:00
Domen Kožar
51c812d6bb
Merge pull request #5365 from arafangion/master
...
Clarify that not all nix packages will use the default build phases
2021-10-17 20:54:00 -05:00
John Chapman
ffeec5f283
Clarify that not all nix packages will use the default build phases
2021-10-17 15:24:22 +11:00
Eelco Dolstra
4c0cde95ad
Update release notes
2021-10-13 11:39:54 +02:00
Eelco Dolstra
2f3c79c241
Mention compression-level in the release notes
2021-10-13 11:11:26 +02:00
John Chapman
4cff413054
Clarify that not all nix packages will use the default build phases
2021-10-09 12:03:34 +11:00
Eelco Dolstra
844dd901a7
Start 2.5 release notes
2021-10-07 20:09:03 +02:00
Eelco Dolstra
f45b30de2f
Revert "docs: add troubleshooting session in remote builds"
...
This reverts commit 0574c1850a
.
2021-10-06 17:12:52 +02:00
Domen Kožar
d0cc6a192a
Merge pull request #5095 from happysalada/update_remote_builds_docs
...
docs: add troubleshooting session in remote builds
2021-10-06 08:10:53 -05:00
happysalada
0574c1850a
docs: add troubleshooting session in remote builds
2021-10-06 21:47:53 +09:00
Eelco Dolstra
08aa7daee0
Remove links to .md files in help output
...
Fixes #5337 .
2021-10-06 13:01:18 +02:00
Rafal Gwozdzinski
a73f855bd4
Fix typo
2021-10-03 12:19:59 +02:00
Eelco Dolstra
0e3b8ca767
Typo
2021-10-01 16:32:07 +02:00
Eelco Dolstra
43221bb319
Comments
2021-10-01 16:29:53 +02:00
Eelco Dolstra
91b39eee25
Typo
...
Co-authored-by: Sebastian Ullrich <sebasti@nullri.ch>
2021-10-01 14:18:07 +02:00
Eelco Dolstra
5e222ac18b
Release notes
2021-09-30 17:36:09 +02:00
Eelco Dolstra
8fdb1d057a
Quiet
2021-09-22 14:12:31 +02:00
Eelco Dolstra
49a932fb18
nix --help: Display help using lowdown instead of man
...
Fixes #4476 .
Fixes #5231 .
2021-09-13 14:45:21 +02:00
Eelco Dolstra
25b6b74175
Manual: Link to 2.4 release notes
2021-09-09 15:01:36 +02:00
Eelco Dolstra
ff03fb6743
Manual: Depend on all *.md files
2021-09-09 15:01:19 +02:00
Eelco Dolstra
7ee639f9db
Merge pull request #5066 from Radvendii/master
...
add antiquotations to paths
2021-09-01 12:55:04 +02:00
Taeer Bar-Yam
b2beb97f2a
add documentation for path antiquotations
2021-08-31 08:17:17 -04:00
33fa5f3cd9
doc/manual/local.mk: fix 'make install DESTDIR=...'
...
Install failure is observed when we try to install
into inplace location as non-root:
```
$ LANG=C make install DESTDIR=$PWD/__i__ V=1
RUST_LOG=warn mdbook build doc/manual -d /usr/share/doc/nix/manual
2021-08-28 13:29:58 [ERROR] (mdbook::utils): Error: Rendering failed
2021-08-28 13:29:58 [ERROR] (mdbook::utils): Caused By: Unexpected error when constructing destination path
2021-08-28 13:29:58 [ERROR] (mdbook::utils): Caused By: Permission denied (os error 13)
make: *** [doc/manual/local.mk:98: /usr/share/doc/nix/manual/index.html] Error 101
```
The change is to prefix paths with `$(DESTDIR)`.
2021-08-28 13:31:34 +01:00
Pamplemousse
0e7bd65976
15f4d4f
Documentation follow-up
2021-08-19 09:40:47 -07:00
Eelco Dolstra
d64f9671fc
Merge pull request #5094 from Pamplemousse/simpler_doc
...
doc/manual: don't need to copy `highlight.js` manually
2021-08-05 15:13:07 +02:00
Pamplemousse
de39cfb9f3
doc/manual: don't need to copy highlight.js
manually
...
Signed-off-by: Pamplemousse <xav.maso@gmail.com>
2021-08-04 19:47:05 -07:00
regnat
441be5d59a
Remove dead code in doc’s local.mk
2021-07-27 14:37:55 +02:00
regnat
cd6e9eb024
Fix the generation of nix3 manpages
...
- Separate the generation of the manpages from their installation
- Make sure that `make` generates the manpages
- Make sure that `make install` installs them
Fix #5051
2021-07-27 13:47:53 +02:00
regnat
c5f5d615a6
Cleanup the generation of the nix3 manpages
...
Use a dedicated make target for the man page rather than bundling the
generation as part of `install`.
Also make sure that `make install` is a fixpoint by
- Removing the generated markdown files from `MANUAL_SRCS`
- Not having the manpage generation write in its source directory so as
to not update its timestamp (it would run each time otherwise)
2021-07-19 16:55:56 +02:00
Eelco Dolstra
f1ecd30bd5
Merge pull request #4773 from alyssais/dl
...
doc: builtins: use a definition list
2021-07-05 14:03:15 +02:00