Robert Hensing
e91fd837ee
Move shebang docs from rl-next to nix.md
2023-11-07 13:24:01 -05:00
Tom Bereknyei
c609be4072
doc: explain the . attrPath prefix notation
2023-08-19 17:19:52 -04:00
Bader AlAttar
3fa0266e7a
Fix some grammar in installables doc ( #8682 )
2023-07-10 09:33:04 +00:00
figsoda
b64450ed4e
Fix code block formatting in man page
2023-06-04 14:50:47 -04:00
Alexander Schmolck
afd9bd787d
Also use long options in src/nix/*.md
2023-05-17 08:10:30 +01:00
John Ericson
d93e76fbb8
Start cross-referencing experimental features
...
- Create a glossary entry for experimental features.
- Have the man page experimental feature notice link `nix-commmand`.
(Eventually this should be programmed, based on whether the command is
experimental, and if so what experimental feature does it depend on.)
- Document which installables depend on which experimental features.
I tried to use the same style (bold warning and block quote) that the
top of the man page uses.
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-04-14 07:45:08 -04:00
Eelco Dolstra
233b063b08
Move store docs to 'nix help-stores'
...
Why not 'nix help stores'? Well, 'nix help <arg>' already means 'show
help on the "arg" subcommand'.
2023-03-21 14:37:09 +01:00
Valentin Gagarin
dfeb83cac1
output paths of store derivations are now addressed explicitly
2023-03-06 03:32:14 +01:00
Valentin Gagarin
2af9fd20c6
clarify definition of "installable"
...
the term was hard to discover, as its definition and explanation were in
a very long document lacking an overview section.
search did not help because it occurs so often.
- clarify wording in the definition
- add an overview of installable types
- add "installable" to glossary
- link to definition from occurrences of the term
- be more precise about where store derivation outputs are processed
- installable Nix expressions must evaluate to a derivation
Co-authored-by: Adam Joseph <54836058+amjoseph-nixpkgs@users.noreply.github.com>
2023-03-05 01:46:17 +01:00
Valentin Gagarin
1e87d5f1ea
make descriptions of each installable type an own subsection
...
this is easier to edit, provides anchors for free, and renders correctly
on the terminal without additional effort.
2023-03-05 01:46:17 +01:00
Valentin Gagarin
9cdf8ededb
remove redundant re-definition of store derivations
2023-01-02 13:37:59 +01:00
Valentin Gagarin
7797661a70
link "store derivation" to glossary definition
2022-12-21 11:42:50 +01:00
Valentin Gagarin
3a66d82e1d
update description of "store derivation" in installables section
...
a store derivation is not a store path itself, it has a store path.
2022-12-21 11:42:22 +01:00
John Ericson
32ae715db1
Fix typos in the docs
...
Thanks!
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-12-12 17:37:45 -05:00
John Ericson
d8c1c24c78
Adjust docs
2022-12-12 17:32:24 -05:00
John Ericson
dc075dcdd0
Apply suggestions from code review
...
Co-authored-by: Eelco Dolstra <edolstra@gmail.com>
2022-12-12 16:26:10 -05:00
John Ericson
12461e246b
Leverage existing docs for new store-path^outputs syntax
2022-07-15 14:04:22 +00:00
John Ericson
0e4ec98ae8
Fix typo in docs
...
Thanks!
Co-authored-by: Eelco Dolstra <edolstra@gmail.com>
2022-07-15 09:49:23 -04: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
8735f55dec
Fix bug, test more, document more
2022-07-14 20:23:43 -04:00
John Ericson
49ad315c03
Use ^ not ! in indexed store derivations installable syntax
...
Match the other syntax that was recently added
2022-05-12 20:10:02 +00:00
John Ericson
b18720ee17
Merge remote-tracking branch 'upstream/master' into indexed-store-path-outputs
2022-05-12 19:13:33 +00: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
John Ericson
fda2224b59
Add release notes mark experimental
2022-04-07 19:45:38 +00:00
John Ericson
e5c42bba9b
Merge remote-tracking branch 'upstream/master' into indexed-store-path-outputs
2022-03-10 17:10:15 +00:00
Eelco Dolstra
1a6548ca75
Update docs
2022-02-22 14:32:56 +01:00
Thomas Koch
85b1427662
fix spelling mistakes reported by Debian's lintian tool
2022-01-30 10:51:39 +02:00
regnat
5753f6efbb
Fix the rendering of the example directory tree
2022-01-18 10:55:00 +01:00
Alexander Bantyev
34b66aab00
Update documentation for paths on command line
...
Co-authored-by: Théophane Hufschmitt <7226587+thufschmitt@users.noreply.github.com>
2022-01-17 20:00:04 +03:00
Alexander Bantyev
f055cc5a0b
Document searching upwards and fix documentation for installables
2022-01-14 17:58:03 +03:00
John Ericson
8499f32fb2
New "indexed" installable syntax: <drvPath>!<outputName>
...
Being conservative and only doing a single output name for now.
2021-04-06 10:25:09 -04:00
Eelco Dolstra
5178211e96
Add 'nix' manpage
2020-12-23 18:33:42 +01:00
