aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/src
AgeCommit message (Collapse)Author
2022-08-04remove separate meta-section, add architecture diagramValentin Gagarin
the diagram is a first approximation and only covers that same section. of course there is much more going on, and other features should at some point also be illustrated. we also have to think about presentation format and technicalities behind it. the manual has to render to `man`, but we may want something more refined for web view.
2022-08-04reword introductory sectionValentin Gagarin
there should be a meta section for each chapter to give motivation of the presented structure. the structure itself is visible from the table of contents.
2022-08-04remove sentence for chapter transitionValentin Gagarin
idea: sections could be read in different orders by linking them in different ways (e.g. depth-first or breadth-first). adding hard-coded transitions makes that confusing.
2022-08-04Apply suggestions from code reviewJohn Ericson
Co-authored-by: Valentin Gagarin <valentin@fricklerhandwerk.de>
2022-08-04do not mention implementation detailsValentin Gagarin
Co-authored-by: John Ericson <git@JohnEricson.me>
2022-08-04correctly use comma for nestingValentin Gagarin
Co-authored-by: John Ericson <git@JohnEricson.me>
2022-08-04indicate sequence with "then"Valentin Gagarin
Co-authored-by: John Ericson <git@JohnEricson.me>
2022-08-04only use generic build system terminologyValentin Gagarin
we will use a translation table to introduce nix-specific terms
2022-08-04reword overview with clear terminologyValentin Gagarin
trying to capture alternative terms in one go here, mirroring everyday use: derivation - build plan realise - execute build there will be more of that sort.
2022-08-04Add draft "Rosetta stone" by @fricklerhandwerk and stub commentaryJohn Ericson
The idea and most of the execution are @fricklerhandwerk's. I changed a few things best I could based on @edolstra's corrections, and a Bazel glossary. Valentin Gagarin <valentin@fricklerhandwerk.de>
2022-08-04Make refernces sneak preview more conciseJohn Ericson
2022-08-04Improve store objects session moreJohn Ericson
2022-08-04Include abstract syntax based on the thesis for FSOsJohn Ericson
See https://edolstra.github.io/pubs/phd-thesis.pdf, page 91.
2022-08-04store objects, better opining sentancesJohn Ericson
2022-08-04Improve store path sectionJohn Ericson
2022-08-04Relocability -> relocation in store object titleJohn Ericson
2022-08-04Improve store object sectionJohn Ericson
In particular, Nix is *not* like Git, so that needs to be fixed.
2022-08-04doc: File system data -> file system object, to match NixJohn Ericson
2022-08-04Rename files after store entry -> store object renameJohn Ericson
2022-08-04doc: Store entry -> store objectJohn Ericson
This matches the terminology in Eelco's thesis.
2022-08-04Update doc/manual/src/design/store/drvs/drvs.mdJohn Ericson
Co-authored-by: Matthieu Coudron <teto@users.noreply.github.com>
2022-08-04Update doc/manual/src/design/overview.mdJohn Ericson
Co-authored-by: Valentin Gagarin <valentin@fricklerhandwerk.de>
2022-08-04Update doc/manual/src/design/overview.mdJohn Ericson
Co-authored-by: Valentin Gagarin <valentin@fricklerhandwerk.de>
2022-08-04Update doc/manual/src/design/overview.mdJohn Ericson
Co-authored-by: Valentin Gagarin <valentin@fricklerhandwerk.de>
2022-08-04Fix stub file's nameJohn Ericson
2022-08-04Start on the derivations sectionJohn Ericson
2022-08-04Move the bits on relocating store entires to the endJohn Ericson
They are too advanced for up front.
2022-08-04Apply suggestions from code reviewJohn Ericson
2022-08-04Flesh out TOCJohn Ericson
2022-08-04Briefly describe the digest of a store pathJohn Ericson
2022-08-04WIP: Document the design of NixJohn Ericson
The current docs are all "how to do things" and no "what is Nix" or "why are things the way they are". I see lots of misconception on the wider internet, and I also think we would benefit from a "living document" to answer some questions people currently turn to the thesis for. I think a new section of the manual can address all these issues.
2022-08-04manual: remove "Writing Nix Expressions" chapterValentin Gagarin
it is out of date, all over the place in level of detail, is really about `nixpkgs`, and in general instructions should not be part of a reference manual. also: - update redirects and internal links - use "Nix language" consistently
2022-08-03Merge pull request #6846 from fricklerhandwerk/valuesThéophane Hufschmitt
manual: use subheadings for primitive types
2022-08-03Fix the html id of the list headersThéophane Hufschmitt
2022-08-03encode primitive as list with anchorsValentin Gagarin
to make it consistent with builtins and configuration options
2022-08-01doc/distributed-builds: don't use deprecated aliasK900
`nix ping-store` -> `nix store ping`.
2022-07-28manual: use singular in body, tooValentin Gagarin
Co-authored-by: Cole Helbling <cole.e.helbling@outlook.com>
2022-07-28manual: values -> data typesValentin Gagarin
2022-07-28manual: use singular for headingsValentin Gagarin
2022-07-28manual: simple values -> primitivesValentin Gagarin
"simple" is a loaded term
2022-07-28manual: use subheadings for primitive typesValentin Gagarin
this gives us HTML anchors for each of them
2022-07-28manual: set -> attribute setValentin Gagarin
reword description to have shorter sentences.
2022-07-28manual: fix section title in table of contentsValentin Gagarin
2022-07-20Merge branch 'master' into parallel-nix-copyThéophane Hufschmitt
2022-07-11Branch 2.10 release notesEelco Dolstra
2022-07-11Merge pull request #6777 from laalsaas/masterEelco Dolstra
Fix logical and typographical errors in nix-env man page
2022-07-11Update release notesEelco Dolstra
2022-07-10Fix logical and typographical errors in nix-env man pagelaalsaas
2022-07-06Add a release notes entry for #4914Théophane Hufschmitt
cc @gytis-ivaskevicius
2022-06-30doc: acknowledge post-rsync realityTravis A. Everett
Before #5150 the copy-to-store phase of the install was idempotent, but the recursive cp isn't. This is probably baiting a few people into trying corrective installs that will fail.