Julian Stecklina
ea861be292
Add documentation for submodule support in fetchGit
2020-03-29 22:29:57 +02:00
Profpatsch
7923e22276
doc/manual: add ids to the advanced attribute definitions
...
This makes it possible to reference single attribute definitions,
for pointing people to their exact definition.
2019-12-03 18:22:27 +01:00
Profpatsch
7395e091c5
doc/manual: add note to allowSubstitutes advanced attribute
2019-12-03 18:01:45 +01:00
Arnout Engelen
4e70652ee3
Document builtins.placeholder
2019-11-25 18:00:05 +01:00
Ersin Akinci
f107a27002
Tweak path hint
2019-10-21 14:16:55 -07:00
Ersin Akinci
b7a936224e
Add hint about path in builtins.import
2019-10-21 14:11:26 -07:00
Ersin Akinci
9be7787ec0
Revert "Document import <path> syntax"
...
This reverts commit d8730fb86f
2019-10-21 13:12:41 -07:00
Ersin Akinci
d8730fb86f
Document import <path> syntax
2019-10-20 19:08:05 -07:00
Danny Bautista
00a567588e
Fix typos in the Nix Manual.
2019-10-08 14:02:40 -04:00
Domen Kožar
043365c2fb
Merge pull request #3080 from Infinisil/tryEval-docs
...
docs: Note that tryEval doesn't do deep evaluation
2019-09-30 14:03:16 +02:00
Alexandre Esteves
9533d85ce0
Move 'builtins.splitVersion' to position respecting alphabetical order
2019-09-17 23:40:49 +01:00
Julien Tanguy
ae244af242
docs: Use the explicit ref for fetchGit with a tag
...
With the merge of #2582 , the syntax "tags/1.9" for refs does not work
anymore.
However, the new syntax "refs/tags/1.9" seems to support annotated tags,
such as "refs/tags/2.0".
Closes #2385 .
2019-09-11 14:18:47 +02:00
Julien Tanguy
92ede15dd9
docs: Fix a typo in github in an example
2019-09-11 14:11:37 +02:00
Silvan Mosberger
e4ea3e0306
docs: Note that tryEval doesn't do deep evaluation
2019-09-03 07:32:44 +02:00
Graham Christensen
171d784404
docs: operators: Make OR and AND capitalized
2019-08-27 06:55:22 -04:00
Graham Christensen
92ddce4f46
operators: document exact precedenc, split up similar operators
2019-08-23 15:50:54 -04:00
Eelco Dolstra
b5ae85f088
Merge pull request #2882 from grahamc/docs/1115-tarball-ttl
...
tarball-ttl: document
2019-07-06 00:15:27 +02:00
Graham Christensen
648bdf153d
tarball-ttl: document
...
Incorporates text from Niklas Hambüchen in #2978
Closes #1115
2019-07-05 15:55:28 -04:00
Eelco Dolstra
33db1d35ae
Merge pull request #2582 from LnL7/fetchgit-refs
...
fetchGit: allow fetching explicit refs
2019-07-02 15:44:31 +02:00
Graham Christensen
c8205a3413
builtins.fetchGit: document absolute ref support
2019-07-02 09:05:56 -04:00
JorisE
4b0d613383
Minor typo
2019-06-04 14:12:03 +02:00
b502b6682b
doc: clarify that optional attrs in a function argument will be ignored unless specified
...
In `args@{ a ? 1 }: /* ... */` the value `a` won't be a part of `args`
unless it's specified when calling the function, the default value will
be ignored in this case.
My personal point of view is that this behavior is a matter of taste, at
least I was pretty sure that unmatched arguments will be a part of
`args@` while debugging some Nix code last week.
I decided to add a warning to the docs which hopefully reduces the
confusion of further Nix developers who thought the same about `args@`.
2019-05-21 18:08:26 +02:00
Daniel Schaefer
3f192ac80c
Add builtins.hashFile
...
For text files it is possible to do it like so:
`builtins.hashString "sha256" (builtins.readFile /tmp/a)`
but that doesn't work for binary files.
With builtins.hashFile any kind of file can be conveniently hashed.
2019-05-03 17:23:36 +02:00
514b3c7f83
Add isPath primop
...
this is added for completeness' sake since all the other possible
`builtins.typeOf` results have a corresponding `builtins.is<Type>`
2019-03-24 11:36:49 +01:00
6f093073b6
manual: include builtins.* for globally available builtins
...
This improves searchability.
2019-03-21 09:37:22 +01:00
Vladimír Čunát
4cfc131ec4
manual nitpick: document sha512 support in hashString
2019-03-01 14:30:30 +01:00
Felix C. Stegerman
fb2c21f71c
manual: quote $servlets
2018-11-13 01:18:26 +01:00
Felix C. Stegerman
18215be59d
fix typo (s/gift/git/)
2018-11-12 17:50:39 +01:00
Eelco Dolstra
b05d6dac7b
Manual: build locally -> build
2018-11-09 16:08:36 +01:00
34d2948f21
Fix manual build
...
This was broken by some missing closing tags in 0bea4a50e0
2018-11-08 14:07:19 +01:00
Eelco Dolstra
750400e0fa
Merge pull request #2524 from domenkozar/deprecate-toPath
...
Deprecate builtins.toPath
2018-11-08 13:22:21 +01:00
Domen Kožar
0bea4a50e0
Deprecate builtins.toPath
2018-11-08 12:03:50 +00:00
Eelco Dolstra
5a3f140856
Document allowSubstitutes
2018-11-07 11:42:22 +01:00
Eelco Dolstra
1109193ea3
Fix preferLocalBuild description
...
preferLocalBuild does not in fact prevent substitution.
2018-11-07 11:37:43 +01:00
Benjamin Hipple
65453e2d77
Docs: update fixed output hashes
...
`fetchurl` will now throw if given an `md5`, and the hashes have generally
been upgraded to avoid it and use `sha256` as a default. This updates the
documentation examples in the manual accordingly.
2018-10-04 02:37:15 +00:00
Profpatsch
05cfc71cab
manual: add XML IDs to all builtin list entries
2018-10-02 15:38:16 +02:00
Eelco Dolstra
51003f892d
Merge pull request #2309 from symphorien/disallowed-man
...
add manual entries for disallowedRequisites and disallowedReferences
2018-09-01 21:01:41 +02:00
Eelco Dolstra
6ed4a6bd0e
Merge pull request #2384 from graham-at-target/fetch-git-examples
...
docs: Add some examples to fetchGit
2018-09-01 14:08:32 +02:00
Graham Christensen
0b7568fb73
Drop ssh://... as a required formatting for builtins.fetchGit
2018-08-31 19:49:56 -04:00
Graham Christensen
149d10c308
docs: Add IDs to important sections
2018-08-31 10:06:33 -04:00
Graham Christensen
2df21b78b9
docs: Add some examples to fetchGit
2018-08-31 10:00:32 -04:00
Symphorien Gibol
81d1385437
add manual entries for disallowedRequisites and disallowedReferences
2018-07-26 18:14:50 +02:00
Michael Raskin
17bc757980
manual: builtins.fromJSON: remove the claim that floats are not allowed
...
floating-point numbers are supported now, including the fromJSON
builtin. Reported on IRC by inquisitiv3
2018-06-10 14:20:18 +02:00
Shea Levy
bbbfc180d9
Explicitly describe the effects of filterSource excluding a directory.
2018-05-30 12:34:41 -04:00
Graham Christensen
f9940f47b3
Merge pull request #2164 from mickours/doc-fetchTarball-timout
...
Explain fetchTarball timeout behavior in the doc
2018-05-30 08:04:26 -04:00
Michael Mercier
8dd2e28374
Explain fetchTarball timeout behavior in the doc
2018-05-30 08:02:46 -04:00
volth
88c1ea30e4
add docs and tests
2018-05-24 12:51:34 +00:00
Gleb Peregud
5ba6395378
docs: mention source of env variables used by impureEnvVars.
2018-05-02 22:45:20 +02:00
Justin Humm
045eb84409
document that writeTextFile from Nixpkgs is an alternative to builtins.toFile
2018-04-03 23:26:47 +02:00
Shea Levy
6856fe62b0
Document fetchGit.
...
Fixes #1981 .
2018-03-23 07:02:45 -04:00
