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
b74a3f51c2
Fix gitignore
2022-08-04 14:01:27 -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
Eelco Dolstra
6fa2e8cb6f
Merge pull request #6805 from jfly/jfly/fix-link-to-hacking-doc
...
Fix link to hacking doc
2022-08-04 13:35:52 +02:00
Eelco Dolstra
c9b24f0c17
Merge pull request #6863 from fricklerhandwerk/remove-writing-expressions
...
manual: remove "Writing Nix Expressions" chapter
2022-08-04 13:25:34 +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
Eelco Dolstra
bc5907ff94
Merge pull request #6862 from erikarvstedt/fix-flake-update-doc
...
docs/flake-update: fix example
2022-08-04 13:23:45 +02: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
Valentin Gagarin
5a5a95696f
note customized base32
...
Nix omits E O U T characters for some reason.
2022-08-04 12:37:47 +02:00
Valentin Gagarin
de5dea45f7
use correct Nix entity
...
Nix itself does care a lot about what type of store object you have.
2022-08-04 12:37:47 +02:00
Valentin Gagarin
fe4c0b8d75
fix typo
...
Co-authored-by: Thomas <twatson52@mac.com>
2022-08-04 12:37:47 +02:00
Valentin Gagarin
def80d5777
add subsections to table of contents
2022-08-04 12:37:47 +02:00
Valentin Gagarin
c345345dee
concept map: align hights
...
this has the weird but nice emergent property that terms at the same
height are roughly at the same level of abstraction.
2022-08-04 12:37:47 +02:00
Valentin Gagarin
a28d6878b2
concept map: put closure as it is in the chapter
...
this is not as compact any more, but it more closely resembles the
chapter structure, and clearly shows that the closure property is the
key idea on which most of Nix operates.
2022-08-04 12:37:47 +02:00
Valentin Gagarin
475a332025
make concept map even more compact
2022-08-04 12:37:47 +02:00
Valentin Gagarin
d8b2f9f772
make concept map more compact
...
invert arrows to/from derivation:
- we need closures to form derivations
- we need derivations to perform builds
2022-08-04 12:37:47 +02:00
Valentin Gagarin
348432f48f
store: add concept map
...
this should help nativate the chapter by indicating which terms should
be known to understand a given concept.
2022-08-04 12:37:47 +02:00
Valentin Gagarin
ec43977553
store: match chapter introduction to outline
...
the various levels of detail should describe the same things.
2022-08-04 12:37:47 +02:00
Valentin Gagarin
7c656d90ca
simplify description of diagram
...
try not to be too fancy, it's just for reading the diagram out loud.
2022-08-04 12:37:47 +02:00
Valentin Gagarin
631ca18ee6
reword notes on copying
...
clarify that we are copying between different stores. we have not
introduced that notion or why it would be interesting, but for now it
should be fine to keep it in context of the store directory.
we could move that later to a more detailed explanation of different
store types.
2022-08-04 12:37:47 +02:00
Valentin Gagarin
c10dcccccd
make example a simple list
...
using JSON notation is unwarranted and not explained.
2022-08-04 12:37:47 +02:00
Valentin Gagarin
9c544813d7
paths -> path
...
use singular for terminology uniformly
2022-08-04 12:37:47 +02:00
Valentin Gagarin
1681f4e9f3
better explain reference scanning
2022-08-04 12:37:47 +02:00
Valentin Gagarin
fa7ad4593d
explain store directory
2022-08-04 12:37:47 +02:00
Valentin Gagarin
f632816cba
add explanation and examples of file system objects
2022-08-04 12:37:47 +02:00
Valentin Gagarin
84ddfbf8fd
remove diagonal from operations diagram
2022-08-04 12:37:47 +02:00
Valentin Gagarin
93f721b0d2
remove draft on derivations
2022-08-04 12:37:47 +02:00
Valentin Gagarin
19d8a5d839
move first mention of file system object before diagram
2022-08-04 12:37:47 +02:00
Valentin Gagarin
a90fc62b61
make clear that file system is for processes
...
Co-authored-by: John Ericson <John.Ericson@Obsidian.Systems>
2022-08-04 12:37:47 +02:00
Valentin Gagarin
7993ba1f38
constrain garbage collection scope
...
garbage collection is now incremental, and may (in theory) never delete all unreferenced objects if it is slow enough.
2022-08-04 12:37:47 +02:00
Valentin Gagarin
195aa28ff7
references are added according to build task
...
at this level of abstraction we do not really care about build instructions or what they are, and also build instructions including their arguments really amount to the build task.
2022-08-04 12:37:47 +02:00
Valentin Gagarin
80de4a4804
operations diagram: store' to the right
...
this also looks more diverse, hopefully easier to distinguish
Co-authored-by: John Ericson <John.Ericson@Obsidian.Systems>
2022-08-04 12:37:47 +02:00
Valentin Gagarin
3794618cce
add commas between output values
2022-08-04 12:37:47 +02:00
Valentin Gagarin
7b7e4c6340
use singular to match section heading
2022-08-04 12:37:47 +02:00
Valentin Gagarin
e63a768e21
use reference links for URLs
2022-08-04 12:37:47 +02:00
Valentin Gagarin
843288a451
add subsections for objects and references
...
group description of data instead of spreading it across the section.
that should help direct skimming. as it turns out, people do not
actually read any of that.
2022-08-04 12:37:47 +02:00
Valentin Gagarin
4341849193
move closure property to discussion references
2022-08-04 12:37:47 +02:00
