nix-super

mirror of https://github.com/privatevoid-net/nix-super.git synced 2024-11-24 14:56:15 +02:00

Author	SHA1	Message	Date
Valentin Gagarin	b8a1ff98c1	use HTML anchors for config parameters this avoids incorrect rendering on the man pages, since `lowdown` neither parses the anchor syntax nor HTML. this should rather be fixed in lowdown, as adding more anchors would otherwise produce ever more noise and error-prone repetition.	2022-12-07 16:18:50 +01:00
Eelco Dolstra	b5b7902a08	Merge branch 'master' into remove-repeat	2022-12-07 16:04:47 +01:00
Eelco Dolstra	703d863a48	Trivial changes from the lazy-trees branch	2022-12-07 14:06:34 +01:00
endgame	c710aa1abd	Post build hook signing (#7408 ) * docs: Use secret-key-files when demonstrating post-build-hooks The docs used to recommend calling `nix store sign` in a post-build hook, but on more recent versions of nix, this results in unsigned store paths being copied into binary caches. See https://github.com/NixOS/nix/issues/6960 for details. Instead, use the `secret-key-files` config option, which signs all locally-built derivations with the private key. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>	2022-12-07 13:55:02 +01:00
Linus Heckemann	8e0946e8df	Remove repeat and enforce-determinism options These only functioned if a very narrow combination of conditions held: - The result path does not yet exist (--check did not result in repeated builds), AND - The result path is not available from any configured substituters, AND - No remote builders that can build the path are available. If any of these do not hold, a derivation would be built 0 or 1 times regardless of the repeat option. Thus, remove it to avoid confusion.	2022-12-07 11:36:48 +01:00
Eelco Dolstra	5b4b2eefa1	Release notes	2022-12-06 13:55:09 +01:00
Valentin Gagarin	180538672a	disallow selecting shell prompt in code samples this is a quick half-fix for command line examples, as discussed discussed in [1]. [1]: https://github.com/NixOS/nix/pull/7389 examples which look like this $ foo bar baz are confusing for Unix shell beginners, because it's hard to discern what is supposed to be entered into the actual command line when the convention of prefixing `$` is not known, as barely any real-world shell looks that way any more. this change prevents selecting the prompt part with the mouse in the HTML representation of the Nix manual. it does not prevent selecting the output part of the shell example. it also does not address that the copy button provided by mdBook takes the entire sample, including the prompts, into the clipboard.	2022-12-05 11:01:46 +01:00
Valentin Gagarin	ca42068bdc	Merge pull request #7251 from RelationalAI-oss/sp-docs-uninstall-prompt docs: drop shell prompt character for consistency	2022-12-01 19:24:09 +01:00
Valentin Gagarin	dfa27e6b2f	refactor rendering documentation of options this makes more obvious what the code produces, and the structure of the output easier to change	2022-12-01 06:08:08 +01:00
Valentin Gagarin	0ea62670ed	move documentation on `auto-allocate-uids` to options docs this is where it belongs and can be found together with the other options.	2022-12-01 04:40:02 +01:00
Valentin Gagarin	3f881e3378	add missing newline, for consistent formatting	2022-11-30 23:40:53 +01:00
Théophane Hufschmitt	0596bdf3a9	Merge pull request #7342 from fricklerhandwerk/refactor-generate-builtins refactor rendering documentation of builtins	2022-11-29 15:55:43 +01:00
Eelco Dolstra	7dd3e1fec4	Add example	2022-11-28 22:04:51 +01:00
Eelco Dolstra	67bcb99700	Add a setting for enabling cgroups	2022-11-28 21:54:02 +01:00
Liu Xiaoyi	c4ce89f772	Clarify uninstallation steps on Linux Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>	2022-11-26 22:01:51 +08:00
John Ericson	26534f141c	Merge branch 'master' into indexed-store-path-outputs	2022-11-25 08:14:32 -05:00
Valentin Gagarin	d6318e1638	refactor rendering documentation of builtins as in [1], make the document structure visible, like in a template [1]: `4655563470`	2022-11-24 14:15:43 +01:00
Eelco Dolstra	2aa3f2e810	Include UID in hex	2022-11-23 17:07:59 +01:00
Eelco Dolstra	989fc8a8b9	Add release notes	2022-11-23 15:24:50 +01:00
Valentin Gagarin	52f0c80917	fix error in language overview it is not possible to antiquote numbers.	2022-11-22 10:36:21 +01:00
Liu Xiaoyi	4d55acf515	Apply suggestions from code review Co-authored-by: Sandro <sandro.jaeckel@gmail.com>	2022-11-21 13:46:22 +08:00
Liu Xiaoyi	cc620d961f	Updated uninstall guide involving systemd Co-authored-by: sequencer <liu@jiuyang.me>	2022-11-20 20:04:29 +08:00
Théophane Hufschmitt	6bf8736517	Add release-notes for the context-restriction in readFile	2022-11-14 15:03:53 +01:00
Théophane Hufschmitt	302ddee749	Merge pull request #7279 from fricklerhandwerk/uninstall add removing users to uninstall instructions	2022-11-11 14:39:07 +01:00
Valentin Gagarin	2af036e5a3	remove stray comma	2022-11-11 14:01:13 +01:00
Théophane Hufschmitt	f225f43076	Merge pull request #7006 from fricklerhandwerk/redirects manual: generalize anchor redirects	2022-11-09 11:23:26 +01:00
Valentin Gagarin	9d20a056c8	remove external link the language has its own overview page where its properties are described in sufficient detail.	2022-11-09 01:36:17 +01:00
Valentin Gagarin	3d716df7ce	make diagrams compatible with svgbob this will at some point enable rendering them nicely for the web	2022-11-09 01:29:01 +01:00
Valentin Gagarin	98447c1a7f	clarify subject of sentence Co-authored-by: Bryan Honof <bryan.honof@tweag.io>	2022-11-09 01:29:01 +01:00
Valentin Gagarin	b5728ace5d	add articles	2022-11-09 01:29:01 +01:00
Valentin Gagarin	be8744f937	manual: architecture overview these changes were not merged properly and had to be reverted. see merge commit `d8e54d19f7` for full history leading up to here.	2022-11-09 01:29:01 +01:00
Valentin Gagarin	d8781c4fc5	add removing users to uninstall instructions	2022-11-09 01:11:47 +01:00
Valentin Gagarin	ffca3e34cb	Merge pull request #6906 from fricklerhandwerk/language-overview add syntax overview from NixOS manual	2022-11-09 00:52:53 +01:00
Valentin Gagarin	daedaa197d	fix typos in comments	2022-11-09 00:49:34 +01:00
Valentin Gagarin	f7ab93b068	manual: build action -> build task after discussing this with multiple people, I'm convinced that "build task" is more precise: a derivation is not an action, but inert until it is built. also it's easier to pronounce. proposal: use "build task" for the generic concept "description of how to derive new files from the contents of existing files". then it will be easier to distinguish what we mean by "derivation" (a specific data structure and Nix language value type) and "store derivation" (a serialisation of a derivation into a file in the Nix store).	2022-11-06 13:28:18 +01:00
Sagar Patel	c068cce107	docs: drop shell prompt character for consistency In addition to consistency, the fancy "Copy to clipboard" button on the website will copy the prompt character. Retaining the prompt character would mean having to edit each command after pasting in the terminal.	2022-11-01 00:09:00 -04:00
John Ericson	13f2a6f38d	Merge branch 'master' into indexed-store-path-outputs	2022-10-28 23:22:18 +01:00
Théophane Hufschmitt	74cc24f4cf	Merge pull request #7191 from jherland/antiquoted-paths Explain how Nix handles antiquotation of paths	2022-10-26 12:42:59 +02:00
Guillaume Maudoux	2a7348f986	Fixup merge typo	2022-10-22 23:38:50 +02:00
Patrick Jackson	b44df13701	manual: update options generation code to use default values	2022-10-20 12:05:04 -07:00
Johan Herland	1ec8810687	Explain how Nix handles antiquotation of paths Specifically, explain why Nix does not _re_evaluate paths during a `nix repl` session. This is a thing that bit me while playing around with paths and antiquotation in `nix repl` while reading the Nix language tutorial at https://nix.dev/tutorials/nix-language. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>	2022-10-19 11:50:58 +02:00
Guillaume Maudoux	3f9f6ae127	Merge remote-tracking branch 'origin/master' into coerce-string	2022-10-16 20:39:19 +02:00
Ana Hobden	069409d167	Print common flags in --help	2022-10-07 09:07:22 -07:00
Valentin Gagarin	ac0fb38e8a	Merge pull request #6652 from abathur/doc_install_tests	2022-10-05 17:45:42 +02:00
Travis A. Everett	e1418430ac	Apply suggestions from code review Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>	2022-10-05 09:52:53 -05:00
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
Guillaume Maudoux	eb460a9529	WIP: broken merge but need a git checkpoint	2022-09-07 00:34:03 +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
Andrei Boar	50f5b6c733	Update doc/manual/src/command-ref/env-common.md Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>	2022-08-19 12:28:51 +03:00
Andrei Boar	82b867d0b5	cover empty string case	2022-08-19 11:51:32 +03: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
Andrei Boar	1c2c1a6e00	Update doc/manual/src/command-ref/env-common.md Co-authored-by: Jan Tojnar <jtojnar@gmail.com>	2022-08-04 16:17:24 +03:00
John Ericson	bc118854d0	Merge remote-tracking branch 'upstream/master' into doc-what-is-nix	2022-08-04 09:11:42 -04:00
Andrei Boar	a8ac6a4120	Update doc/manual/src/command-ref/env-common.md Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>	2022-08-04 16:01:02 +03:00
Andrei Boar	cedcfe861c	Merge branch 'manual-nix-path-empty' of github.com:zuzuleinen/nix into manual-nix-path-empty	2022-08-04 15:56:13 +03:00
Andrei Boar	f72545e864	update to suggested changes	2022-08-04 15:56:01 +03: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
Andrei Boar	6dfd8a78d9	Update doc/manual/src/command-ref/env-common.md Co-authored-by: Eelco Dolstra <edolstra@gmail.com>	2022-08-04 15:04:52 +03: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
Andrei Boar	5a75aa8595	manual: update docs when NIX_PATH is empty	2022-08-04 14:19:51 +03: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
Valentin Gagarin	445f753a82	replace pseudo code by diagrams change prose description to visually resemble the data structure	2022-08-04 12:37:47 +02:00
Valentin Gagarin	db8703bcac	use reference links for URLs	2022-08-04 12:37:47 +02:00
Valentin Gagarin	4adb6602bd	clarify first sentence on store objects	2022-08-04 12:37:47 +02:00
Valentin Gagarin	4eb11d4592	fix grammar for clarity	2022-08-04 12:37:47 +02:00
Valentin Gagarin	b84f2bdfdd	introduce mapping to Unix files and processes	2022-08-04 12:37:47 +02:00
Valentin Gagarin	207992a71d	introduce store and store objects without file system details this leaves open implementation details, especially about store paths and file system objects, and allows explaining them together were it is more appropriate. also leaves room to carefully introduce the key insight behind Nix: applying results from programming language theory to the operating system paradigm of files and processes.	2022-08-04 12:37:47 +02:00
Valentin Gagarin	e72a7874dc	beautify rosetta table while this may eventually introduce ugly diffs, the table will now render readably on the terminal (e.g. for `man nix` or `nix --help`) without further intervention.	2022-08-04 12:37:47 +02:00
Valentin Gagarin	b6b112b366	use reference links for URLs	2022-08-04 12:37:47 +02:00
Valentin Gagarin	d5eea66615	introduce build tasks while it appears a bit much for the overview, this way we set the stage for going directly into data types when describing the store, instead of first having to say what build tasks are and how they relate to build plans.	2022-08-04 12:37:47 +02:00
Valentin Gagarin	7c3bca1372	revert to build plans in top-level overview do not introduce build tasks yet, that is the next level of detail.	2022-08-04 12:37:47 +02:00
Valentin Gagarin	4639b36b53	use reference links for URLs	2022-08-04 12:37:47 +02:00
Valentin Gagarin	2303f84a68	revert to "build plan" in overview diagram this displays correct composition again. build inputs and build results are not part of build plans in terms of data objects. also this is a much less complicated setup. this will be the first impression of architecture, and we want to get it right.	2022-08-04 12:37:47 +02:00
Valentin Gagarin	25926c5fc6	Nix store does not underly literally everything Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>	2022-08-04 12:37:47 +02:00
Valentin Gagarin	0e63b9bf88	add link from overview to store section the overview should only link to the three main concepts presented. the store is now fairly fleshed out. others can follow later.	2022-08-04 12:37:47 +02:00
Valentin Gagarin	ef81276cc1	architecture overview: add link to command line reference	2022-08-04 12:37:47 +02:00
Valentin Gagarin	68d26010f6	architecture overview: add link to Nix expression language reference update summary title to match file contents	2022-08-04 12:37:47 +02:00
Valentin Gagarin	75ce324052	use singular for class names consistently	2022-08-04 12:37:47 +02:00
Valentin Gagarin	689b32a543	clarify relation of tasks and plans	2022-08-04 12:37:47 +02:00
Valentin Gagarin	2a8532fb61	build rule -> build task closer to "build systems a la carte", satisfies all other complaints	2022-08-04 12:37:47 +02:00
Valentin Gagarin	902638c519	build step -> build rule "step" sounds atomic, while "rule" hints at internal structure, which in our case consists of mapping inputs to outputs using build instructions.	2022-08-04 12:37:47 +02:00
Valentin Gagarin	87523f01e3	match grammatical case to arrow direction	2022-08-04 12:37:47 +02:00
Valentin Gagarin	d3effd014b	update architecture diagram	2022-08-04 12:37:47 +02:00
Valentin Gagarin	ad8c2ed7f0	remove incomplete section: input/content-addressing	2022-08-04 12:37:47 +02:00
Valentin Gagarin	3bd125ebbe	remove incomplete section: nix archives	2022-08-04 12:37:47 +02:00
Valentin Gagarin	b18852eb3f	remove incomplete section: content-addressed objects	2022-08-04 12:37:47 +02:00
Valentin Gagarin	7cec9ee361	remove incomplete section: relocatability	2022-08-04 12:37:47 +02:00
Valentin Gagarin	96876b1eae	remove incomplete section: related work	2022-08-04 12:37:47 +02:00
Valentin Gagarin	1ba6d8fb1d	remove incomplete section: building	2022-08-04 12:37:47 +02:00
John Ericson	3d8f2f5cc1	Fix manual TOC links	2022-08-04 12:37:47 +02:00
John Ericson	b01bb65d30	Fix rel path in doc	2022-08-04 12:37:47 +02:00
Valentin Gagarin	b5ca3d12b6	reword details on keeping closure property	2022-08-04 12:37:47 +02:00
Valentin Gagarin	e90586c0a4	add motivation for references	2022-08-04 12:37:47 +02:00
Valentin Gagarin	07d490fd89	stores can also delete objects	2022-08-04 12:37:47 +02:00
Valentin Gagarin	5fda995491	formalize file system objects convention: describe every data type in prose, and illustrate with a class diagram, and a textual representation of an abstract data type. right now we save ourselves the trouble of doing class diagrams, we can add them later. but they are important.	2022-08-04 12:37:47 +02:00
Valentin Gagarin	fb2ec7e4ec	reword section on references use file Contents instead of Data, as that flows more naturally in the prose. simplify explanation of the idea behind scanning for store paths remove references to unfinished sections.	2022-08-04 12:37:47 +02:00
Valentin Gagarin	90fc5b41a8	reword file system objects - use singular for the "class" - more consistency in type definition - minor fixes in wording	2022-08-04 12:37:47 +02:00
Valentin Gagarin	e5e48593c8	move git comparison to related work it should be pulled out of the branch before we go for merging	2022-08-04 12:37:47 +02:00
Valentin Gagarin	a145007a57	component -> store object, realisation -> build	2022-08-04 12:37:47 +02:00
Valentin Gagarin	40efe5b30b	build instrcution: Task -> function	2022-08-04 12:37:47 +02:00
Valentin Gagarin	ca5ebf6382	revert build plan/step distinction, reorder rows	2022-08-04 12:37:47 +02:00
Valentin Gagarin	610ddf44aa	reword introduction to rosetta stone, add links attempt to explain used and documented terminology, as well as how the declarative programming paradigm relates to building software. in the future one could highlight encouraged terms to shape future material into higher consistency.	2022-08-04 12:37:47 +02:00
Valentin Gagarin	5f96a0b4e8	associated operations are not collected Co-authored-by: John Ericson <git@JohnEricson.me>	2022-08-04 12:37:47 +02:00
Valentin Gagarin	070c85499b	fix grammar Co-authored-by: John Ericson <git@JohnEricson.me>	2022-08-04 12:37:47 +02:00
Valentin Gagarin	7b5c00f67f	add concrete store examples, reword note on file system	2022-08-04 12:37:47 +02:00
Valentin Gagarin	c8c1b705ad	reword section on Nix store	2022-08-04 12:37:47 +02:00
Valentin Gagarin	39f01176a7	design -> architecture, add motivation following ideas found in Architecture of Gazelle[1] [1]: `56d35f8db0/Design.rst`	2022-08-04 12:37:47 +02:00
Valentin Gagarin	d30033759a	address Nix language consistently as configuration language	2022-08-04 12:37:46 +02:00
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
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
K900	f675ba5331	doc/distributed-builds: don't use deprecated alias `nix ping-store` -> `nix store ping`.	2022-08-01 13:50:35 +03: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
Valentin Gagarin	85cdaebcd6	manual: set -> attribute set reword description to have shorter sentences.	2022-07-28 16:10:24 +02:00
Valentin Gagarin	be4654c344	manual: fix section title in table of contents	2022-07-28 15:55:41 +02:00
Théophane Hufschmitt	7ed91d6c6a	Merge branch 'master' into parallel-nix-copy	2022-07-20 10:05:34 +02:00
John Ericson	12461e246b	Leverage existing docs for new store-path^outputs syntax	2022-07-15 14:04:22 +00:00
John Ericson	279ecf7cde	Remove `computed-derivations` experimental feature We don't need it yet.	2022-07-15 13:42:17 +00:00
John Ericson	6cafe308c9	Merge remote-tracking branch 'upstream/master' into indexed-store-path-outputs	2022-07-14 16:15:37 -04:00
Eelco Dolstra	28e913c605	Branch 2.10 release notes	2022-07-11 21:10:23 +02:00
Eelco Dolstra	545383208e	Merge pull request #6777 from laalsaas/master Fix logical and typographical errors in nix-env man page	2022-07-11 13:52:40 +02:00
Eelco Dolstra	517ce38dad	Update release notes	2022-07-11 11:17:19 +02:00
laalsaas	eac211a171	Fix logical and typographical errors in nix-env man page	2022-07-10 12:30:17 +02:00
Théophane Hufschmitt	6fa95c35c7	Add a release notes entry for #4914 cc @gytis-ivaskevicius	2022-07-06 06:46:54 +02:00
Travis A. Everett	649c9d9b4c	doc: acknowledge post-rsync reality 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.	2022-06-30 13:31:04 -05:00
Travis A. Everett	fe76b9f4b4	doc: fix some darwin uninstall gaps	2022-06-16 09:37:52 -05:00
Tom Bereknyei	51268ceb79	Merge branch 'master' into nix-repl-flakes	2022-06-15 09:17:03 -04:00
tomberek	dae4a8a6c8	Apply suggestions from code review Co-authored-by: Théophane Hufschmitt <7226587+thufschmitt@users.noreply.github.com>	2022-06-15 09:02:36 -04:00
Hugo Osvaldo Barrera	fd7f795750	Add disambiguation to man page This should help future lost newcomers like myself understand where to find the docs for both of these commands and how they differ.	2022-06-14 18:13:35 +02:00
Travis A. Everett	edfcc8256e	doc: add install test info to hacking.md	2022-06-11 13:30:51 -05:00
Théophane Hufschmitt	34d90fbe22	Mention the parallel copy in the release notes	2022-06-08 15:25:52 +02:00
Tom Bereknyei	ffd41d1757	Merge branch 'master' into nix-repl-flakes	2022-06-02 16:58:35 -04:00
John Ericson	b585548dfe	Merge remote-tracking branch 'upstream/master' into indexed-store-path-outputs	2022-06-02 19:53:11 +00:00
Théophane Hufschmitt	a5f7b934bd	Merge branch 'master' into lto	2022-06-01 17:55:03 +02:00
Eelco Dolstra	04a699b8a9	Typo	2022-05-31 10:38:03 +02:00
Eelco Dolstra	de13b44573	Branch 2.9 release notes	2022-05-30 20:42:55 +02:00
Eelco Dolstra	8e8e9d8705	Respect the outputSpecified attribute E.g. 'nix build nixpkgs#libxml2.dev' will build the 'dev' output.	2022-05-30 11:34:47 +02:00
Eelco Dolstra	d67a2ae52d	Merge branch 'doc-redirects' of https://github.com/jtojnar/nix	2022-05-27 11:12:41 +02:00
Jan Tojnar	26d1877d6e	doc: Add redirects for the DocBook manual There are still many links to the old manual on the web and having them end up on the Introduction page is a bad user experience.	2022-05-26 18:17:21 +02:00
Jan Tojnar	a793863b97	doc: Manually insert some anchors	2022-05-26 18:17:21 +02:00
Jan Tojnar	7708a34a51	doc: Add anchors to long lists Added using the following sed scripts: - For command-ref/opt-common.md: s~- `(--?)([^`]+)`~- [`\1\2`]{#opt-\2}~g - For expressions/builtin-constants.md: s~- `(builtins\.?)([^`]+)`~- [`\1\2`]{#builtins-\2}~g - For expressions/advanced-attributes.md s~^ - `([^`]+)`~ - [`\1`]{#adv-attr-\1}~g and manually adjusted outputHashAlgo & outputHashMode. - For glossary.md s~^ - (`([^`]+)`\|(.+)) ?\\~ - [\1]{#gloss-\2\3}\\~g; s~(gloss-\w+) ~\1-~g and manually adjusted anchors for Nix expression, user environment, NAR, ∅ and ε. - For command-ref/env-common.md s~^ - `([^`]+)`~ - [`\1`]{#env-\1}~g'	2022-05-26 18:17:21 +02:00
Jan Tojnar	3272afa17b	doc: Port anchors preprocessor to jq script Python is only pulled into the build closure by Mercurial, which might end up being removed. Let’s port the script to jq, which is more likely to stay.	2022-05-26 18:17:21 +02:00
Jan Tojnar	4de84e095d	doc: Introduce pre-processor for adding anchors to text It is now possible to use the following syntax to insert anchors into the text: []{#anchor-name} The anchor will allow linking to the location it is placed by appending #anchor-name to the URL. Additionally, it is possible to create a link pointing to its own location by adding text between the square brackets: [`--add-root`]{#opt-add-root}	2022-05-26 17:54:15 +02:00
Eelco Dolstra	8f4548d401	Tweak IN_NIX_SHELL description	2022-05-26 12:40:01 +02:00
Ben Burdette	9a5ea6c359	Merge branch 'master' into debug-exploratory-PR	2022-05-25 10:41:10 -06:00
Ben Burdette	6031a36208	add --debugger to rl-next list	2022-05-25 10:38:13 -06:00
pennae	b092afe77d	Merge branch 'master' into lto	2022-05-25 11:55:13 +00:00
Tom Bereknyei	82c4af41e3	repl: clarify change and usage of <nixpkgs>	2022-05-20 01:49:49 -04:00
Tony Olagbaiye	5b8c1deb18	fetchTree: Allow fetching plain files Add a new `file` fetcher type, which will fetch a plain file over http(s), or from the local file. Because plain `http(s)://` or `file://` urls can already correspond to `tarball` inputs (if the path ends-up with a know archive extension), the URL parsing logic is a bit convuluted in that: - {http,https,file}:// urls will be interpreted as either a tarball or a file input, depending on the extensions of the path part (so `https://foo.com/bar` will be a `file` input and `https://foo.com/bar.tar.gz` as a `tarball` input) - `file+{something}://` urls will be interpreted as `file` urls (with the `file+` part removed) - `tarball+{something}://` urls will be interpreted as `tarball` urls (with the `tarball+` part removed) Fix #3785 Co-Authored-By: Tony Olagbaiye <me@fron.io>	2022-05-19 18:24:49 +02:00
Tom Bereknyei	1ca3f6035d	repl: update docs with installables	2022-05-18 21:21:38 -04:00
John Ericson	b18720ee17	Merge remote-tracking branch 'upstream/master' into indexed-store-path-outputs	2022-05-12 19:13:33 +00:00
Théophane Hufschmitt	65a913d29b	Don’t recommend writing unit tests As asked in <https://github.com/NixOS/nix/pull/6517#discussion_r869416905>	2022-05-12 12:02:31 +02:00
Théophane Hufschmitt	7c75f1d52b	Expand the testing section of the hacking docs - Make it clear what the different kind of tests are, where they live and how they can be ran - Ask people to primarily write unit tests	2022-05-10 13:35:23 +02:00
Eelco Dolstra	4a79cba511	Allow selecting derivation outputs using 'installable!outputs' E.g. 'nixpkgs#glibc^dev,static' or 'nixpkgs#glibc^*'.	2022-05-03 13:43:52 +02:00
Guillaume Maudoux	9ff892aad4	Add release notes for error traces revamp	2022-04-29 11:24:48 +02:00
pennae	d6d6bbd9ef	Merge branch 'master' into lto	2022-04-25 14:02:37 +00:00
midchildan	c67d8876c3	feat: add integration with zsh's run-help	2022-04-25 02:21:41 +09:00
Théophane Hufschmitt	be28603dca	Merge remote-tracking branch 'origin/master' into nixbuildaddprintstorepaths	2022-04-22 11:11:01 +02:00
Tom Bereknyei	f25112d383	fix: builtins.toFile adds path to allowedPaths The produced path is then allowed be imported or utilized elsewhere: ``` assert (43 == import (builtins.toFile "source" "43")); "good" ``` This will still fail on write-only stores.	2022-04-21 16:41:37 -04:00
Artturin	51cfea8bb0	nix build: add --print-out-paths flag has the same functionality as default nix-build $ nix-build . -A "bash" -A "bash.dev" -A "tinycc" /nix/store/4nmqxajzaf60yjribkgvj5j54x9yvr1r-bash-5.1-p12 /nix/store/c49i1ggnr5cc8gxmk9xm0cn961z104dn-bash-5.1-p12-dev /nix/store/dbapb08862ajgaax3621fz8hly9fdah3-tcc-0.9.27+date=2022-01-11 $ nix-build . -A "bash" /nix/store/4nmqxajzaf60yjribkgvj5j54x9yvr1r-bash-5.1-p12 $ $HOME/nixgits/nix/result/bin/nix build "nixpkgs#bash" "nixpkgs#bash.dev" "nixpkgs#tinycc" --print-out-paths /nix/store/4nmqxajzaf60yjribkgvj5j54x9yvr1r-bash-5.1-p12 /nix/store/c49i1ggnr5cc8gxmk9xm0cn961z104dn-bash-5.1-p12-dev /nix/store/dbapb08862ajgaax3621fz8hly9fdah3-tcc-0.9.27+date=2022-01-11 $ $HOME/nixgits/nix/result/bin/nix build "nixpkgs#bash" --print-out-paths /nix/store/4nmqxajzaf60yjribkgvj5j54x9yvr1r-bash-5.1-p12	2022-04-20 19:35:46 +03:00
ckie	0e2b01b14e	nix repl: make symlinks with the :bl command Requested by ppepino on the Matrix: https://matrix.to/#/!KqkRjyTEzAGRiZFBYT:nixos.org/$Tb32BS3rVE2BSULAX4sPm0h6CDewX2hClOTGzTC7gwM?via=nixos.org&via=matrix.org&via=nixos.dev This adds a new command, :bl, which works like :b but also creates a GC root symlink to the various derivation outputs. ckie@cookiemonster ~/git/nix -> ./outputs/out/bin/nix repl Welcome to Nix 2.6.0. Type :? for help. nix-repl> :l <nixpkgs> Added 16118 variables. nix-repl> :b runCommand "hello" {} "echo hi > $out" This derivation produced the following outputs: ./repl-result-out -> /nix/store/kidqq2acdpi05c4a9mlbg2baikmzik44-hello [1 built, 0.0 MiB DL] ckie@cookiemonster ~/git/nix -> cat ./repl-result-out hi	2022-04-20 00:20:29 +03:00
John Ericson	6b61d7722d	Merge remote-tracking branch 'upstream/master' into indexed-store-path-outputs	2022-04-19 20:30:12 +00:00
Eelco Dolstra	1cdad1074c	Move rl-next.md to rl-2.8.md	2022-04-19 21:12:33 +02:00
John Ericson	41e755bee4	Merge remote-tracking branch 'upstream/master' into indexed-store-path-outputs	2022-04-19 15:14:06 +00:00
Tom Bereknyei	9b41239d8f	fix: ensure apps are apps and packages are packages	2022-04-14 23:57:52 -04:00
John Ericson	fda2224b59	Add release notes mark experimental	2022-04-07 19:45:38 +00:00
Rehno Lindeque	5ff4c42608	Update release notes	2022-04-06 12:24:35 -04:00
Eelco Dolstra	71c07ac0e7	Merge pull request #6363 from thufschmitt/definition-list-in-nix.conf-manual Add anchors to the nix.conf options in the manual	2022-04-05 17:32:48 +02:00
Eelco Dolstra	f98d76ff1a	rl-2.7.md: Fix title	2022-04-05 14:13:26 +02:00
Théophane Hufschmitt	660c19eb49	manual: Add some anchor targets for the nix.conf options For each `nix.conf` option, add an empty html node with a unique `id` that can be used as an anchor target. Also make the name of the option be a link to that target so that it’s easily discoverable. We can’t rewrite the whole list as an html definition list like it’s done for the builtins because these options also appear in a man page, and the manpage renderer (lowdown) can’t render arbitrary html. But the hack here allows to keep the manpage and have the links in the html version. Fix https://github.com/NixOS/nix/issues/5745	2022-04-05 13:50:42 +02:00
Eelco Dolstra	d63a5f5dd3	Update release notes	2022-03-31 17:33:06 +02:00
Eelco Dolstra	86b05ccd54	Only provide builtin.{getFlake,fetchClosure} is the corresponding experimental feature is enabled This allows writing fallback code like if builtins ? fetchClosure then builtins.fetchClose { ... } else builtins.storePath ...	2022-03-25 14:04:18 +01:00
Eelco Dolstra	98658ae9d2	Document fetchClosure	2022-03-24 21:33:33 +01:00
Eelco Dolstra	5acaf13d35	Rename 'nix store make-content-addressable' to 'nix store make-content-addressed'	2022-03-24 21:33:33 +01:00
Domen Kožar	98ce1a21b7	Merge pull request #6144 from toonn/doc-macos-uninstall doc: Add detailed uninstall section for macOS	2022-03-23 08:53:48 +01:00
Théophane Hufschmitt	7117053457	Merge pull request #6270 from Artturin/stdineval nix: allow using --file - to read from stdin	2022-03-17 14:35:01 +01:00
Artturin	a5c969db49	nix: allow using --file - to read from stdin	2022-03-16 21:01:51 +02:00
Joachim Breitner	af013281c9	distributed-builds.md: fixing typo of the most minor sort	2022-03-16 12:53:38 +01:00
pennae	f2603e9c92	Merge branch 'master' into lto	2022-03-10 00:32:34 +00:00
Eelco Dolstra	ad7c99ef20	Move rl-next.md to rl-2.7.md	2022-03-07 20:10:18 +01:00
Eelco Dolstra	0123b9aec8	Tweak release notes	2022-03-07 19:56:10 +01:00
Eelco Dolstra	30ddd37873	Merge branch 'cli-suggestions' of https://github.com/thufschmitt/nix	2022-03-07 19:47:45 +01:00
Eelco Dolstra	c28e2b1b29	Tweak release notes	2022-03-07 11:30:40 +01:00
regnat	b44cebd1fd	Add a release-notes entry for the cli suggestions	2022-03-07 10:09:10 +01:00
pennae	2799fe4cdb	enable LTO in optimized builds gives 2-5% performance improvement across a board of tests. LTO is broken when using clang; some libs link fine while others crash the linker with a segfault in the llvm linker plugin. 🙁	2022-03-03 17:47:49 +01:00
toonn	947d4761b3	doc: Add removal of darwin-store LaunchDaemon The uninstall instructions used to accidentally remove the nix-darwin LaunchDaemon, this was dropped. However, the original intent was to remove the Store volume mounting LaunchDaemon.	2022-02-26 14:16:35 +01:00
toonn	2df23e2b3e	doc: Drop nix-darwin service from macOS uninstall	2022-02-25 10:50:01 +01:00
toonn	064cad7e9f	doc: Add macOS uninstall note about /nix Clarify that `/nix` being present after the uninstall is normal and it will only disappear after a reboot. Co-authored-by: Travis A. Everett <travis.a.everett@gmail.com>	2022-02-25 10:32:45 +01:00
Eelco Dolstra	59683733f5	Merge pull request #6089 from edolstra/dot-default Replace defaultBla.$system with bla.$system.default	2022-02-24 21:16:58 +01:00
Guillaume Desforges	cfbf9ee2ce	Anchor with prefix	2022-02-24 13:50:50 +01:00
Guillaume Desforges	6462ee61c7	Anchor link for builtin functions in HTML doc	2022-02-23 15:07:01 +01:00
Guillaume Desforges	2cc645a91a	Add html make target	2022-02-23 15:06:13 +01:00
Théophane Hufschmitt	54f07b66c8	Precise the doc for `--include-outputs` Make it explicit that it only includes the existing outputs and not the ones that haven’t been realised	2022-02-23 09:17:08 +01:00
toonn	400d70a3a9	doc: Add detailed uninstall section for macOS The multi-user installation on macOS, which is now the only option, has gotten complicated enough that it discourages some users from checking Nix out for fear of being left with a "dirty" system. Detailed uninstallation instructions should make this less of an issue.	2022-02-22 16:28:24 +01:00
Eelco Dolstra	38eea2c503	Update release notes	2022-02-22 14:23:39 +01:00
Eelco Dolstra	26e99c817c	Merge pull request #6114 from Radvendii/welcomeText add release notes for welcomeText	2022-02-18 10:52:03 +01:00
Taeer Bar-Yam	219fa2e43d	add release notes for welcomeText	2022-02-17 15:17:20 -05:00
Rahul Butani	d82cf4a016	manual: fix formatting for options with "machine-specific" defaults	2022-02-15 15:44:05 -06:00
tomberek	2bf96bd9f2	Merge branch 'master' into bundler_drv	2022-01-28 10:18:29 -05:00
Eelco Dolstra	35dbdbedd4	nix store ping: Report Nix daemon version Fixes #5952.	2022-01-25 21:15:58 +01:00
Tom Bereknyei	dc85e20684	bundler: notes and doc update to include bundlers repo	2022-01-25 03:48:44 -05:00
Eelco Dolstra	9faad4c5eb	Move rl-next.md to rl-2.5.md	2022-01-25 00:11:00 +01:00
Eelco Dolstra	edf0cde1a7	Merge pull request #5960 from zombiezen/patch-1 Correct `NIX_BUILD_PATH` default description	2022-01-24 12:46:43 +01:00
Eelco Dolstra	3782017272	Tweak release notes	2022-01-24 12:45:35 +01:00
Ross Light	7477974b93	Correct NIX_BUILD_PATH default description Source: `067076287b/src/nix-build/nix-build.cc (L362-L381)`	2022-01-21 18:45:19 -08:00
Rok Garbas	d463e11760	Adding docs regarding the docker image from master	2022-01-21 14:50:34 +01:00
lincoln auster [they/them]	7d4f86f032	release-notes: document commit-lockfile-summary option This documents 3023c7700.	2022-01-18 16:10:44 -07:00
Eelco Dolstra	4dda1f92aa	Add command 'nix store copy-log' Fixes #5222.	2022-01-18 14:08:49 +01:00
Théophane Hufschmitt	dc4730ee94	Merge pull request #5720 from tomberek/flake_search flakes: search up to git or filesystem boundary	2022-01-18 10:59:12 +01:00
tomberek	2dead20924	Apply suggestions from code review Co-authored-by: Théophane Hufschmitt <7226587+thufschmitt@users.noreply.github.com>	2022-01-14 09:16:34 -05:00
Eelco Dolstra	5e9653c370	Tweak	2022-01-13 14:33:41 +01:00
Eelco Dolstra	66424cd29f	Merge branch 'patch-1' of https://github.com/TheodorRene/nix	2022-01-13 14:31:49 +01:00
Profpatsch	a51c457204	Release Notes 2.4: add `--indirect` no-op change Since `00d25e8457` which was first included in nix 2.4. It is a backwards-compatible change since the flag will just be ignored.	2022-01-12 23:19:15 +01:00
Theodor René Carlsen	89b4df8d92	Add link to explanation when introducing a new operator The logical implication operator is included in this section but never explained. It might stump new readers with a pretty uncommon operator, and it's never referenced explicitly.	2022-01-11 17:01:43 +01:00
pennae	00c993f48b	add zipAttrsWith primop nixpkgs can save a good bit of eval memory with this primop. zipAttrsWith is used quite a bit around nixpkgs (eg in the form of recursiveUpdate), but the most costly application for this primop is in the module system. it improves the implementation of zipAttrsWith from nixpkgs by not checking an attribute multiple times if it occurs more than once in the input list, allocates less values and set elements, and just avoids many a temporary object in general. nixpkgs has a more generic version of this operation, zipAttrsWithNames, but this version is only used once so isn't suitable for being the base of a new primop. if it were to be used more we should add a second primop instead.	2022-01-03 21:05:53 +01:00
Alexander Bantyev	a26351da02	Add ability to toggle show-trace from within the repl	2021-12-29 02:54:36 +03:00
tomberek	f404189368	Merge branch 'master' into flake_search	2021-12-23 15:22:52 -05:00
Eelco Dolstra	881b610266	Update release notes	2021-12-21 14:19:21 +01:00
Eelco Dolstra	c260640dec	Fix docker instructions	2021-12-16 21:48:38 +01:00
jesse	11ee875a6d	List aarch64 as supported macOS hardware Resolves #5767	2021-12-15 10:55:34 -08:00
Théophane Hufschmitt	6234e1c811	Merge pull request #5702 from baloo/baloo/hide-non-reproducible-settings reproducibility: hide non-reproducible settings from manual	2021-12-14 09:14:25 +01:00
Eelco Dolstra	18cb094aab	rl-2.5.md: Set date	2021-12-13 19:57:06 +01:00
Eelco Dolstra	f133001dc8	Move rl-next.md to rl-2.5.md	2021-12-13 16:48:44 +01:00
Eelco Dolstra	3f417c8d1c	Add release notes entry for #5149	2021-12-13 16:43:42 +01:00
Janne Heß	4194b68250	doc: Fix command for distributed builds We also need to build impurely or the <nixpkgs> lookup will not work.	2021-12-10 12:58:12 +01:00
Amon Stopinšek	0bd93ed747	Fix link to nixos channel The old link returned 404 errror.	2021-12-09 16:44:24 +00:00
Eelco Dolstra	167e864697	Merge pull request #5730 from abathur/darwin_document_fstab_settings document some darwin mount settings	2021-12-07 22:24:40 +01:00
Alexander Bantyev	33926ed1e7	nix repl: add :log Add a :log command that shows logs for a derivation. Closes https://github.com/NixOS/nix/issues/3504 Co-authored-by: Taeer Bar-Yam <taeer@bar-yam.me>	2021-12-06 16:52:50 +03:00
Travis A. Everett	8093456111	document some darwin mount settings	2021-12-04 23:16:42 -06:00
Tom Bereknyei	b6cc0a704d	flakes: search up to git or filesystem boundary While parsing a flakeref, upon not finding a flake.nix, search upwards until git or filesystem boundary.	2021-12-03 10:55:30 -05:00
Eelco Dolstra	2e606e87c4	Merge pull request #5715 from Infinisil/groupBy-primop Introduce `builtins.groupBy` primop	2021-12-03 13:21:14 +01:00
David Purdum	69b9198875	Fix docker command `docker -ti run nixos` does not run on docker version 20.10.7 (my machine). This fixes it to read `docker run -ti nixos`.	2021-12-02 23:38:33 -05:00
Silvan Mosberger	90700736c7	Introduce builtins.groupBy primop This function is very useful in nixpkgs, but its implementation in Nix itself is rather slow due to it requiring a lot of attribute set and list appends.	2021-12-02 21:54:51 +01:00
Arthur Gautier	21520297da	reproducibility: hide non-reproducible settings from manual Because the manual is generated from default values which are themselves generated from various sources (cpuid, bios settings (kvm), number of cores). This commit hides non-reproducible settings from the manual output.	2021-12-01 17:25:58 +01:00
Eli Flanagan	092c375cda	Update doc/manual/src/glossary.md Co-authored-by: Eelco Dolstra <edolstra@gmail.com>	2021-11-30 13:19:42 -05:00
Eli Flanagan	a473e85c80	docs: document set theory symbols These symbols confused me so I wanted to gloss them to help future users. You can see the context here: https://discourse.nixos.org/t/flakes-what-does-mean-big-bundle-of-questions	2021-11-30 11:13:46 -05:00
Eelco Dolstra	b96164f4af	Merge remote-tracking branch 'origin/build-with-clang'	2021-11-30 11:50:56 +01:00
Eelco Dolstra	ddf4fb750d	Merge pull request #5678 from t184256/document-libsodium Document libsodium, which is now mandatory, as a dependency.	2021-11-29 11:11:10 +01:00
Eelco Dolstra	99804465af	Merge pull request #5679 from t184256/optional-libcpuid Document libcpuid dependency and make it optional	2021-11-29 11:10:42 +01:00
Alexander Sosedkin	a9bd06d0ea	Make libcpuid dependency optional with --disable-cpuid	2021-11-28 00:52:35 +01:00
Alexander Sosedkin	b73a1c0638	Document libcpuid dependency	2021-11-28 00:52:35 +01:00
Alexander Sosedkin	33a227503a	Document libsodium, which is now mandatory, as a dependency	2021-11-27 23:11:11 +01:00
Tom Bereknyei	152e3cda0c	reproducibility: determinstic man page output for cores	2021-11-26 10:55:43 -05:00
Pamplemousse	288c252570	Documentation: alternative `stdenv` for hacking Signed-off-by: Pamplemousse <xav.maso@gmail.com>	2021-11-26 10:04:56 +01:00
Eelco Dolstra	986906e687	Update names	2021-11-25 17:09:11 +01:00
Silvan Mosberger	09471d2680	Make lists be comparable Makes lists comparable using lexicographic comparison. Increments builtins.langVersion in order for this change to be detectable	2021-11-24 13:40:46 +01:00
Lorenz Leutgeb	e1192116d3	doc: Fix escape for operator "logical or" See https://matrix.to/#/!KqkRjyTEzAGRiZFBYT:nixos.org/$hhMb6AdRIXfRkv_LsNsiQJuch7AQ_b6szr4tfawFy-4	2021-11-18 15:08:01 +01:00
Eelco Dolstra	e88fb63e28	Merge pull request #5585 from jtojnar/env-a doc: De-emphasize nix-env without -A	2021-11-18 14:34:45 +01:00
Jan Tojnar	ca4d8ce9e2	doc: De-emphasize nix-env without -A The manual uses `nix-env -i` without `-A` prominently, teaching a bad practice to newcomers.	2021-11-17 17:04:25 +01:00
Jan Tojnar	e96faadcd6	Fix XDG_CONFIG_DIRS fallback According to XDG Base Directory Specification, it should fall back to /etc/xdg when the env var is not present.	2021-11-17 14:31:15 +01:00
Eelco Dolstra	51ffc19f02	Merge branch 'add-docker-image-to-hydra-jobs' of https://github.com/garbas/nix	2021-11-16 13:00:54 +01:00
Kevin Amado	eae54f2d52	fix many doc typos	2021-11-13 22:28:20 -05:00
Rok Garbas	a118a70649	Documenting how to use/build Nix' Docker image	2021-11-11 16:07:01 +01:00
Théo Zimmermann	d589782fb0	Fix some typos in CLI guideline.	2021-11-08 08:24:15 +01:00
Jan Tojnar	e5d4c2235f	docs: Correct fallback user config path This is in line with XDG Base Directory Specification, where ~/.config is supposed to be used when XDG_CONFIG_HOME is unset. It also better matches the reality, where ~/.config/nix.conf does not seem to be used.	2021-11-04 11:41:29 +01:00
Dimitris Apostolou	c34cc5e488	Fix typos	2021-11-03 18:11:20 +02:00
Simon Legner	1968760f4a	command-ref/nix-shell: fix --pure, --keep	2021-11-02 22:00:08 +01:00
Eelco Dolstra	b61b307bad	Remove references to building from the source tarball	2021-11-02 15:29:47 +01:00
Eelco Dolstra	6a93e186f4	Fix 2.4 migration examples	2021-11-01 22:44:07 +01:00
Eelco Dolstra	bc4b7521f4	Rename rl-2.5.md to rl-next.md Having a generically named file for release notes for the next release makes things easier for PRs.	2021-10-28 14:36:47 +02:00
Eelco Dolstra	9c6ac9eb0e	2.4 release notes: Add some migration notes	2021-10-27 17:33:32 +02:00
Domen Kožar	51c812d6bb	Merge pull request #5365 from arafangion/master Clarify that not all nix packages will use the default build phases	2021-10-17 20:54:00 -05:00
John Chapman	ffeec5f283	Clarify that not all nix packages will use the default build phases	2021-10-17 15:24:22 +11:00
Eelco Dolstra	4c0cde95ad	Update release notes	2021-10-13 11:39:54 +02:00
Eelco Dolstra	2f3c79c241	Mention compression-level in the release notes	2021-10-13 11:11:26 +02:00
John Chapman	4cff413054	Clarify that not all nix packages will use the default build phases	2021-10-09 12:03:34 +11:00
Eelco Dolstra	844dd901a7	Start 2.5 release notes	2021-10-07 20:09:03 +02:00
Eelco Dolstra	f45b30de2f	Revert "docs: add troubleshooting session in remote builds" This reverts commit `0574c1850a`.	2021-10-06 17:12:52 +02:00
Domen Kožar	d0cc6a192a	Merge pull request #5095 from happysalada/update_remote_builds_docs docs: add troubleshooting session in remote builds	2021-10-06 08:10:53 -05:00
happysalada	0574c1850a	docs: add troubleshooting session in remote builds	2021-10-06 21:47:53 +09:00
Eelco Dolstra	08aa7daee0	Remove links to .md files in help output Fixes #5337.	2021-10-06 13:01:18 +02:00
Rafal Gwozdzinski	a73f855bd4	Fix typo	2021-10-03 12:19:59 +02:00
Eelco Dolstra	0e3b8ca767	Typo	2021-10-01 16:32:07 +02:00
Eelco Dolstra	43221bb319	Comments	2021-10-01 16:29:53 +02:00
Eelco Dolstra	91b39eee25	Typo Co-authored-by: Sebastian Ullrich <sebasti@nullri.ch>	2021-10-01 14:18:07 +02:00
Eelco Dolstra	5e222ac18b	Release notes	2021-09-30 17:36:09 +02:00
Eelco Dolstra	8fdb1d057a	Quiet	2021-09-22 14:12:31 +02:00
Eelco Dolstra	49a932fb18	nix --help: Display help using lowdown instead of man Fixes #4476. Fixes #5231.	2021-09-13 14:45:21 +02:00
Eelco Dolstra	25b6b74175	Manual: Link to 2.4 release notes	2021-09-09 15:01:36 +02:00
Eelco Dolstra	ff03fb6743	Manual: Depend on all *.md files	2021-09-09 15:01:19 +02:00
Eelco Dolstra	7ee639f9db	Merge pull request #5066 from Radvendii/master add antiquotations to paths	2021-09-01 12:55:04 +02:00
Taeer Bar-Yam	b2beb97f2a	add documentation for path antiquotations	2021-08-31 08:17:17 -04:00
Sergei Trofimovich	33fa5f3cd9	doc/manual/local.mk: fix 'make install DESTDIR=...' Install failure is observed when we try to install into inplace location as non-root: ``` $ LANG=C make install DESTDIR=$PWD/__i__ V=1 RUST_LOG=warn mdbook build doc/manual -d /usr/share/doc/nix/manual 2021-08-28 13:29:58 [ERROR] (mdbook::utils): Error: Rendering failed 2021-08-28 13:29:58 [ERROR] (mdbook::utils): Caused By: Unexpected error when constructing destination path 2021-08-28 13:29:58 [ERROR] (mdbook::utils): Caused By: Permission denied (os error 13) make: *** [doc/manual/local.mk:98: /usr/share/doc/nix/manual/index.html] Error 101 ``` The change is to prefix paths with `$(DESTDIR)`.	2021-08-28 13:31:34 +01:00
Pamplemousse	0e7bd65976	`15f4d4f` Documentation follow-up	2021-08-19 09:40:47 -07:00
Eelco Dolstra	d64f9671fc	Merge pull request #5094 from Pamplemousse/simpler_doc doc/manual: don't need to copy `highlight.js` manually	2021-08-05 15:13:07 +02:00
Pamplemousse	de39cfb9f3	doc/manual: don't need to copy `highlight.js` manually Signed-off-by: Pamplemousse <xav.maso@gmail.com>	2021-08-04 19:47:05 -07:00
regnat	441be5d59a	Remove dead code in doc’s local.mk	2021-07-27 14:37:55 +02:00
regnat	cd6e9eb024	Fix the generation of nix3 manpages - Separate the generation of the manpages from their installation - Make sure that `make` generates the manpages - Make sure that `make install` installs them Fix #5051	2021-07-27 13:47:53 +02:00
regnat	c5f5d615a6	Cleanup the generation of the nix3 manpages Use a dedicated make target for the man page rather than bundling the generation as part of `install`. Also make sure that `make install` is a fixpoint by - Removing the generated markdown files from `MANUAL_SRCS` - Not having the manpage generation write in its source directory so as to not update its timestamp (it would run each time otherwise)	2021-07-19 16:55:56 +02:00
Eelco Dolstra	f1ecd30bd5	Merge pull request #4773 from alyssais/dl doc: builtins: use a definition list	2021-07-05 14:03:15 +02:00
Keshav Kini	f35f9af787	Improve explanation of NIX_PATH prefix syntax The previous wording seemed to imply that the "channel:" syntax would resolve to a github archive URL, which is not the case.	2021-06-03 17:59:39 -07:00
Linus Heckemann	a3553cdae8	doc/nix-shell: Remove outdated bashrc information This behaviour was removed in `65f6d5db6f`.	2021-05-11 14:33:35 +02:00
Alyssa Ross	5f07f2ff2b	doc: builtins: use a definition list This looks a lot better (and is also more semantically meaningful). Since this list is generated in a Nix expression, I don't think using HTML here is going to be the thing that puts people off modifying this part of the documentation!	2021-05-05 14:34:46 +00:00
Graham Christensen	d15a1962cb	Merge pull request #4289 from abathur/encrypt_darwin_volume darwin: encrypt nix volume if filevault is enabled	2021-04-29 15:59:12 -04:00
Travis A. Everett	eab14a642c	darwin: encrypt nix volume if filevault is enabled	2021-04-29 13:26:51 -05:00
Eelco Dolstra	fe2bf464cf	Merge branch 'remove-trailing-spaces' of github.com:NixOS/nix	2021-04-23 15:09:44 +02:00
regnat	31313d1401	Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).	2021-04-23 14:37:21 +02:00
Eelco Dolstra	3996ca42cf	Merge pull request #4735 from NixOS/document-ca-derivations (briefly) document how to build ca derivations	2021-04-23 14:21:25 +02:00
Eelco Dolstra	e65f604ea9	Set more man sections	2021-04-23 14:20:28 +02:00
Alyssa Ross	29132f99c5	doc: fix section in nix3 man page metadata These man pages said they were in section 7, even though we were installing them to section 1 (which is the right place for them).	2021-04-23 10:52:54 +00:00
regnat	2207018df5	(briefly) document how to build ca derivations	2021-04-23 10:28:26 +02:00
Björn Gohla	4d9568ef60	Revert "[prerequisites]: add JSON lib dependency" This reverts commit `5926200db0`.	2021-04-05 21:29:04 +01:00
Björn Gohla	5926200db0	[prerequisites]: add JSON lib dependency	2021-04-01 22:54:09 +01:00
Eelco Dolstra	4638bcfb2c	Fix some typos Fixes #4671.	2021-03-26 16:14:38 +01:00
Travis A. Everett	ac8ba2eae4	remove doc for obsolete --no-build-hook flag `--no-build-hook` appears to have been removed in `25f32625e2`	2021-03-06 19:51:29 -06:00
Graham Christensen	1130b28824	distributed builds: load remote builder host key from the machines file This is already used by Hydra, and is very useful when materializing a remote builder list from service discovery. This allows the service discovery tool to only sync one file instead of two.	2021-02-25 09:17:34 -05:00
Shea Levy	f6c5b05488	Respect command registrations in plugins.	2021-02-24 08:25:45 -05:00
Shea Levy	98d1b64400	Initialize plugins after handling initial command line flags This is technically a breaking change, since attempting to set plugin files after the first non-flag argument will now throw an error. This is acceptable given the relative lack of stability in a plugin interface and the need to tie the knot somewhere once plugins can actually define new subcommands.	2021-02-24 08:22:17 -05:00
Eelco Dolstra	6042febfce	Restore warning about 'nix' being experimental Fixes #4552.	2021-02-17 15:30:49 +01:00
Mauricio Scheffer	5f4701e70d	Update doc/manual/src/command-ref/nix-shell.md Co-authored-by: Cole Helbling <cole.e.helbling@outlook.com>	2021-02-16 23:27:04 +00:00
Mauricio Scheffer	35129884f9	Fix Haskell example http://nixos.org redirects to https://nixos.org and apparently the HTTP library doesn't follow the redirect, so the output is empty. When defining https in the request it crashes because the library doesn't seem to support https. So this switches the example to a different http library.	2021-02-16 23:19:42 +00:00
Dominik Schrempf	fb00e7dc52	Remove newline in operator table.	2021-02-01 17:42:14 +01:00
Eelco Dolstra	36c4d6f592	Group common options	2021-01-25 19:03:13 +01:00
Eelco Dolstra	807d963ee8	Group subcommands by category	2021-01-25 18:19:32 +01:00
Eelco Dolstra	d33eca8539	Rename 'nix store sign-paths' to 'nix store sign'	2021-01-13 23:32:37 +01:00
Eelco Dolstra	77c9ceda4b	Tweak	2021-01-11 19:42:24 +01:00
Sam Lidder	e069ddf325	Fix `configure` error in introduction doc	2020-12-31 20:17:37 -05:00
Sevan Janiyan	9d3aad7b92	Update URL where bzip2 can be obtained	2020-12-25 01:43:22 +00:00
Eelco Dolstra	1047cb1e53	Command: Remove examples()	2020-12-23 18:26:40 +01:00
Eelco Dolstra	9dcd0aebc5	generate-manpage.nix: Fix short names	2020-12-21 13:32:27 +01:00
Rok Garbas	7de4b1e9aa	smaller fixes	2020-12-17 23:42:49 +01:00
Rok Garbas	ae77f21474	Switch away from classification as Tier1-3 to classification to a more descriptive classification.	2020-12-08 11:59:23 +01:00
Rok Garbas	0d7714b0d7	forgot to add the files	2020-12-08 10:25:03 +01:00
Rok Garbas	24db5b125f	Merge remote-tracking branch 'origin/master' into cli-guideline	2020-12-07 15:13:36 +01:00
regnat	5f66edf245	Make `make install` less noisy Remove the printing and useless output of a couple of commands when running `make install`	2020-12-04 14:50:47 +01:00
Eelco Dolstra	8ad2c9c4b9	Remove 'dist' target We're not producing source tarballs anymore so this has been bitrotting.	2020-12-03 16:17:58 +01:00
Eelco Dolstra	c3c858ac6d	Make doc() return arbitrary Markdown rather than the contents of the "Description" section Thus we can return the examples section (and any other sections) from doc() and don't need examples() anymore.	2020-12-03 16:17:58 +01:00
Eelco Dolstra	e2efc63979	Put examples first in the manpages	2020-12-02 23:23:23 +01:00
Eelco Dolstra	72428e38d9	Generate separate manpages for each nix subcommand	2020-12-02 23:23:23 +01:00
Rok Garbas	44da19f73c	Adds Nix CLI Guideline to docs As we are working towards Nix 3.0 we want to make sure that we make a huge step forward in Nix's user experience. And once 3.0 is out of the door we need to make sure that all future commands and features keep up the standard of user experience. This PR adds a CLI guideline document to the Nix documentation. Consider this document a good starting point and a checklist when somebody will be (re)implementing commands. Clearly this guideline does nothing to improve user experience on its own and can only be useful as long as it is going to be read and cared for. But it is a first step into that direction.	2020-12-02 17:00:32 +01:00
Fabian Möller	5b0790355f	Fix macOS sandbox build Since `c4c3c15c19` (#4251) building Nix for macOS with sandboxing fails: ``` getting status of /nix/var/nix/profiles/per-user/root/channels/nixpkgs: Operation not permitted ``` This happens, because `EvalSettings::getDefaultNixPath` tries to access paths outside the sandbox. Since the state-dir is not required for doc generation, it is set to the dummy folder. This needs to be done for all nix invocations during doc generation, as `EvalSettings::getDefaultNixPath` is called unconditionally.	2020-11-23 17:40:17 +01:00
mkenigs	8b15650e74	docs: consistent console prompt (#4213 ) Everywhere else a $ is used	2020-11-02 16:32:05 +01:00
Eelco Dolstra	a3a22bd804	Merge pull request #4202 from hercules-ci/nix-shell-doc Nix shell doc	2020-10-30 11:36:24 +01:00
Robert Hensing	d4c5d8d32a	nix-shell.md: Extend shellHook example	2020-10-30 11:12:28 +01:00
Robert Hensing	b809c48ebb	nix-shell.md: evaluated -> run Use "run" to avoid confusion with Nix evaluation. "evaluated" was intended to reference bash eval but it's ambiguous.	2020-10-30 11:01:33 +01:00
Eelco Dolstra	ff4dea63c9	Generalize extra-* settings This removes the extra-substituters and extra-sandbox-paths settings and instead makes every array setting extensible by setting "extra-<name> = <value>" in the configuration file or passing "--<name> <value>" on the command line.	2020-10-29 18:17:39 +01:00
tnias	c189cf7e33	Add sha512 to hashAlgo listings in manpages (#4186 )	2020-10-25 22:16:53 +00:00
Josef Kemetmüller	7f60f48e1a	Fix the docs about the new NIX_CONFIG env var This was accidentally documented as NIX_OPTIONS.	2020-10-21 17:04:36 +02:00
Eelco Dolstra	ecfebde6ff	Merge pull request #4166 from kampka/nix-conf-env Add NIX_CONFIG env var for applying nix.conf overrides	2020-10-21 14:26:45 +02:00
Eelco Dolstra	bdf2bcc989	Remove conf-file.xml This was probably revived in a bad merge.	2020-10-21 14:24:26 +02:00
Christian Kampka	461cf2b856	Add NIX_CONFIG env var for applying nix.conf overrides	2020-10-21 13:41:26 +02:00
Stefan Frijters	a53438d18f	doc: nix-shell in pure mode does not source user bashrc	2020-10-18 14:26:05 +02:00
Eelco Dolstra	58dadf2954	Remove stray 'Title:' from the manual Closes #4096.	2020-10-08 17:30:40 +02:00
Fabian Möller	4abd5554ad	Fix macOS sandbox build	2020-10-02 15:40:55 +02:00
Kevin Quick	66c3959e8c	Merge branch 'master' into access-tokens	2020-09-29 08:32:06 -07:00
Maximilian Bosch	3655875483	doc/manual: update hacking docs (#4078 ) * By default, build artifacts should be installed into `outputs/` rather than `inst/`[1]. * Add instructions on how to run unit-tests. [1] `733d2e9402`	2020-09-27 20:35:03 +00:00
Kevin Quick	83fec38fc9	Update document generation for empty json object values.	2020-09-24 22:41:24 -07:00
Bryan Richter	5fe375a8f1	nix-prefetch-url: Add --executable flag pkgs.fetchurl supports an executable argument, which is especially nice when downloading a large executable. This patch adds the same option to nix-prefetch-url. I have tested this to work on the simple case of prefetching a little executable: 1. nix-prefetch-url --executable https://my/little/script 2. Paste the hash into a pkgs.fetchurl-based package, script-pkg.nix 3. Delete the output from the store to avoid any misidentified artifacts 4. Realise the package script-pkg.nix 5. Run the executable I repeated the above while using --name, as well. I suspect --executable would have no meaningful effect if combined with --unpack, but I have not tried it.	2020-09-18 19:09:45 +03:00
Eelco Dolstra	0066ef6c59	Fix doc generation	2020-09-16 16:56:28 +02:00
Eelco Dolstra	39bc49318f	jq -> nix	2020-09-16 14:58:06 +02:00
Jade	7cb5f643a6	docs+test: fix remaining installer downloads without -L (#4006 ) Co-authored-by: lf- <lf-@users.noreply.github.com>	2020-09-12 22:08:40 +02:00
Vladimír Čunát	77d4758cf2	Merge #3982 : Minor docs updates	2020-09-07 21:54:59 +02:00
Eelco Dolstra	00d25e8457	Remove the --indirect flag All GC roots are now indirect.	2020-09-03 11:22:00 +02:00
Cole Helbling	a72ed3e8a1	hacking.md: add --prefix flag to configure Otherwise, the steps advertised in this document won't actually work (e.g. `make install` will fail, trying to access /usr, and `./inst/bin/nix` won't exist).	2020-09-01 12:06:02 -07:00
Eelco Dolstra	84f5cabbea	Merge remote-tracking branch 'origin/master' into markdown	2020-08-31 14:24:26 +02:00
Domen Kožar	8757e7022a	mention how to run a single functional test for faster feedback loop	2020-08-30 19:41:21 +02:00
Eelco Dolstra	691a1bd717	Merge branch 'minimal-logger' of https://github.com/Ma27/nix	2020-08-28 10:50:52 +02:00
Eelco Dolstra	7a02865b94	Move import docs	2020-08-25 14:06:01 +02:00
Eelco Dolstra	0f314f3c25	Generate builtins section of the manual	2020-08-24 14:49:30 +02:00
Eelco Dolstra	a990f063ff	Move primop docs inline This makes them available to 'nix repl'.	2020-08-24 14:31:10 +02:00
Eelco Dolstra	33b1679d75	Allow primops to have Markdown documentation	2020-08-24 13:16:02 +02:00
Eelco Dolstra	dc2f278c95	Allow 'nix' subcommands to provide docs in Markdown format	2020-08-20 12:21:46 +02:00
Eelco Dolstra	3c4f8c9175	List deprecated option aliases in the docs	2020-08-20 11:13:17 +02:00
Eelco Dolstra	c3e20d8c28	Consistency	2020-08-19 18:30:17 +02:00
Eelco Dolstra	c8fa39324a	Generate the nix.conf docs from the source code This means we don't have two (divergent) sets of option descriptions anymore.	2020-08-19 18:28:04 +02:00
Eelco Dolstra	8a97b11374	Improve margins between sections The default CSS puts almost no space between sections, but a lot of space between subsections. This flips that around.	2020-08-19 12:31:18 +02:00
Eelco Dolstra	069340179e	Improve nix.1 manpage generator	2020-08-18 15:15:35 +02:00
Eelco Dolstra	6f19c776db	Start generation of the nix.1 manpage	2020-08-17 19:33:18 +02:00
Eelco Dolstra	7cdc739ece	Merge remote-tracking branch 'origin/master' into markdown	2020-08-17 13:43:39 +02:00
Matthew Bauer	641c950701	Add hashed-mirrors back Some users have their own hashed-mirrors setup, that is used to mirror things in addition to what’s available on tarballs.nixos.org. Although this should be feasable to do with a Binary Cache, it’s not always easy, since you have to remember what "name" each of the tarballs has. Continuing to support hashed-mirrors is cheap, so it’s best to leave support in Nix. Note that NIX_HASHED_MIRRORS is also supported in Nixpkgs through fetchurl.nix. Note that this excludes tarballs.nixos.org from the default, as in \#3689. All of these are available on cache.nixos.org.	2020-08-06 18:19:09 -05:00
Eelco Dolstra	bf290c2306	Merge remote-tracking branch 'origin/master' into markdown	2020-07-31 16:07:04 +02:00
Eelco Dolstra	2ae9ac2369	console -> shell	2020-07-31 16:02:37 +02:00
Eelco Dolstra	1d0a7b54fa	Enable syntax highlighting	2020-07-31 15:43:25 +02:00
Matthew Bauer	05ac4db39a	Merge remote-tracking branch 'origin/master' into substitute-other-storedir	2020-07-30 12:38:24 -05:00
Maximilian Bosch	6ccfdb79c7	libutil/logging: extend `internal-json` logger to make it more machine-readable The new error-format is pretty nice from a UX point-of-view, however it's fairly hard to parse the output e.g. for editor plugins such as vim-ale[1] that use `nix-instantiate --parse` to determine syntax errors in Nix expression files. This patch extends the `internal-json` logger by adding the fields `line`, `column` and `file` to easily locate an error in a file and the field `raw_msg` which contains the error-message itself without code-lines and additional helpers. An exemplary output may look like this: ``` [nix-shell]$ ./inst/bin/nix-instantiate ~/test.nix --log-format minimal {"action":"msg","column":1,"file":"/home/ma27/test.nix","level":0,"line":4,"raw_msg":"syntax error, unexpected IF, expecting $end","msg":"<full error-msg with code-lines etc>"} ``` [1] https://github.com/dense-analysis/ale	2020-07-26 02:29:57 +02:00
Eelco Dolstra	1308c8404e	Remove DocBook manual	2020-07-24 15:48:40 +02:00
Eelco Dolstra	05a282295f	Fix internal links	2020-07-24 15:46:16 +02:00
Eelco Dolstra	da3d776cb9	Fix some dangling references	2020-07-24 14:31:33 +02:00
Eelco Dolstra	4a79b3598f	Fix nix-copy-closure manpage	2020-07-24 13:01:00 +02:00
Eelco Dolstra	7a0e6f076a	Move figures	2020-07-24 12:58:31 +02:00
Eelco Dolstra	758c9ee1bb	Clean up the manpages	2020-07-24 12:56:19 +02:00
Eelco Dolstra	8d0b311a1c	Get rid of footnotes Markdown doesn't support them.	2020-07-24 11:43:44 +02:00
Eelco Dolstra	69333cb62c	Sigh	2020-07-23 18:27:20 +02:00
Eelco Dolstra	802150f987	<replaceable> -> <emphasis> Pandoc doesn't know <replaceable> so let's force it to be rendered as italics.	2020-07-23 18:27:20 +02:00
Eelco Dolstra	ee05108472	<simplesect> -> <section> Pandoc silently ignores <simplesect>...	2020-07-23 18:27:20 +02:00
Eelco Dolstra	136fd55bb2	Get rid of <figure>	2020-07-23 18:27:20 +02:00
Eelco Dolstra	ca130b73a0	Get rid of <example> Markdown doesn't have floats so we can't have this.	2020-07-23 18:27:20 +02:00
Eelco Dolstra	13df1faf25	Get rid of callouts since Markdown doesn't support them	2020-07-23 18:27:20 +02:00
Eelco Dolstra	efff6cf163	Install all manpages	2020-07-23 18:27:12 +02:00
Eelco Dolstra	504b7abc45	Convert commands	2020-07-23 18:27:12 +02:00
Eelco Dolstra	efdb89994c	Convert nix.conf manpage	2020-07-23 18:27:11 +02:00
Eelco Dolstra	f390303566	Reconvert	2020-07-23 18:27:11 +02:00

... 9 10 11 12 13 ...

2082 commits