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
Shea Levy
b095c06139
Add splitVersion primop.
...
Fixes #1868 .
2018-02-14 09:55:43 -05:00
Eelco Dolstra
abe6be578b
Merge pull request #1816 from shlevy/add-path
...
Add path primop.
2018-02-07 13:32:35 +01:00
Shea Levy
69d82e5c58
Add path primop.
...
builtins.path allows specifying the name of a path (which makes paths
with store-illegal names now addable), allows adding paths with flat
instead of recursive hashes, allows specifying a filter (so is a
generalization of filterSource), and allows specifying an expected
hash (enabling safe path adding in pure mode).
2018-02-06 16:48:08 -05:00
Eelco Dolstra
f8e8dd827e
Manual: Remove old cruft
2018-01-31 15:08:46 +01:00
Eric Wolf
0167eac571
Improve manual on inheriting attributes
...
Expands first paragraph a bit
Adds a more comprehensive example
2018-01-27 16:18:31 +01:00
Chris Martin
2a8f09a8c1
Add builtins.concatStringSep to the manual
2017-12-11 14:28:03 -05:00
Zoran Plesivčak
ae506c1ea4
Mention isFloat function in "Built-in Functions" section
2017-11-01 23:00:08 +00:00
Zoran Plesivčak
3050395810
Mention "float" type in builtins.typeOf section of the docs
...
+ remove trailing whitespace from the file
2017-11-01 21:36:25 +00:00
Orivej Desh
842ce8bafd
Clarify indented string escaping rules
2017-10-26 18:53:36 +00:00
Orivej Desh
15457c5673
Describe "with" scoping precedence
2017-10-26 18:53:36 +00:00
Orivej Desh
e5c499b833
Describe arithmetic operators
2017-10-26 18:53:35 +00:00
Chase Adams
09a38f9125
update MD5 to SHA-256 in expression-syntax
2017-08-18 16:07:33 -07:00
Eelco Dolstra
2ee1b9359b
Merge branch 'tokenize' of https://github.com/nbp/nix
2017-08-16 21:21:36 +02:00
Nicolas B. Pierron
b8867a0239
Add builtins.string function.
...
The function 'builtins.split' takes a POSIX extended regular expression
and an arbitrary string. It returns a list of non-matching substring
interleaved by lists of matched groups of the regular expression.
```nix
with builtins;
assert split "(a)b" "abc" == [ "" [ "a" ] "c" ];
assert split "([ac])" "abc" == [ "" [ "a" ] "b" [ "c" ] "" ];
assert split "(a)|(c)" "abc" == [ "" [ "a" null ] "b" [ null "c" ] "" ];
assert split "([[:upper:]]+)" " FOO "
== [ " " [ "FOO" ] " " ];
```
2017-08-15 20:04:11 +00:00
Nicolas B. Pierron
27417c6160
Move builtins.match documentation between map and mul.
2017-08-15 18:34:24 +00:00
Harmen
1e0f59ae14
use sha256 hashes in the examples
...
And fix a dead link.
2017-07-15 21:06:30 +02:00
Eelco Dolstra
d6064dd19b
Merge pull request #1393 from pyrtsa/patch-1
...
Fix variable name typo in derivations doc
2017-05-29 11:32:06 +02:00
Pyry Jahkola
370428f86d
Remove stray > in builtins doc
2017-05-28 20:47:35 +03:00
Pyry Jahkola
86ea7d1566
Fix variable name typo in derivations doc
2017-05-28 15:48:57 +03:00
Eelco Dolstra
b303ad012c
Merge pull request #1382 from FRidh/patch-1
...
Document fetchTarball can take a sha256
2017-05-24 11:07:36 +02:00
Eelco Dolstra
f134fc4cbe
Document that builtins.match takes a POSIX extended RE
2017-05-17 12:18:18 +02:00
