diff options
| author | Pierre Fenoll <[email protected]> | 2013-12-19 14:36:06 +0000 |
|---|---|---|
| committer | Lukas Larsson <[email protected]> | 2014-03-27 10:07:34 +0100 |
| commit | be34551be2119a6c3c1a7edf113b7db12789423b (patch) | |
| tree | b189873009476617d1e8e8ca058e187fbd62edb5 /erts/doc/src | |
| parent | 25237481ccccd3ddfa74582dc267632ad618ba30 (diff) | |
| download | otp-be34551be2119a6c3c1a7edf113b7db12789423b.tar.gz otp-be34551be2119a6c3c1a7edf113b7db12789423b.tar.bz2 otp-be34551be2119a6c3c1a7edf113b7db12789423b.zip | |
Document an escript:create/2 hidden feature
escript:create/2 accepts a 3-elements tuple containing files and
zip:create/3 options to build a zip file.
Also had to update zip typespecs to allow referral from escript docs.
Diffstat (limited to 'erts/doc/src')
| -rw-r--r-- | erts/doc/src/escript.xml | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/erts/doc/src/escript.xml b/erts/doc/src/escript.xml index 9e2a87dde6..bac8dd1e01 100644 --- a/erts/doc/src/escript.xml +++ b/erts/doc/src/escript.xml @@ -221,8 +221,13 @@ factorial 5 = 120 <v>EmuArgs = string() | 'undefined'</v> <v>Body = {source, SourceCode} | {beam, BeamCode} - | {archive, ZipArchive}</v> - <v>SourceCode = BeamCode = ZipArchive = binary()</v> + | {archive, ZipArchive} + | {archive, ZipFiles, ZipOptions}</v> + <v>SourceCode = BeamCode = file:filename() | binary()</v> + <v>ZipArchive = <seealso marker="stdlib:zip#type-filename">zip:filename()</seealso> | binary()</v> + <v>ZipFiles = [ZipFile]</v> + <v>ZipFile = file:filename() | {file:filename(), binary()} | {file:filename(), binary(), file:file_info()}</v> + <v>ZipOptions = [<seealso marker="stdlib:zip#type-create_option">zip:create_option()</seealso>]</v> </type> <desc> <p>The <marker id="create_2"></marker> <c>create/2</c> |