guiwf/lix
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
15,276 Commits 37 Branches 40 Tags
2a98ba8b97c9ff52519633c32cf63716827d6e7c
Commit Graph
100 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
Valentin Gagarinandgithub-actions[bot] 8fb477a6e7 add path based redirects 
up to now, those were managed outside of this repo, which as
unsurprisingly a real hassle to deal with if one wanted to prevent URLs
from breaking when moving pages around. this change removes a large part
of the friction involved in moving content in the Nix manual.

possible next steps for further automation:
- check for content that moved and warn if it's not reachable from
  links that were valid prior to a change
- create redirect rules automatically based on this information

(cherry picked from commit 2b7016cc56d12e67de9f1f25b18311866a26a5fe)
 2023-11-27 13:29:00 +00:00
Valentin Gagarin a68bf15fe6 backport fix for the --help output 2023-11-10 19:22:42 +01:00
Valentin Gagarin 829d4d3e03 fix invalid anchor link 2023-09-07 15:13:22 +02:00
Valentin Gagarin 391f18063c add anchors to option listings 2023-09-06 09:52:56 +02:00
Valentin Gagarin 02c2679f0e dedent common options listing; one sentence per line 
this is a pure reformatting, contents were not changed

one sentence per line makes reviewing diffs and making suggestions much
more convenient. the indentation was an artifat of the DocBook
migration.
 2023-09-06 09:49:00 +02:00
Valentin Gagarin 5c23d3a90c disambiguate output from output path 2023-09-06 09:09:02 +02:00
Valentin GagarinandGitHub f878b422b0 Merge pull request #8422 from fricklerhandwerk/remove-checklist 
move PR checklist to contributing guide
 2023-09-05 15:05:18 +02:00
Valentin Gagarin 3a9c1dc8a3 add checklist to contribution guide 2023-09-05 14:08:40 +02:00
Valentin Gagarin 4f2b949ba8 reorder list items 2023-09-05 14:08:40 +02:00
Valentin Gagarin cc388fbc3a remove maintainers checklist in PR template 
maintainers are not really using it, and it produces a lot of noise when opening PRs.
 2023-09-05 14:08:40 +02:00
Valentin GagarinandGitHub f34484d18a Merge pull request #7592 from fricklerhandwerk/nix-store-realise 
reword description of how realisation works
 2023-09-05 11:55:01 +02:00
Valentin Gagarin 1ac181759d revert some random change 2023-08-31 21:27:13 +02:00
Valentin GagarinandRobert Hensing d38a539437 make description open-ended, add TODO 
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
 2023-08-31 21:27:11 +02:00
Valentin Gagarin 894cbe43bc don't invent terms yet 2023-08-31 21:26:46 +02:00
Valentin Gagarin b951e862d0 more meaningful tagline 2023-08-31 21:26:46 +02:00
Valentin Gagarin cf4e14d58d accommodate "do nothing" branch 2023-08-31 21:26:46 +02:00
Valentin GagarinandRobert Hensing d460dbdd30 be more precise about substituting store derivations 
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
 2023-08-31 21:26:46 +02:00
Valentin GagarinandRobert Hensing 6b3320ab05 mention remote builders 
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
 2023-08-31 21:26:44 +02:00
Valentin Gagarin 0cd8f36644 add anchor to builder 2023-08-31 21:26:15 +02:00
Valentin Gagarin d50f116421 add reference link 2023-08-31 21:25:39 +02:00
Valentin Gagarin b7e9e29605 remove abstract description 2023-08-31 21:25:39 +02:00
Valentin Gagarin a57e0e8c5c reword introductory sentence 2023-08-31 21:25:39 +02:00
Valentin Gagarin 315a11bcc9 remove superfluous word 2023-08-31 21:25:39 +02:00
Valentin Gagarin 1bc9257d7c reword description of how realisation works 2023-08-31 21:25:39 +02:00
Valentin Gagarin d5b130ef13 glossary: dedent list and do not use forced line breaks 
this makes it slightly easier to work with and consistent with all the
other markdown lists in use
 2023-08-24 10:00:17 +02:00
Valentin GagarinandGitHub 85d0eb6316 fix broken links (#8722) 2023-07-20 17:58:14 +02:00
Valentin Gagarin 0e4f6dfcf7 revert anchor prefix for builtin constants 
the original change broke many pre-existing anchor links.

also change formatting of the constants listing slightly:
- the type should not be part of the anchor
- add highlight to the "impure only" note
 2023-07-20 10:27:38 +02:00
Valentin GagarinGitHubRobert HensingJohn Ericson
 		b0173716f6 clarify wording on args@ default handling (#8596) 
* clarify wording on args@ default handling

Most importantly use shorter sentences and emphasize the key point that defaults aren't taken into account

Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
Co-authored-by: John Ericson <git@JohnEricson.me>
 2023-07-19 13:07:07 +00:00
Valentin Gagarin 6c3cd429a6 fix broken links 2023-07-19 11:01:48 +02:00
Valentin Gagarin 0779005f49 expand on the extra-platforms option 2023-07-19 10:57:37 +02:00
Valentin Gagarin fcadac0a02 mention extra-platforms 2023-07-19 10:38:42 +02:00
Valentin GagarinandRobert Hensing aba32def73 fix wording 
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
 2023-07-19 10:38:30 +02:00
Valentin GagarinandRobert Hensing 1a220bed93 do not mention output attributes 
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
 2023-07-19 10:38:12 +02:00
Valentin GagarinandRobert Hensing c8f04e2024 note that naming convention is from Autotools 
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
 2023-07-19 10:37:40 +02:00
Valentin Gagarin 32de11923e add cross-links 2023-07-19 10:37:40 +02:00
Valentin Gagarin 4944e37ec0 expand on the system type in hacking guide 2023-07-19 10:37:40 +02:00
Valentin Gagarin 3763c7bb5e shorten system setting description 2023-07-19 10:37:40 +02:00
Valentin Gagarin c8a42039ea move docs of the current system to the system setting 
add information what happens when Nix itself is cross-compiled
 2023-07-19 10:37:40 +02:00
Valentin Gagarin 0751c1bfc6 one line per sentence for easier review 2023-07-19 10:37:40 +02:00
Valentin Gagarin 68b7bb1a06 add information on the system type string 2023-07-19 10:37:40 +02:00
Valentin Gagarin e14c8a359e list moving parts of channels 2023-07-19 10:26:25 +02:00
Valentin Gagarin 4bab5a6208 revert channel files overview 2023-07-19 09:42:53 +02:00
Valentin Gagarin cd0e39bd89 remove redundant information from channel profile description 2023-07-19 09:39:04 +02:00
Valentin Gagarin ee72ede389 remove the Channels section 
this is a how-to guide which should not be in the reference manual.
it also refers to `nix-env`, which should not be the first thing readers
of the reference manual encounter, as it behaves very differently in
spirit from the rest of Nix.

slightly reword the documentation to be more concise and informative.
 2023-07-19 09:39:04 +02:00
Valentin GagarinandGitHub b8bb8026d2 Merge pull request #8571 from NixOS/split-out-testing-page 2023-06-28 01:22:29 +02:00
Valentin GagarinandGitHub 0ab962d83f Merge pull request #8556 from fricklerhandwerk/hacking-headings 
hacking guide: use more self-descriptive section headings
 2023-06-22 13:45:31 +02:00
Valentin GagarinGitHubRobert Hensing
 		5f9a921bc1 do not use "target", as it's a loaded term in the domain of compilers 
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
 2023-06-21 14:31:09 +02:00
Valentin Gagarin 085104944b add redirects to changed anchors 2023-06-21 09:46:23 +02:00
Valentin Gagarin a78f929065 fix anchor link 2023-06-21 09:43:22 +02:00
Valentin Gagarin 71317162c5 use more self-descriptive section headings 2023-06-20 13:44:43 +02:00
Valentin GagarinandGitHub 3c618c43c6 Merge pull request #8532 from fricklerhandwerk/nix.conf-sections 
split nix.conf man page into sections
 2023-06-20 13:16:14 +02:00
Valentin GagarinandGitHub e91d19db5f be more serious about security risks with trusted users 2023-06-20 12:23:53 +02:00
Valentin Gagarin 68c6219343 clarify setting options on the command line 2023-06-20 12:13:32 +02:00
Valentin Gagarin bc7324e912 clarify read order for configuration settings 2023-06-20 12:13:26 +02:00
Valentin GagarinandGitHub b6e74ea5a8 maintainers: add note on marking PRs as draft 
as discussed with maintainers team
 2023-06-19 10:55:34 +02:00
Valentin GagarinandGitHub 966e5dc991 CONTRIBUTING.md: add link to "good first issues" 2023-06-19 10:39:19 +02:00
Valentin GagarinGitHubJohn EricsonRobert Hensing
 		7bf17f8825 Add description for file system objects (#8500) 
While this is not actually a notion in the implementation, it is
explicitly described in the thesis and quite important for understanding
how the store works.

Co-authored-by: John Ericson <git@JohnEricson.me>
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
 2023-06-18 23:45:08 -04:00
Valentin GagarinandGitHub f695a74751 Update src/libstore/globals.hh 2023-06-16 17:58:01 +02:00
Valentin GagarinGitHubRobert Hensing
 		baef05e6fe fix typo 
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
 2023-06-16 14:37:08 +02:00
Valentin GagarinandGitHub 126eea48e3 do not refer to trusted-users another time 2023-06-16 14:36:53 +02:00
Valentin GagarinandGitHub 1a8ca85d48 use "store URLs" consistently 2023-06-16 14:34:11 +02:00
Valentin GagarinGitHubRobert Hensing
 		4a33d5fe35 fix link text 
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
 2023-06-16 14:33:31 +02:00
Valentin GagarinandGitHub 2ceacce484 Update src/libstore/globals.hh 2023-06-15 15:57:54 +02:00
Valentin GagarinandGitHub b7d47e1d22 fix wording 2023-06-15 04:58:07 +02:00
Valentin Gagarin c3c4076342 make domain-specificity more specific 
also slightly reword the purpose statement to introduce (and explain)
derivations right away.
 2023-06-15 03:08:07 +02:00
Valentin Gagarin 520491607e docs issue template: move checklist down 
it's annoying to write issues with the checklist in the way, and the
proposal is more important.
 2023-06-15 02:31:49 +02:00
Valentin Gagarin c453719d6e rename files referring to antiquotation 
since we renamed this to string interpolation, file names should be
fixed up as well
 2023-06-15 02:29:31 +02:00
Valentin Gagarin e09b40e0d0 reword documentation on trusted users and substituters 
this is to make it slightly easier to scan over
 2023-06-15 02:19:13 +02:00
Valentin GagarinGitHubRobert HensingJohn Ericson
 		a1cf16563f Fixup description of substituters (#8291) 
Introduce what substituters "are" in the configuration option entry.
Remove arbitrary line breaks for easier editing in the future.
Link glossary some more.

Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
Co-authored-by: John Ericson <git@JohnEricson.me>
 2023-06-14 20:49:58 +00:00
Valentin GagarinandGitHub db680e0e57 refine wording on the purpose of the Nix language 
packages and configurations are not really a concept in Nix or the Nix language. the idea of transforming files into other files clearly captures what it's all about, and the new phrasing should make the term "derivation" more obvious both in terms of meaning and origin.
 2023-06-08 02:00:05 +02:00
Valentin GagarinandGitHub 9c6ede85fc Merge pull request #8448 from figsoda/man 2023-06-05 03:00:10 +02:00
Valentin GagarinandGitHub 738c0d5064 Merge pull request #8318 from fricklerhandwerk/doc-currentTime 
document `builtins.currentTime`
 2023-05-31 03:15:54 +02:00
Valentin GagarinandGitHub 52004696c0 Merge pull request #8413 from doronbehar/doc/distributed-builds/clearer-warning 
distributed-builds.md: Clarify warning ssh access requirements
 2023-05-31 02:05:05 +02:00
Valentin Gagarin e2f33e0df1 rewrap lines to use one line per sentence 
this makes future reviews easier as it reduces diff noise
 2023-05-31 01:32:03 +02:00
Valentin Gagarin 9afd525e18 update documentation according to release notes 2023-05-30 22:58:15 +02:00
Valentin Gagarin 7a5731aa07 link to mentioned builtin 2023-05-30 22:58:00 +02:00
Valentin Gagarin 76f40c02bf fix wording on output-addressed store objects 
hashing is an implementation detail.
add references to the other terms.
 2023-05-17 15:04:08 +02:00
Valentin Gagarin 6a5a8f51bb add cross-references to pure evaluation mode 
use consistent wording everywhere.
add some details on the configuration option documentation.
 2023-05-17 15:01:54 +02:00
Valentin Gagarin 549f8dc97b document builtins.currentTime 2023-05-17 13:49:35 +02:00
Valentin Gagarin d8bfeda164 document identifier syntax for attribute sets 
it's more likely for readers to find it right there.

this also slightly rewords examples to make them stand out better.
in the long run there probably needs to be a dedicated section on formal syntax, and better highlighting of examples.
 2023-05-17 13:41:34 +02:00
Valentin GagarinGitHubJohn Ericson
 		8976769a1c Reword info on XDG base dirs (#8338) 
This gives some more context and should clarify why it works that way.
Also link it from the section on `NIX_USER_CONF_FILES`.

Co-authored-by: John Ericson <git@JohnEricson.me>
 2023-05-15 23:30:20 -04:00
Valentin Gagarin 275468a1f0 list files used by nix-channel 2023-05-15 15:26:14 +02:00
Valentin GagarinandGitHub b15cba03c3 Merge pull request #8334 from l0b0/patch-1 2023-05-15 09:12:05 +02:00
Valentin GagarinandGitHub 454e273451 Merge pull request #8328 from urbas/max-substitution-jobs 2023-05-14 11:59:40 +02:00
Valentin GagarinandGitHub 29db89fe7c Merge pull request #8326 from Hoverbear/describe-or-slightly-more 2023-05-13 20:40:40 +02:00
Valentin Gagarin 70eb9c7ddb reword introduction to built-in functions 
add anchor to `builtins.derivation` and list some built-in functions that are
exposed in the global scope.

I decided not to list everything, because we probably don't want to
encourage people using them that way.
 2023-05-11 20:07:42 +02:00
Valentin Gagarin 69a0e6f86c reword documentation on builtins 
- add anchor to `builtins`
- add type information
- reword description of `builtins` to offer more information concisely
 2023-05-11 17:46:37 +02:00
Valentin Gagarin 2ef7f14e28 do not indent markdown list 2023-05-11 15:29:03 +02:00
Valentin GagarinGitHubThéophane Hufschmitt
 		7c03285719 Update CONTRIBUTING.md 
Co-authored-by: Théophane Hufschmitt <7226587+thufschmitt@users.noreply.github.com>
 2023-05-06 14:24:49 +02:00
Valentin Gagarin 0fad8f71c4 highlight 'idea approved' issues in contributing guide 2023-05-05 14:15:29 +02:00
Valentin Gagarin dc8191ae14 add redirect to track moved uninstall section 2023-05-03 11:39:29 +02:00
Valentin GagarinandGitHub 5d78dc4176 doc rendering: add functions to scope explicitly (#7378) 
* doc rendering: add functions to scope explicitly

this especially helps beginners with code readability, since the origin
of names is always immediately visible.
 2023-05-03 07:16:29 +00:00
Valentin Gagarin feb2200ba6 use headings instead of list items 
this allows easier linking and a provides a bit more visual clarity
 2023-05-02 11:30:27 +02:00
Valentin Gagarin 521cca1840 add procedure for 'idea approved' label 2023-05-02 11:28:03 +02:00
Valentin Gagarin f8620758aa display documentation on manifest files separately 
it's probably better not to show the manifest file documentation in the
command-specific pages, because these are implementation details that are not really practically useful.

this means no additional hassle for building the manual, but clutters
the table of contents a bit.
 2023-04-28 12:10:36 +02:00
Valentin Gagarin 9b2a4a4729 move uninstall instructions to a separate page 
placed in a subsection of the binary install, the instructions are hard
to find. putting them in a separate page that is shown in the table of
contents should make it easier for users to find what they need when
they need it.
 2023-04-28 11:53:38 +02:00
Valentin Gagarin da0dbf36cb move manifest information to the bottom of the page 2023-04-26 15:39:35 +02:00
Valentin Gagarin be7c236565 move compatibility info to nix profile docs 2023-04-26 15:39:35 +02:00
Valentin Gagarin 219aaf5a0b increase heading level 
otherwise the headings won't match at the point where they are included.
this is a bit hacky and brittle, but works for now.
 2023-04-26 15:39:35 +02:00
Valentin Gagarin bb8e3b5d86 update description on how profiles work 
adapt to the example listing
 2023-04-26 15:39:35 +02:00