Valentin Gagarin
927234cfb2
Merge pull request #6870 from amjoseph-nixpkgs/pr/doc/explain-local-remote-binary-substituter
2022-10-05 09:01:42 +02:00
Théophane Hufschmitt
3ae9467d57
Merge pull request #6969 from fricklerhandwerk/refactor-generate-manpage
...
refactor rendering command documentation to markdown
2022-10-03 15:50:17 +02:00
Valentin Gagarin
d8bef7358f
bring back lost newline
2022-09-30 01:43:57 +02:00
Valentin Gagarin
70eea97742
use more self-explanatory names
2022-09-30 01:43:57 +02:00
Valentin Gagarin
61188cb820
move final template to the top
...
this allows readers to enter the code starting with what is visible from
the outside, instead of working themselves up from purely technical details.
2022-09-30 01:43:57 +02:00
Valentin Gagarin
0e0f1832de
remove superfluous let-in pair
2022-09-30 01:43:57 +02:00
Valentin Gagarin
a85df04fcb
refactor showOptions
...
it was quite a pain to manipulate strings just with `builtins`
2022-09-30 01:43:53 +02:00
Valentin Gagarin
4655563470
refactor rendering command documentation to markdown
...
idea:
- make document structure visible, like in a template
- order functions by descending abstraction
- avoid nested let bindings
2022-09-30 01:42:46 +02:00
Valentin Gagarin
6b56bb4a79
use indented strings where appropriate
2022-09-30 01:42:46 +02:00
Solene Rapenne
847cd49909
nix-copy-closure: improve wording
2022-09-28 01:05:46 +02:00
Théophane Hufschmitt
6a64820cb4
Merge pull request #7082 from rapenne-s/ccache
...
add ccacheStdenv
2022-09-24 12:45:27 +02:00
Solène Rapenne
e04b38f789
add ccacheStdenv
...
when using ccache, rebuild time has been measured
89% faster while not slowing the speed of cold builds
2022-09-23 11:21:19 +02:00
Travis A. Everett
84bdb0e3ad
address review feedback
...
Mainly:
- Try to triangulate between narrative that framed this as
a new/easy process and the need for a reference that will
not quickly grow stale.
- Fix a ~continuity issue where the text was talking about
"your Cachix cache" before saying that you'd need to make
a Cachix cache to enable the installer tests.
- Adopt suggestion on titling, and nest subtitles in the
installer test section.
2022-09-18 13:02:42 -05:00
Travis A. Everett
4bd52bf6c4
Apply suggestions from code review
...
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-09-17 13:20:11 -05:00
Adam Joseph
ad5b09423a
release-notes/rl-next.md: note new argument to fetchurl.nix
2022-09-16 01:59:24 -07:00
Valentin Gagarin
dc8c0b173c
Update doc/manual/src/contributing/hacking.md
2022-09-16 09:36:55 +02:00
Valentin Gagarin
1ae974120a
Update doc/manual/src/contributing/hacking.md
2022-09-16 09:36:37 +02:00
Valentin Gagarin
0a4bd9fe88
Update doc/manual/src/contributing/hacking.md
2022-09-16 09:36:30 +02:00
Valentin Gagarin
47fa1087c8
Update doc/manual/src/contributing/hacking.md
2022-09-16 09:36:20 +02:00
Valentin Gagarin
1d295e5fe7
Merge pull request #6934 from fricklerhandwerk/revert-architecture
...
Revert #6420 "Document what Nix *is*" so we can start over with smaller change sets
2022-09-09 13:31:05 +02:00
Valentin Gagarin
8dd5ba2f47
more precise variable types
2022-09-09 09:54:24 +02:00
Valentin Gagarin
548c904d40
optimize performance
...
remove loops and function calls, modify arrays in place
this makes the whole thing harder to read, and probably only
marginally faster.
2022-09-08 11:58:43 +02:00
Valentin Gagarin
59be1e500a
generalize anchor redirects
...
renaming section headers and changing manually set `id`s will break URLs
in the wild.
this change allows keeping track of all changes to ensure backwards
compatibility.
2022-09-06 00:49:16 +02:00
Adam Joseph
e90f2fcfc7
glossary: add entry for chroot store
(used 11 times in nix)
2022-09-01 18:28:05 -07:00
Adam Joseph
e6f5352e71
#binary-cache -> #gloss-binary-cache
2022-09-01 18:27:00 -07:00
Adam Joseph
59dc8346ca
move substituter signature-checking conditions to configuration file documentation
2022-09-01 17:51:56 -07:00
Adam Joseph
f6c750e8b2
glossary: remove extraneous comma
2022-09-01 17:48:34 -07:00
Adam Joseph
887e922be2
glossary: outputHash, not __outputHash
2022-09-01 17:47:13 -07:00
Adam Joseph
d5e064d816
glossary: fix broken link
2022-09-01 17:46:31 -07:00
Adam Joseph
57f12df5e4
input-addressed store object: include FODOs
2022-09-01 15:09:10 -07:00
Adam Joseph
8139bbe2ba
implement https://github.com/NixOS/nix/pull/6870#pullrequestreview-1093700220
2022-09-01 15:01:07 -07:00
Adam Joseph
def4fb9a0f
__outputHash: add link
2022-09-01 14:47:33 -07:00
Adam Joseph
1b2b8c39fd
fix link to language/advanced-attributes.md#adv-attr-contentAddressed
2022-09-01 14:47:17 -07:00
Adam Joseph
0a98d564b3
glossary: resolve FIXME in #gloss-fixed-output-derivation
2022-09-01 14:41:27 -07:00
Adam Joseph
1f56b5d772
doc/manual: un-inline definitions from substitute
2022-09-01 14:13:21 -07:00
Adam Joseph
41153f30bd
glossary: substituter: merge output-addressed cases
2022-09-01 14:13:21 -07:00
Adam Joseph
9cb8412143
Update doc/manual/src/glossary.md
...
Co-authored-by: John Ericson <git@JohnEricson.me>
2022-09-01 20:41:04 +00:00
Adam Joseph
2812682ebe
Update doc/manual/src/glossary.md
...
Co-authored-by: John Ericson <git@JohnEricson.me>
2022-09-01 20:40:39 +00:00
Adam Joseph
520587b9a0
glossary: local store: clarify
2022-09-01 13:39:48 -07:00
Valentin Gagarin
f35b3aa47b
do not use unwarranted pkgs in example
2022-08-31 09:16:37 +02:00
Eelco Dolstra
1f2b12b30e
Merge pull request #6968 from fricklerhandwerk/man-no-weblinks
...
do not render relative links in help pages
2022-08-29 08:46:35 +02:00
Valentin Gagarin
e7dcacbd7c
do not render relative links in help pages
...
this simplifies the setup a lot, and avoids weird looking `./file.md`
links showing up.
it also does not show regular URLs any more. currently the command
reference only has few of them, and not showing them in the offline
documentation is hopefully not a big deal.
instead of building more special-case solutions, clumsily preprocessing
the input, or issuing verbal rules on dealing with URLs, should better
be solved sustainably by not rendering relative links in `lowdown`:
https://github.com/kristapsdz/lowdown/issues/105
2022-08-26 17:10:41 +02:00
Eelco Dolstra
b0488a29dc
Branch 2.11 release notes
2022-08-24 22:44:58 +02:00
Eelco Dolstra
04e74f7c8b
Merge pull request #6612 from NixOS/parallel-nix-copy
...
Make nix copy parallel again
2022-08-24 15:31:42 +02:00
Eelco Dolstra
4c96761c2b
Merge remote-tracking branch 'origin/master' into parallel-nix-copy
2022-08-22 15:29:10 +02:00
Valentin Gagarin
d8e54d19f7
Revert "Merge pull request #6420 from nix-community/doc-what-is-nix"
...
This reverts commit 81e101345f
, reversing
changes made to 7d1280bbaf
.
2022-08-22 12:52:15 +02:00
Valentin Gagarin
703b335c1d
reword description of language properties
...
the list style is supposed to give more structure.
each property is explained as concisely as possible while trying not to
sound too fancy.
2022-08-15 11:34:39 +02:00
Valentin Gagarin
71e9c28694
reword introduction to overview
2022-08-15 11:15:03 +02:00
Valentin Gagarin
bc315326fa
fix whitespace to please markdown
...
keep some indentation to ease source readability
2022-08-15 11:13:05 +02:00
Valentin Gagarin
6ba8d6dc82
add more examples on string interpolation
2022-08-15 11:06:40 +02:00
Valentin Gagarin
c209e6e108
add more list examples
2022-08-15 10:18:56 +02:00
Valentin Gagarin
0378531bf2
add curried function
2022-08-15 10:18:56 +02:00
Valentin Gagarin
2e4704ca93
add second @ pattern example
2022-08-15 10:18:56 +02:00
Valentin Gagarin
5c25bdee50
add null
2022-08-15 10:18:56 +02:00
Valentin Gagarin
391fd10b12
add home path
2022-08-15 10:18:56 +02:00
Valentin Gagarin
587ae9ada5
add search path
2022-08-15 10:18:56 +02:00
Valentin Gagarin
21438acc70
add absolute path
2022-08-15 10:18:56 +02:00
Valentin Gagarin
e6f7c180de
add floating point number
2022-08-15 10:18:56 +02:00
Valentin Gagarin
292cab039d
add multi-line string
2022-08-15 10:18:56 +02:00
Valentin Gagarin
f165a8ae08
flarify relative path semantics
2022-08-15 10:18:56 +02:00
Valentin Gagarin
43188d3d18
make hash and version distinguishable as placeholder
2022-08-15 10:18:56 +02:00
Valentin Gagarin
90836397d3
remove stale section link
2022-08-15 10:18:56 +02:00
Valentin Gagarin
3378a3bce8
add syntax overview from NixOS manual
...
taken verbatim to keep track of required corrections.
made it an HTML table to more easily change structure and keep diffs
minimal.
2022-08-15 10:18:56 +02:00
Eelco Dolstra
af4e8b00fb
Merge pull request #6882 from DeterminateSystems/allow-multi-user-as-root
...
Allow installing multi-user as root on macOS and Linux
2022-08-12 10:19:03 +02:00
Graham Christensen
7bb1e913b3
Don't prompt about using sudo if we're already root
2022-08-10 09:37:08 -04:00
Graham Christensen
88a0f3b6ba
Strip whitespace in installing-binary.md
2022-08-10 09:37:08 -04:00
Adam Joseph
bac1e1bf8c
Update doc/manual/src/glossary.md
...
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-08-08 17:52:31 +00:00
Travis A. Everett
9b7bd2dd1f
Apply suggestions from code review
...
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-08-08 10:04:27 -05:00
Travis A. Everett
b5d85f0922
Apply suggestions from code review
...
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-08-05 13:49:18 -05:00
Adam Joseph
1d3b92e80c
move package-management/terminology into glossary.md
2022-08-05 10:39:43 -07:00
Adam Joseph
4de95f7f56
gesture at explanation of why binary caches exist
2022-08-05 10:33:48 -07:00
Adam Joseph
d5506aa712
Update doc/manual/src/package-management/terminology.md
...
Co-authored-by: Attila Gulyas <toraritte@gmail.com>
2022-08-05 17:19:52 +00:00
Adam Joseph
66a93a76b9
Update doc/manual/src/package-management/terminology.md
...
Co-authored-by: Attila Gulyas <toraritte@gmail.com>
2022-08-05 17:15:37 +00:00
Adam Joseph
2eb74c918d
derivations do not need to be signed
2022-08-05 10:13:41 -07:00
Adam Joseph
aae771cad2
!implement https://github.com/NixOS/nix/pull/6870#discussion_r938912244
2022-08-05 10:12:46 -07:00
Eelco Dolstra
4eb566603a
Comment out the architecture section
...
This needs more review and probably should be a separate book.
2022-08-05 11:01:40 +02:00
Adam Joseph
1b97f3872e
!fixup: transposed characters
2022-08-04 14:22:14 -07:00
Adam Joseph
62674659ed
!fixup capitalize Nix
2022-08-04 14:21:17 -07:00
Adam Joseph
8f44d24c52
!fixup whitespace
2022-08-04 14:19:25 -07:00
Adam Joseph
56d4fc194b
fourth trust condition: FODs
2022-08-04 14:14:24 -07:00
Adam Joseph
a5be5e0120
doc/manual: define {local,remote} store, binary cache, substituter
...
Nix veterans intuitively know what the following terms mean. They are
used in several places in the nix documentation, but never defined:
- local store
- remote store
- binary cache
- substituter
In particular, I found the last two terms to be confusingly similar.
Let's give definitions for them.
2022-08-04 14:07:06 -07:00
John Ericson
39d32ac4c6
Add disclaimer that arch section is WIP and links may rot
...
So we can iterate without worrying so much.
2022-08-04 14:02:58 -04:00
John Ericson
6f6498f59c
Remove header fragments which is not needd
2022-08-04 14:02:38 -04:00
John Ericson
016d7a8f78
Fix rosetta stone file name
2022-08-04 14:02:19 -04:00
John Ericson
b430a6743c
Remove sections within from SUMMARY
2022-08-04 14:01:55 -04:00
John Ericson
bc118854d0
Merge remote-tracking branch 'upstream/master' into doc-what-is-nix
2022-08-04 09:11:42 -04:00
Valentin Gagarin
b631742277
fix page rendering
...
apparently it is not possible to link to page anchors with `mdBook`[1]
[1]: https://github.com/rust-lang/mdBook/issues/167
2022-08-04 14:31:33 +02:00
Domen Kožar
7d1280bbaf
Merge pull request #6678 from abathur/update_darwin_uninstall
...
doc: update darwin uninstall instructions
2022-08-04 14:09:09 +02:00
Valentin Gagarin
cc3a5f4ba2
use correct mdBook syntax for callouts
2022-08-04 14:04:14 +02:00
Valentin Gagarin
8cec32e7f5
fix directory tree renderings
2022-08-04 13:51:35 +02:00
Domen Kožar
84a26882f8
Update doc/manual/src/installation/installing-binary.md
...
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-08-04 06:23:45 -05:00
Domen Kožar
3c2de2da01
Update doc/manual/src/installation/installing-binary.md
...
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-08-04 06:23:36 -05:00
Valentin Gagarin
3df1ee2ba5
clarify what explicitly declaring certain dependencies means
2022-08-04 12:37:48 +02:00
Valentin Gagarin
b7309ce624
move architecture to the end
2022-08-04 12:37:48 +02:00
Valentin Gagarin
00a7eaed67
add file system object to table of contents
2022-08-04 12:37:48 +02:00
Valentin Gagarin
db6faf44a9
clarify what store objects can be
...
the store of course makes a distinction, but that is not relevant here
2022-08-04 12:37:48 +02:00
Valentin Gagarin
0228eb8ae7
add Java example on manual dependency declaration
2022-08-04 12:37:48 +02:00
Valentin Gagarin
29c062537d
hashes: truncate -> reduce, mention SHA-256
...
the longer SHA-256 hashes are not truncated, but in fact processed.
Co-authored-by: Thomas <twatson52@mac.com>
2022-08-04 12:37:48 +02:00
Valentin Gagarin
9cabba1fc3
mention hard links
...
Co-authored-by: Thomas <twatson52@mac.com>
2022-08-04 12:37:48 +02:00
Valentin Gagarin
bac86231ad
use "build plan" consistently
2022-08-04 12:37:47 +02:00