Eelco Dolstra
afc24e6a66
Release notes
2023-05-31 12:38:05 +02:00
Eelco Dolstra
9a5b9c588f
Merge pull request #8421 from fricklerhandwerk/doc-replaceStrings
...
update documentation according to release notes
2023-05-31 12:10:32 +02:00
Valentin Gagarin
738c0d5064
Merge pull request #8318 from fricklerhandwerk/doc-currentTime
...
document `builtins.currentTime`
2023-05-31 03:15:54 +02:00
Valentin Gagarin
52004696c0
Merge pull request #8413 from doronbehar/doc/distributed-builds/clearer-warning
...
distributed-builds.md: Clarify warning ssh access requirements
2023-05-31 02:05:05 +02:00
Valentin Gagarin
e2f33e0df1
rewrap lines to use one line per sentence
...
this makes future reviews easier as it reduces diff noise
2023-05-31 01:32:03 +02:00
Doron Behar
76287a9207
distributed-builds.md: Clarify warning ssh access requirements
2023-05-31 01:28:15 +02:00
Valentin Gagarin
7a5731aa07
link to mentioned builtin
2023-05-30 22:58:00 +02:00
polykernel
a382919d7d
primops: lazy evaluation of replaceStrings replacements
...
The primop `builtins.replaceStrings` currently always strictly evaluates the
replacement strings, however time and space are wasted for their computation
if the corresponding pattern do not occur in the input string. This commit
makes the evaluation of the replacement strings lazy by deferring their
evaluation to when the corresponding pattern are matched and memoize the result
for efficient retrieval on subsequent matches.
The testcases for replaceStrings was updated to check for lazy evaluation
of the replacements. A note was also added in the release notes to
document the behavior change.
2023-05-25 18:35:23 -04:00
John Ericson
684e9be8b9
Merge pull request #8337 from fricklerhandwerk/channel-files
...
list files used by `nix-channel` on its own man page
2023-05-17 12:21:20 -04:00
John Ericson
16a60520f2
Merge pull request #8358 from fricklerhandwerk/output-addressed-references
...
fix wording on output-addressed store objects
2023-05-17 09:38:18 -04:00
Valentin Gagarin
76f40c02bf
fix wording on output-addressed store objects
...
hashing is an implementation detail.
add references to the other terms.
2023-05-17 15:04:08 +02:00
Valentin Gagarin
6a5a8f51bb
add cross-references to pure evaluation mode
...
use consistent wording everywhere.
add some details on the configuration option documentation.
2023-05-17 15:01:54 +02:00
Valentin Gagarin
549f8dc97b
document builtins.currentTime
2023-05-17 13:49:35 +02:00
Alexander Schmolck
8d4b6766e2
Convert short nix options to long ones
...
e.g. nix-env -e subversion => nix-env --uninstall subversion
The aim is to make the documentation less cryptic for newcomers and the
long options are more self-documenting.
The change was made with the following script:
<https://github.com/aschmolck/convert-short-nix-opts-to-long-ones >
and sanity checked visually.
2023-05-17 08:10:30 +01:00
Valentin Gagarin
8976769a1c
Reword info on XDG base dirs ( #8338 )
...
This gives some more context and should clarify why it works that way.
Also link it from the section on `NIX_USER_CONF_FILES`.
Co-authored-by: John Ericson <git@JohnEricson.me>
2023-05-15 23:30:20 -04:00
Valentin Gagarin
275468a1f0
list files used by nix-channel
2023-05-15 15:26:14 +02:00
John Ericson
914672dc4f
Merge pull request #8141 from tweag/user-files-doc
...
Document user files of nix
2023-05-15 07:11:47 -04:00
Victor Engmark
6e1bfb93dc
refactor: Join commands to remove files
2023-05-15 11:05:26 +12:00
Victor Engmark
ed016a5bb0
docs: Mention more files referenced by the installer
...
`/etc/bash.bashrc` is backed up as `/etc/bash.bashrc.backup-before-nix`,
but since other changes might have been introduced in the meantime we can't
just tell the user to revert.
2023-05-15 11:03:27 +12:00
Victor Engmark
e26aad22c6
docs: Remove references to non-existing files
...
At least on Ubuntu 22.04, these files are not created as part of a multi-
user installation.
2023-05-15 10:26:47 +12:00
Victor Engmark
17a1c1ee4e
docs: Sort files by name
2023-05-15 10:16:12 +12:00
Victor Engmark
3cc9b8630b
docs: Remove Nix profile content from correct directory
...
At least on Ubuntu 22.04, the Nix installer creates
`/etc/profile.d/nix.sh`, not `/etc/profile/nix.sh`.
2023-05-15 10:13:46 +12:00
Victor Engmark
ccf512f4b8
docs: Remove redundant uninstall command
...
`sudo systemctl disable nix-daemon.socket nix-daemon.service` removes these
files already.
2023-05-15 10:06:27 +12:00
Valentin Gagarin
454e273451
Merge pull request #8328 from urbas/max-substitution-jobs
2023-05-14 11:59:40 +02:00
Matej Urbas
c66a7af0c6
max-substitution-jobs release note entry
2023-05-14 09:51:11 +01:00
Ana Hobden
17fb346ec6
Describe the or operation on attribute sets slightly more
2023-05-12 11:03:09 -07:00
Alexander Bantyev
992be330ab
Update doc/manual/src/SUMMARY.md.in
...
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-05-12 16:58:01 +04:00
Valentin Gagarin
70eb9c7ddb
reword introduction to built-in functions
...
add anchor to `builtins.derivation` and list some built-in functions that are
exposed in the global scope.
I decided not to list everything, because we probably don't want to
encourage people using them that way.
2023-05-11 20:07:42 +02:00
Valentin Gagarin
69a0e6f86c
reword documentation on builtins
...
- add anchor to `builtins`
- add type information
- reword description of `builtins` to offer more information concisely
2023-05-11 17:46:37 +02:00
Valentin Gagarin
2ef7f14e28
do not indent markdown list
2023-05-11 15:29:03 +02:00
Valentin Gagarin
dc8191ae14
add redirect to track moved uninstall section
2023-05-03 11:39:29 +02:00
Valentin Gagarin
5d78dc4176
doc rendering: add functions to scope explicitly ( #7378 )
...
* doc rendering: add functions to scope explicitly
this especially helps beginners with code readability, since the origin
of names is always immediately visible.
2023-05-03 07:16:29 +00:00
Valentin Gagarin
f8620758aa
display documentation on manifest files separately
...
it's probably better not to show the manifest file documentation in the
command-specific pages, because these are implementation details that are not really practically useful.
this means no additional hassle for building the manual, but clutters
the table of contents a bit.
2023-04-28 12:10:36 +02:00
Valentin Gagarin
9b2a4a4729
move uninstall instructions to a separate page
...
placed in a subsection of the binary install, the instructions are hard
to find. putting them in a separate page that is shown in the table of
contents should make it easier for users to find what they need when
they need it.
2023-04-28 11:53:38 +02:00
Valentin Gagarin
da0dbf36cb
move manifest information to the bottom of the page
2023-04-26 15:39:35 +02:00
Valentin Gagarin
be7c236565
move compatibility info to nix profile docs
2023-04-26 15:39:35 +02:00
Valentin Gagarin
219aaf5a0b
increase heading level
...
otherwise the headings won't match at the point where they are included.
this is a bit hacky and brittle, but works for now.
2023-04-26 15:39:35 +02:00
Valentin Gagarin
bb8e3b5d86
update description on how profiles work
...
adapt to the example listing
2023-04-26 15:39:35 +02:00
Valentin Gagarin
7770d82240
fix typos and wording
2023-04-26 15:39:24 +02:00
Valentin Gagarin
9d386fe2ee
add colons to connect listings with descriptions
2023-04-26 15:39:16 +02:00
Valentin Gagarin
a1c996dc7e
list information regular users first
...
this is to make it consistent everywhere
2023-04-26 15:39:02 +02:00
Alexander Bantyev
8a93b5a551
Document user files of nix
2023-04-26 15:38:19 +02:00
Michael Utz
40fcb22313
Update installing-binary.md
2023-04-18 13:18:30 +03:00
Noah Snelson
324ed0c367
Documentation: fix typo for Nix database link in manual
...
Fixes broken link for `Nix database` anchor in the Glossary page of the
Nix manual.
2023-04-17 20:15:08 -07:00
Valentin Gagarin
39e0f609cc
Merge pull request #7514 from fricklerhandwerk/opt-I
...
remove incorrect reference to `NIX_PATH` documentation
2023-04-17 16:27:23 +02:00
Valentin Gagarin
f4119a67cc
use @docroot@ link
2023-04-17 14:54:30 +02:00
Valentin Gagarin
d0cf615cbb
add link to nix-conf setting
...
Co-authored-by: John Ericson <git@JohnEricson.me>
2023-04-17 14:27:26 +02:00
John Ericson
9800c1e807
Mark experimental configuration settings programmatically
...
Fix #8162
The test is changed to compare `nlohmann::json` values, not strings of dumped
JSON, which allows us to format things more nicely.
2023-04-16 10:58:04 -04:00
John Ericson
ba9ae691b6
Add optionalString to manual Nix lang utilities
...
Use it everywhere it could be also.
2023-04-16 10:57:46 -04:00
John Ericson
b41f739068
Merge pull request #7864 from obsidiansystems/quickstart-long-options
...
Use long options instead of short ones in the "quick start"
2023-04-14 09:13:16 -04:00
