git.iko.soy/Idris-dev
on master help sign in
Merge pull request #3179 from jfdm/update-sphinx
6bfcfbeJan de Muijnck-Hughes
docs/reference/packages.rst+5−2
compare with master
unifiedsplit
@@ -14,7 +14,8 @@ Package Descriptions
14
14
15A package description includes the following:
15A package description includes the following:
16
16
17−+ A header, consisting of the keyword package followed by the package name.
17++ A header, consisting of the keyword package followed by the package
18+ name. Package names can be any valid Idris identifier.
18+ Fields describing package contents, ``<field> = <value>``
19+ Fields describing package contents, ``<field> = <value>``
19
20
20At least one field must be the modules field, where the value is a
21At least one field must be the modules field, where the value is a
@@ -39,7 +40,9 @@ Other common fields which may be present in an ``ipkg`` file are:
39 directory.
40 directory.
40
41
41+ ``executable = <output>``, which takes the name of the executable
42+ ``executable = <output>``, which takes the name of the executable
42− file to generate.
43+ file to generate. Executable names can be any valid Idris
44+ identifier. the iPKG format also takes a quoted version that accepts
45+ any valid filename.
43
46
44+ ``main = <module>``, which takes the name of the main module, and
47+ ``main = <module>``, which takes the name of the main module, and
45 must be present if the executable field is present.
48 must be present if the executable field is present.
docs/tutorial/packages.rst+3−2
@@ -4,14 +4,15 @@ Packages
4
4
5
5
6Idris includes a simple build system for building packages and executables from a named package description file.
6Idris includes a simple build system for building packages and executables from a named package description file.
7−These files can be used with the Idris compiler to manage the development process .
7+These files can be used with the Idris compiler to manage the development process.
8
8
9Package Descriptions
9Package Descriptions
10====================
10====================
11
11
12A package description includes the following:
12A package description includes the following:
13
13
14−+ A header, consisting of the keyword package followed by the package name.
14++ A header, consisting of the keyword package followed by the package
15+ name. Package names can be any valid Idris identifier.
15+ Fields describing package contents, ``<field> = <value>``
16+ Fields describing package contents, ``<field> = <value>``
16
17
17At least one field must be the modules field, where the value is a
18At least one field must be the modules field, where the value is a