From e180470d0da74692a83a0789513685f8873a1b1d Mon Sep 17 00:00:00 2001 From: Raimo Niskanen Date: Fri, 7 Sep 2018 14:40:27 +0200 Subject: Correct doc markers --- erts/doc/src/escript.xml | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) (limited to 'erts/doc') diff --git a/erts/doc/src/escript.xml b/erts/doc/src/escript.xml index 9b0d42185e..be1664b39f 100644 --- a/erts/doc/src/escript.xml +++ b/erts/doc/src/escript.xml @@ -4,7 +4,7 @@
- 20072017 + 20072018 Ericsson AB. All Rights Reserved. @@ -155,9 +155,12 @@ io:setopts([{encoding, unicode}]) for example:

 halt(1).
-

To retrieve the pathname of the script, call - - escript:script_name() from your script +

+ To retrieve the pathname of the script, call + + escript:script_name() + + from your script (the pathname is usually, but not always, absolute).

If the file contains source code (as in the example above), it is processed by the @@ -229,6 +232,7 @@ $ escript factorial.beam 5 factorial 5 = 120 $ escript factorial.zip 5 factorial 5 = 120 + @@ -259,7 +263,7 @@ factorial 5 = 120 zip:create_option()] -

+

Creates an escript from a list of sections. The sections can be specified in any order. An escript begins with an optional Header followed by a mandatory Body. If @@ -344,6 +348,7 @@ ok {{2010,3,2},{0,59,22}}, 54,1,0,0,0,0,0}, <<"%% demo.erl\n-module(demo).\n-export([main/1]).\n\n%% Demo\nmain(_Arg"...>>}]} + @@ -368,9 +373,11 @@ ok SourceCode = BeamCode = ZipArchive = binary() -

- Parses an escript and extracts its sections. This is the reverse - of create/2.

+

+ Parses an escript and extracts its sections. + This is the reverse of + create/2. +

All sections are returned even if they do not exist in the escript. If a particular section happens to have the same value as the default value, the extracted value is set to the @@ -393,6 +400,7 @@ ok {ok,[{{archive,<<80,75,3,4,20,0,0,0,8,0,118,7,98,60,105, 152,61,93,107,0,0,0,118,0,...>>} {emu_args,undefined}]} + @@ -403,7 +411,7 @@ ok File = filename() -

+

Returns the name of the escript that is executed. If the function is invoked outside the context of an escript, the behavior is undefined.

-- cgit v1.2.3