aboutsummaryrefslogtreecommitdiffstats
path: root/erts/doc/src/escript.xml
AgeCommit message (Collapse)Author
2018-09-07Correct doc markersRaimo Niskanen
2017-05-04Update copyright yearRaimo Niskanen
2017-04-28Improvements of escript documentationHåkan Mattsson
2016-09-01doc: Correct errors introduced by Editorial changesHans Bolinder
Fix some older errors as well.
2016-07-13erts: Editorial changesxsipewe
2015-11-04[erts] Correct documentationHans Bolinder
Fix mistakes found by 'xmllint'.
2015-06-18Change license text to APLv2Bruce Yinhe
2014-03-27Merge branch 'pf/document-escript-feature-only-present-in-examples/OTP-11827'Lukas Larsson
* pf/document-escript-feature-only-present-in-examples/OTP-11827: Document an escript:create/2 hidden feature
2014-03-27Document an escript:create/2 hidden featurePierre Fenoll
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.
2014-03-12erts: Clarify escript's encoding of the I/O-serverHans Bolinder
A note has been added that clarifies that the encoding of the I/O-server has to be set explicitly, irrespective of any encoding comment.
2014-01-07Add a chmod call in the CLI examplePierre Fenoll
add missing './'
2013-04-19Convert XML files to UTF-8Hans Bolinder
2013-03-19Let escript recognize an encoding comment on the second lineHans Bolinder
The manual says that an Emacs directive can be placed on the second line. With this patch that directive is also recognized when selecting encoding of the script.
2011-03-11Update copyright yearsBjörn-Egil Dahlberg
2011-01-25Update escrips to allow the -n or -compile(native) flag, which compiles the ↵Lukas Larsson
code within the escript with the +native flag. You need an HiPE enabled emulator for this to work.
2010-03-16Add functions to create and extract escriptsHåkan Mattsson
Both reltool and rebar needs to parse escripts. They are currently using an undocumented function called escript:foldl/3. It folds a function over all files in the body of an escript. If the body contains source code the function compiles it and the gives debug compiled beam code to the fold fun. If the body is an archive the fun is applied for all files in the archive. Instead of making the undocumented function public, the new functions escript:create/2 and escript:extract/2 has been introduced. Together with the new zip:foldl/3 function they have the same functionality as escript:foldl/3 in a more flexible and generic way. escript:foldl/3 should be removed as soon as reltool and rebar has been adopted to use the new functions. The simplest way for reltool and rebar to do this is to just copy the code from escript_SUITE:escript_foldl/3, which happens to provide a future compatible implementation of an emulated escript:foldl/3 function. I was quite hesitant when I introduced the compile_source option. It feels that it does not belong there but the alternative felt worse. The rationale for the compile_source option is that it is a bit cumbersome to compile the source code, as the source in most cases is partial. In order to do compile the source you need to know about some internals in escript. Without compile_source I think that these internals should be documented. Further you need to duplicate parts of the code. Without the compile_source option you need to first parse the source to forms, using an undocumented function in epp with an extended format of predefined macros which also is undocumented. Then you need to investigate the forms to see if you need to add an export form for main. When that is done you can run the rest of the compiler passes as usual. It is not so much code (60 lines or so) to write, but I do not want to urge people to write it. I actually wrote the code (see escript_SUITE:escript_foldl/3) before I decided to introduce the compile_source option.
2010-02-10OTP-8422 Removed bogus "\011" character sequence in documentation.Hans Bolinder
2009-11-20The R13B03 release.OTP_R13B03Erlang/OTP