12609 commits

This branch

This branch

All branches

Author	SHA1	Message	Date
Valentin Gagarin	7598126391	remove separate meta-section, add architecture diagram ... 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-04 12:37:46 +02:00
Valentin Gagarin	34ea74c9ec	reword introductory section ... 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-04 12:37:46 +02:00
Valentin Gagarin	b387d80943	remove sentence for chapter transition ... 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-04 12:37:46 +02:00
John Ericson	89a7c956ff	Apply suggestions from code review ... Co-authored-by: Valentin Gagarin <valentin@fricklerhandwerk.de>	2022-08-04 12:37:46 +02:00
Valentin Gagarin	51e6bed25e	do not mention implementation details ... Co-authored-by: John Ericson <git@JohnEricson.me>	2022-08-04 12:37:46 +02:00
Valentin Gagarin	23ee0b24f7	correctly use comma for nesting ... Co-authored-by: John Ericson <git@JohnEricson.me>	2022-08-04 12:37:46 +02:00
Valentin Gagarin	804e8bd747	indicate sequence with "then" ... Co-authored-by: John Ericson <git@JohnEricson.me>	2022-08-04 12:37:46 +02:00
Valentin Gagarin	327ccd3b07	only use generic build system terminology ... we will use a translation table to introduce nix-specific terms	2022-08-04 12:37:46 +02:00
Valentin Gagarin	0eae4bfad1	reword overview with clear terminology ... 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-04 12:37:46 +02:00
John Ericson	0737094161	Add draft "Rosetta stone" by @fricklerhandwerk and stub commentary ... 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-04 12:37:46 +02:00
John Ericson	c86c1ec7e3	Make refernces sneak preview more concise	2022-08-04 12:37:46 +02:00
John Ericson	4e4bbd9e83	Improve store objects session more	2022-08-04 12:37:46 +02:00
John Ericson	e4eea5e84e	Include abstract syntax based on the thesis for FSOs ... See https://edolstra.github.io/pubs/phd-thesis.pdf, page 91.	2022-08-04 12:37:46 +02:00
John Ericson	b98dc3b19c	store objects, better opining sentances	2022-08-04 12:37:46 +02:00
John Ericson	55b437b551	Improve store path section	2022-08-04 12:37:46 +02:00
John Ericson	b4df351880	Relocability -> relocation in store object title	2022-08-04 12:37:46 +02:00
John Ericson	5f4d2ac091	Improve store object section ... In particular, Nix is *not* like Git, so that needs to be fixed.	2022-08-04 12:37:46 +02:00
John Ericson	1bbad62c7d	doc: File system data -> file system object, to match Nix	2022-08-04 12:37:46 +02:00
John Ericson	838ba26fda	Rename files after store entry -> store object rename	2022-08-04 12:37:46 +02:00
John Ericson	4e2d5ae202	doc: Store entry -> store object ... This matches the terminology in Eelco's thesis.	2022-08-04 12:37:46 +02:00
John Ericson	e308602fdf	Update doc/manual/src/design/store/drvs/drvs.md ... Co-authored-by: Matthieu Coudron <teto@users.noreply.github.com>	2022-08-04 12:37:46 +02:00
John Ericson	cdb0bf3b65	Update doc/manual/src/design/overview.md ... Co-authored-by: Valentin Gagarin <valentin@fricklerhandwerk.de>	2022-08-04 12:37:46 +02:00
John Ericson	75c5191a1f	Update doc/manual/src/design/overview.md ... Co-authored-by: Valentin Gagarin <valentin@fricklerhandwerk.de>	2022-08-04 12:37:46 +02:00
John Ericson	a04340f9a1	Update doc/manual/src/design/overview.md ... Co-authored-by: Valentin Gagarin <valentin@fricklerhandwerk.de>	2022-08-04 12:37:46 +02:00
John Ericson	f5386d7059	Fix stub file's name	2022-08-04 12:37:46 +02:00
John Ericson	678d75baea	Start on the derivations section	2022-08-04 12:37:46 +02:00
John Ericson	e3a0209a9e	Move the bits on relocating store entires to the end ... They are too advanced for up front.	2022-08-04 12:37:46 +02:00
John Ericson	a210504bc7	Apply suggestions from code review	2022-08-04 12:37:46 +02:00
John Ericson	e64633f98f	Flesh out TOC	2022-08-04 12:37:46 +02:00
John Ericson	a2b3160f28	Briefly describe the digest of a store path	2022-08-04 12:37:46 +02:00
John Ericson	523359d133	WIP: Document the design of Nix ... 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-04 12:37:46 +02:00
Valentin Gagarin	499ed26508	manual: remove "Writing Nix Expressions" chapter ... 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-04 11:59:25 +02:00
Erik Arvstedt	4c8441be0a	docs/flake-update: fix example	2022-08-04 09:45:30 +02:00
Erik Arvstedt	53833dfb40	libexpr/flake: remove FIXME ... Line 593 checks that all overrides (i.e. all elements of `lockFlags.inputOverrides`) are members of `overridesUsed`.	2022-08-04 09:45:29 +02:00
Erik Arvstedt	c9f446ede1	flakeref: fix comment	2022-08-04 09:45:28 +02:00
Eelco Dolstra	075bf6e556	Merge pull request #6861 from edolstra/fix-count-calls ... Fix NIX_COUNT_CALLS=1	2022-08-03 18:26:01 +02:00
Eelco Dolstra	ccbd906c86	Fix NIX_COUNT_CALLS=1 ... Also, make the JSON writer support std::string_view. Fixes #6857.	2022-08-03 17:46:51 +02:00
Théophane Hufschmitt	7d1ccd9105	Merge pull request #6846 from fricklerhandwerk/values ... manual: use subheadings for primitive types	2022-08-03 14:50:41 +02:00
Théophane Hufschmitt	c55bea4204	Fix the html id of the list headers	2022-08-03 14:16:00 +02:00
Valentin Gagarin	ceed4d4142	encode primitive as list with anchors ... to make it consistent with builtins and configuration options	2022-08-03 11:25:41 +02:00
Théophane Hufschmitt	780a479386	Merge pull request #6851 from K900/patch-1 ... doc/distributed-builds: don't use deprecated alias	2022-08-02 07:17:09 +02:00
K900	f675ba5331	doc/distributed-builds: don't use deprecated alias ... `nix ping-store` -> `nix store ping`.	2022-08-01 13:50:35 +03:00
Jeremy Fleischman	297f6b5d56	Fix link to hacking doc ... Right now, https://hydra.nixos.org/job/nix/master/build.x86_64-linux/latest/download-by-type/doc/manual/contributing/hacking.html redirects to https://hydra.nixos.org/build/183877779/download/1/manual/contributing/hacking.html, which gives me a "500 Internal Server Error". Not super useful =( Feel free to ignore if someone's working to fix the 500 I was running into.	2022-07-30 09:12:50 -07:00
Rok Garbas	e9178d7d4a	Merge pull request #6844 from centromere/custom-nix-conf ... docker.nix: Allow Nix configuration to be customized	2022-07-29 13:47:24 +02:00
Valentin Gagarin	27138f1ec6	manual: use singular in body, too ... Co-authored-by: Cole Helbling <cole.e.helbling@outlook.com>	2022-07-28 23:30:07 +02:00
Valentin Gagarin	41a3b315fd	manual: values -> data types	2022-07-28 17:25:25 +02:00
Valentin Gagarin	8f4fab8fab	manual: use singular for headings	2022-07-28 17:25:18 +02:00
Valentin Gagarin	4ff48854b8	manual: simple values -> primitives ... "simple" is a loaded term	2022-07-28 17:23:57 +02:00
Valentin Gagarin	3063e5b94c	manual: use subheadings for primitive types ... this gives us HTML anchors for each of them	2022-07-28 17:23:57 +02:00
Eelco Dolstra	86fcd4f692	Merge pull request #6845 from fricklerhandwerk/attrset ... manual: set -> attribute set	2022-07-28 16:55:03 +02:00