author | wenzelm |
Sat, 26 May 2018 19:40:02 +0200 | |
changeset 68292 | 7ca0c23179e6 |
parent 68290 | f1f5ccc85b25 |
child 68314 | 2acbf8129d8b |
permissions | -rw-r--r-- |
61656 | 1 |
(*:maxLineLen=78:*) |
61575 | 2 |
|
48578 | 3 |
theory Sessions |
4 |
imports Base |
|
5 |
begin |
|
6 |
||
58618 | 7 |
chapter \<open>Isabelle sessions and build management \label{ch:session}\<close> |
48584 | 8 |
|
61575 | 9 |
text \<open> |
10 |
An Isabelle \<^emph>\<open>session\<close> consists of a collection of related theories that may |
|
11 |
be associated with formal documents (\chref{ch:present}). There is also a |
|
12 |
notion of \<^emph>\<open>persistent heap\<close> image to capture the state of a session, |
|
13 |
similar to object-code in compiled programming languages. Thus the concept |
|
14 |
of session resembles that of a ``project'' in common IDE environments, but |
|
15 |
the specific name emphasizes the connection to interactive theorem proving: |
|
16 |
the session wraps-up the results of user-interaction with the prover in a |
|
17 |
persistent form. |
|
48584 | 18 |
|
61575 | 19 |
Application sessions are built on a given parent session, which may be built |
20 |
recursively on other parents. Following this path in the hierarchy |
|
21 |
eventually leads to some major object-logic session like \<open>HOL\<close>, which itself |
|
22 |
is based on \<open>Pure\<close> as the common root of all sessions. |
|
48584 | 23 |
|
61575 | 24 |
Processing sessions may take considerable time. Isabelle build management |
25 |
helps to organize this efficiently. This includes support for parallel build |
|
26 |
jobs, in addition to the multithreaded theory and proof checking that is |
|
27 |
already provided by the prover process itself. |
|
28 |
\<close> |
|
48604 | 29 |
|
48578 | 30 |
|
58618 | 31 |
section \<open>Session ROOT specifications \label{sec:session-root}\<close> |
48578 | 32 |
|
61575 | 33 |
text \<open> |
34 |
Session specifications reside in files called \<^verbatim>\<open>ROOT\<close> within certain |
|
35 |
directories, such as the home locations of registered Isabelle components or |
|
36 |
additional project directories given by the user. |
|
48579 | 37 |
|
61575 | 38 |
The ROOT file format follows the lexical conventions of the \<^emph>\<open>outer syntax\<close> |
39 |
of Isabelle/Isar, see also @{cite "isabelle-isar-ref"}. This defines common |
|
40 |
forms like identifiers, names, quoted strings, verbatim text, nested |
|
41 |
comments etc. The grammar for @{syntax session_chapter} and @{syntax |
|
42 |
session_entry} is given as syntax diagram below; each ROOT file may contain |
|
43 |
multiple specifications like this. Chapters help to organize browser info |
|
44 |
(\secref{sec:info}), but have no formal meaning. The default chapter is |
|
45 |
``\<open>Unsorted\<close>''. |
|
48579 | 46 |
|
61575 | 47 |
Isabelle/jEdit @{cite "isabelle-jedit"} includes a simple editing mode |
48 |
\<^verbatim>\<open>isabelle-root\<close> for session ROOT files, which is enabled by default for any |
|
49 |
file of that name. |
|
48579 | 50 |
|
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
54705
diff
changeset
|
51 |
@{rail \<open> |
51417 | 52 |
@{syntax_def session_chapter}: @'chapter' @{syntax name} |
53 |
; |
|
54 |
||
66971 | 55 |
@{syntax_def session_entry}: @'session' @{syntax system_name} groups? dir? '=' \<newline> |
56 |
(@{syntax system_name} '+')? description? options? \<newline> |
|
68292 | 57 |
(sessions?) (theories*) (document_files*) \<newline> (export_files*) |
48579 | 58 |
; |
59 |
groups: '(' (@{syntax name} +) ')' |
|
60 |
; |
|
61 |
dir: @'in' @{syntax name} |
|
62 |
; |
|
63 |
description: @'description' @{syntax text} |
|
64 |
; |
|
65 |
options: @'options' opts |
|
66 |
; |
|
48605
e777363440d6
allow negative int values as well, according to real = int | float;
wenzelm
parents:
48604
diff
changeset
|
67 |
opts: '[' ( (@{syntax name} '=' value | @{syntax name}) + ',' ) ']' |
e777363440d6
allow negative int values as well, according to real = int | float;
wenzelm
parents:
48604
diff
changeset
|
68 |
; |
e777363440d6
allow negative int values as well, according to real = int | float;
wenzelm
parents:
48604
diff
changeset
|
69 |
value: @{syntax name} | @{syntax real} |
48579 | 70 |
; |
66916 | 71 |
sessions: @'sessions' (@{syntax system_name}+) |
65374 | 72 |
; |
66970
13857f49d215
clarified ROOT syntax: 'sessions' and 'theories' are optional, but need to be non-empty;
wenzelm
parents:
66916
diff
changeset
|
73 |
theories: @'theories' opts? (theory_entry+) |
48579 | 74 |
; |
66916 | 75 |
theory_entry: @{syntax system_name} ('(' @'global' ')')? |
65504 | 76 |
; |
56533
cd8b6d849b6a
explicit 'document_files' in session ROOT specifications;
wenzelm
parents:
55112
diff
changeset
|
77 |
document_files: @'document_files' ('(' dir ')')? (@{syntax name}+) |
68292 | 78 |
; |
79 |
export_files: @'export_files' ('(' dir ')')? (@{syntax name}+) |
|
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
54705
diff
changeset
|
80 |
\<close>} |
48579 | 81 |
|
61575 | 82 |
\<^descr> \isakeyword{session}~\<open>A = B + body\<close> defines a new session \<open>A\<close> based on |
66759 | 83 |
parent session \<open>B\<close>, with its content given in \<open>body\<close> (imported sessions and |
84 |
theories). Note that a parent (like \<open>HOL\<close>) is mandatory in practical |
|
85 |
applications: only Isabelle/Pure can bootstrap itself from nothing. |
|
48579 | 86 |
|
65504 | 87 |
All such session specifications together describe a hierarchy (graph) of |
61575 | 88 |
sessions, with globally unique names. The new session name \<open>A\<close> should be |
89 |
sufficiently long and descriptive to stand on its own in a potentially large |
|
90 |
library. |
|
48579 | 91 |
|
61575 | 92 |
\<^descr> \isakeyword{session}~\<open>A (groups)\<close> indicates a collection of groups where |
93 |
the new session is a member. Group names are uninterpreted and merely follow |
|
94 |
certain conventions. For example, the Isabelle distribution tags some |
|
95 |
important sessions by the group name called ``\<open>main\<close>''. Other projects may |
|
96 |
invent their own conventions, but this requires some care to avoid clashes |
|
48604 | 97 |
within this unchecked name space. |
48579 | 98 |
|
61575 | 99 |
\<^descr> \isakeyword{session}~\<open>A\<close>~\isakeyword{in}~\<open>dir\<close> specifies an explicit |
100 |
directory for this session; by default this is the current directory of the |
|
101 |
\<^verbatim>\<open>ROOT\<close> file. |
|
48579 | 102 |
|
66759 | 103 |
All theory files are located relatively to the session directory. The prover |
104 |
process is run within the same as its current working directory. |
|
48579 | 105 |
|
61575 | 106 |
\<^descr> \isakeyword{description}~\<open>text\<close> is a free-form annotation for this |
107 |
session. |
|
48579 | 108 |
|
61575 | 109 |
\<^descr> \isakeyword{options}~\<open>[x = a, y = b, z]\<close> defines separate options |
110 |
(\secref{sec:system-options}) that are used when processing this session, |
|
111 |
but \<^emph>\<open>without\<close> propagation to child sessions. Note that \<open>z\<close> abbreviates \<open>z = |
|
112 |
true\<close> for Boolean options. |
|
113 |
||
65504 | 114 |
\<^descr> \isakeyword{sessions}~\<open>names\<close> specifies sessions that are \<^emph>\<open>imported\<close> into |
115 |
the current name space of theories. This allows to refer to a theory \<open>A\<close> |
|
116 |
from session \<open>B\<close> by the qualified name \<open>B.A\<close> --- although it is loaded again |
|
117 |
into the current ML process, which is in contrast to a theory that is |
|
118 |
already present in the \<^emph>\<open>parent\<close> session. |
|
119 |
||
65505 | 120 |
Theories that are imported from other sessions are excluded from the current |
121 |
session document. |
|
122 |
||
61575 | 123 |
\<^descr> \isakeyword{theories}~\<open>options names\<close> specifies a block of theories that |
124 |
are processed within an environment that is augmented by the given options, |
|
125 |
in addition to the global session options given before. Any number of blocks |
|
126 |
of \isakeyword{theories} may be given. Options are only active for each |
|
48604 | 127 |
\isakeyword{theories} block separately. |
48579 | 128 |
|
65374 | 129 |
A theory name that is followed by \<open>(\<close>\isakeyword{global}\<open>)\<close> is treated |
66993 | 130 |
literally in other session specifications or theory imports --- the normal |
131 |
situation is to qualify theory names by the session name; this ensures |
|
132 |
globally unique names in big session graphs. Global theories are usually the |
|
133 |
entry points to major logic sessions: \<open>Pure\<close>, \<open>Main\<close>, \<open>Complex_Main\<close>, |
|
134 |
\<open>HOLCF\<close>, \<open>IFOL\<close>, \<open>FOL\<close>, \<open>ZF\<close>, \<open>ZFC\<close> etc. Regular Isabelle applications |
|
135 |
should not claim any global theory names. |
|
65374 | 136 |
|
61575 | 137 |
\<^descr> \isakeyword{document_files}~\<open>(\<close>\isakeyword{in}~\<open>base_dir) files\<close> lists |
138 |
source files for document preparation, typically \<^verbatim>\<open>.tex\<close> and \<^verbatim>\<open>.sty\<close> for |
|
139 |
{\LaTeX}. Only these explicitly given files are copied from the base |
|
140 |
directory to the document output directory, before formal document |
|
141 |
processing is started (see also \secref{sec:tool-document}). The local path |
|
142 |
structure of the \<open>files\<close> is preserved, which allows to reconstruct the |
|
68292 | 143 |
original directory hierarchy of \<open>base_dir\<close>. The default \<open>base_dir\<close> is |
144 |
\<^verbatim>\<open>document\<close> within the session root directory. |
|
56533
cd8b6d849b6a
explicit 'document_files' in session ROOT specifications;
wenzelm
parents:
55112
diff
changeset
|
145 |
|
68292 | 146 |
\<^descr> \isakeyword{export_files}~\<open>(\<close>\isakeyword{in}~\<open>target_dir) patterns\<close> writes |
147 |
theory exports to the file-system: the \<open>target_dir\<close> specification is |
|
148 |
relative to the session root directory; its default is \<^verbatim>\<open>export\<close>. Exports |
|
149 |
are selected via \<open>patterns\<close> as in @{tool_ref export} |
|
150 |
(\secref{sec:tool-export}). |
|
58618 | 151 |
\<close> |
48579 | 152 |
|
51055 | 153 |
|
58618 | 154 |
subsubsection \<open>Examples\<close> |
48580 | 155 |
|
61575 | 156 |
text \<open> |
63680 | 157 |
See \<^file>\<open>~~/src/HOL/ROOT\<close> for a diversity of practically relevant situations, |
158 |
although it uses relatively complex quasi-hierarchic naming conventions like |
|
159 |
\<^verbatim>\<open>HOL-SPARK\<close>, \<^verbatim>\<open>HOL-SPARK-Examples\<close>. An alternative is to use unqualified |
|
160 |
names that are relatively long and descriptive, as in the Archive of Formal |
|
67605 | 161 |
Proofs (\<^url>\<open>https://isa-afp.org\<close>), for example. |
61575 | 162 |
\<close> |
48578 | 163 |
|
164 |
||
58618 | 165 |
section \<open>System build options \label{sec:system-options}\<close> |
48578 | 166 |
|
61575 | 167 |
text \<open> |
63680 | 168 |
See \<^file>\<open>~~/etc/options\<close> for the main defaults provided by the Isabelle |
61575 | 169 |
distribution. Isabelle/jEdit @{cite "isabelle-jedit"} includes a simple |
170 |
editing mode \<^verbatim>\<open>isabelle-options\<close> for this file-format. |
|
48693
ceeea46bdeba
"isabelle options" prints Isabelle system options;
wenzelm
parents:
48684
diff
changeset
|
171 |
|
61575 | 172 |
The following options are particularly relevant to build Isabelle sessions, |
173 |
in particular with document preparation (\chref{ch:present}). |
|
51055 | 174 |
|
61575 | 175 |
\<^item> @{system_option_def "browser_info"} controls output of HTML browser |
176 |
info, see also \secref{sec:info}. |
|
51055 | 177 |
|
61575 | 178 |
\<^item> @{system_option_def "document"} specifies the document output format, |
179 |
see @{tool document} option \<^verbatim>\<open>-o\<close> in \secref{sec:tool-document}. In |
|
180 |
practice, the most relevant values are \<^verbatim>\<open>document=false\<close> or |
|
181 |
\<^verbatim>\<open>document=pdf\<close>. |
|
51055 | 182 |
|
61575 | 183 |
\<^item> @{system_option_def "document_output"} specifies an alternative |
184 |
directory for generated output of the document preparation system; the |
|
185 |
default is within the @{setting "ISABELLE_BROWSER_INFO"} hierarchy as |
|
186 |
explained in \secref{sec:info}. See also @{tool mkroot}, which generates a |
|
187 |
default configuration with output readily available to the author of the |
|
188 |
document. |
|
51055 | 189 |
|
61575 | 190 |
\<^item> @{system_option_def "document_variants"} specifies document variants as |
191 |
a colon-separated list of \<open>name=tags\<close> entries, corresponding to @{tool |
|
192 |
document} options \<^verbatim>\<open>-n\<close> and \<^verbatim>\<open>-t\<close>. |
|
51055 | 193 |
|
61575 | 194 |
For example, \<^verbatim>\<open>document_variants=document:outline=/proof,/ML\<close> indicates |
195 |
two documents: the one called \<^verbatim>\<open>document\<close> with default tags, and the other |
|
196 |
called \<^verbatim>\<open>outline\<close> where proofs and ML sections are folded. |
|
51055 | 197 |
|
61575 | 198 |
Document variant names are just a matter of conventions. It is also |
199 |
possible to use different document variant names (without tags) for |
|
200 |
different document root entries, see also \secref{sec:tool-document}. |
|
51055 | 201 |
|
67140 | 202 |
\<^item> @{system_option_def "document_tags"} specifies a default for otherwise |
203 |
untagged commands. This is occasionally useful to control the global |
|
204 |
visibility of commands via session options (e.g. in \<^verbatim>\<open>ROOT\<close>). |
|
205 |
||
61575 | 206 |
\<^item> @{system_option_def "threads"} determines the number of worker threads |
207 |
for parallel checking of theories and proofs. The default \<open>0\<close> means that a |
|
208 |
sensible maximum value is determined by the underlying hardware. For |
|
209 |
machines with many cores or with hyperthreading, this is often requires |
|
210 |
manual adjustment (on the command-line or within personal settings or |
|
211 |
preferences, not within a session \<^verbatim>\<open>ROOT\<close>). |
|
51055 | 212 |
|
63827
b24d0e53dd03
option "checkpoint" helps to fine-tune global heap space management;
wenzelm
parents:
63680
diff
changeset
|
213 |
\<^item> @{system_option_def "checkpoint"} helps to fine-tune the global heap |
b24d0e53dd03
option "checkpoint" helps to fine-tune global heap space management;
wenzelm
parents:
63680
diff
changeset
|
214 |
space management. This is relevant for big sessions that may exhaust the |
b24d0e53dd03
option "checkpoint" helps to fine-tune global heap space management;
wenzelm
parents:
63680
diff
changeset
|
215 |
small 32-bit address space of the ML process (which is used by default). |
b24d0e53dd03
option "checkpoint" helps to fine-tune global heap space management;
wenzelm
parents:
63680
diff
changeset
|
216 |
When the option is enabled for some \isakeyword{theories} block, a full |
b24d0e53dd03
option "checkpoint" helps to fine-tune global heap space management;
wenzelm
parents:
63680
diff
changeset
|
217 |
sharing stage of immutable values in memory happens \<^emph>\<open>before\<close> loading the |
b24d0e53dd03
option "checkpoint" helps to fine-tune global heap space management;
wenzelm
parents:
63680
diff
changeset
|
218 |
specified theories. |
b24d0e53dd03
option "checkpoint" helps to fine-tune global heap space management;
wenzelm
parents:
63680
diff
changeset
|
219 |
|
61575 | 220 |
\<^item> @{system_option_def "condition"} specifies a comma-separated list of |
221 |
process environment variables (or Isabelle settings) that are required for |
|
222 |
the subsequent theories to be processed. Conditions are considered |
|
223 |
``true'' if the corresponding environment value is defined and non-empty. |
|
51055 | 224 |
|
61602 | 225 |
\<^item> @{system_option_def "timeout"} and @{system_option_def "timeout_scale"} |
226 |
specify a real wall-clock timeout for the session as a whole: the two |
|
227 |
values are multiplied and taken as the number of seconds. Typically, |
|
228 |
@{system_option "timeout"} is given for individual sessions, and |
|
229 |
@{system_option "timeout_scale"} as global adjustment to overall hardware |
|
230 |
performance. |
|
231 |
||
232 |
The timer is controlled outside the ML process by the JVM that runs |
|
233 |
Isabelle/Scala. Thus it is relatively reliable in canceling processes that |
|
234 |
get out of control, even if there is a deadlock without CPU time usage. |
|
51055 | 235 |
|
64308 | 236 |
\<^item> @{system_option_def "profiling"} specifies a mode for global ML |
237 |
profiling. Possible values are the empty string (disabled), \<^verbatim>\<open>time\<close> for |
|
238 |
@{ML profile_time} and \<^verbatim>\<open>allocations\<close> for @{ML profile_allocations}. |
|
239 |
Results appear near the bottom of the session log file. |
|
240 |
||
61575 | 241 |
The @{tool_def options} tool prints Isabelle system options. Its |
48693
ceeea46bdeba
"isabelle options" prints Isabelle system options;
wenzelm
parents:
48684
diff
changeset
|
242 |
command-line usage is: |
61407
7ba7b8103565
@{verbatim [display]} supersedes old alltt/ttbox;
wenzelm
parents:
61406
diff
changeset
|
243 |
@{verbatim [display] |
7ba7b8103565
@{verbatim [display]} supersedes old alltt/ttbox;
wenzelm
parents:
61406
diff
changeset
|
244 |
\<open>Usage: isabelle options [OPTIONS] [MORE_OPTIONS ...] |
48693
ceeea46bdeba
"isabelle options" prints Isabelle system options;
wenzelm
parents:
48684
diff
changeset
|
245 |
|
ceeea46bdeba
"isabelle options" prints Isabelle system options;
wenzelm
parents:
48684
diff
changeset
|
246 |
Options are: |
ceeea46bdeba
"isabelle options" prints Isabelle system options;
wenzelm
parents:
48684
diff
changeset
|
247 |
-b include $ISABELLE_BUILD_OPTIONS |
52735 | 248 |
-g OPTION get value of OPTION |
50531
f841ac0cb757
clarified "isabelle options" command line, to make it more close to "isabelle components";
wenzelm
parents:
50406
diff
changeset
|
249 |
-l list options |
48693
ceeea46bdeba
"isabelle options" prints Isabelle system options;
wenzelm
parents:
48684
diff
changeset
|
250 |
-x FILE export to FILE in YXML format |
ceeea46bdeba
"isabelle options" prints Isabelle system options;
wenzelm
parents:
48684
diff
changeset
|
251 |
|
50531
f841ac0cb757
clarified "isabelle options" command line, to make it more close to "isabelle components";
wenzelm
parents:
50406
diff
changeset
|
252 |
Report Isabelle system options, augmented by MORE_OPTIONS given as |
61407
7ba7b8103565
@{verbatim [display]} supersedes old alltt/ttbox;
wenzelm
parents:
61406
diff
changeset
|
253 |
arguments NAME=VAL or NAME.\<close>} |
48693
ceeea46bdeba
"isabelle options" prints Isabelle system options;
wenzelm
parents:
48684
diff
changeset
|
254 |
|
61575 | 255 |
The command line arguments provide additional system options of the form |
256 |
\<open>name\<close>\<^verbatim>\<open>=\<close>\<open>value\<close> or \<open>name\<close> for Boolean options. |
|
257 |
||
258 |
Option \<^verbatim>\<open>-b\<close> augments the implicit environment of system options by the ones |
|
259 |
of @{setting ISABELLE_BUILD_OPTIONS}, cf.\ \secref{sec:tool-build}. |
|
48693
ceeea46bdeba
"isabelle options" prints Isabelle system options;
wenzelm
parents:
48684
diff
changeset
|
260 |
|
61575 | 261 |
Option \<^verbatim>\<open>-g\<close> prints the value of the given option. Option \<^verbatim>\<open>-l\<close> lists all |
262 |
options with their declaration and current value. |
|
48693
ceeea46bdeba
"isabelle options" prints Isabelle system options;
wenzelm
parents:
48684
diff
changeset
|
263 |
|
61575 | 264 |
Option \<^verbatim>\<open>-x\<close> specifies a file to export the result in YXML format, instead |
265 |
of printing it in human-readable form. |
|
58618 | 266 |
\<close> |
48578 | 267 |
|
268 |
||
58618 | 269 |
section \<open>Invoking the build process \label{sec:tool-build}\<close> |
48578 | 270 |
|
61575 | 271 |
text \<open> |
272 |
The @{tool_def build} tool invokes the build process for Isabelle sessions. |
|
273 |
It manages dependencies between sessions, related sources of theories and |
|
274 |
auxiliary files, and target heap images. Accordingly, it runs instances of |
|
275 |
the prover process with optional document preparation. Its command-line |
|
276 |
usage is:\<^footnote>\<open>Isabelle/Scala provides the same functionality via |
|
61572 | 277 |
\<^verbatim>\<open>isabelle.Build.build\<close>.\<close> |
61407
7ba7b8103565
@{verbatim [display]} supersedes old alltt/ttbox;
wenzelm
parents:
61406
diff
changeset
|
278 |
@{verbatim [display] |
7ba7b8103565
@{verbatim [display]} supersedes old alltt/ttbox;
wenzelm
parents:
61406
diff
changeset
|
279 |
\<open>Usage: isabelle build [OPTIONS] [SESSIONS ...] |
48578 | 280 |
|
281 |
Options are: |
|
66737
2edc0c42c883
option -B for "isabelle build" and "isabelle imports";
wenzelm
parents:
66671
diff
changeset
|
282 |
-B NAME include session NAME and all descendants |
48737
f3bbb9ca57d6
added build option -D: include session directory and select its sessions;
wenzelm
parents:
48693
diff
changeset
|
283 |
-D DIR include session directory and select its sessions |
64265 | 284 |
-N cyclic shuffling of NUMA CPU nodes (performance tuning) |
49131 | 285 |
-R operate on requirements of selected sessions |
66745 | 286 |
-S soft build: only observe changes of sources, not heap images |
60106 | 287 |
-X NAME exclude sessions from group NAME and all descendants |
48578 | 288 |
-a select all sessions |
289 |
-b build heap images |
|
48595 | 290 |
-c clean build |
48737
f3bbb9ca57d6
added build option -D: include session directory and select its sessions;
wenzelm
parents:
48693
diff
changeset
|
291 |
-d DIR include session directory |
66841 | 292 |
-f fresh build |
48578 | 293 |
-g NAME select session group NAME |
294 |
-j INT maximum number of parallel jobs (default 1) |
|
59891
9ce697050455
added isabelle build option -k, for fast off-line checking of theory sources;
wenzelm
parents:
59446
diff
changeset
|
295 |
-k KEYWORD check theory sources for conflicts with proposed keywords |
48903 | 296 |
-l list session source files |
48578 | 297 |
-n no build -- test dependencies only |
52056 | 298 |
-o OPTION override Isabelle system OPTION (via NAME=VAL or NAME) |
48578 | 299 |
-s system build mode: produce output in ISABELLE_HOME |
300 |
-v verbose |
|
60106 | 301 |
-x NAME exclude session NAME and all descendants |
48578 | 302 |
|
62596 | 303 |
Build and manage Isabelle sessions, depending on implicit settings: |
304 |
||
48578 | 305 |
ISABELLE_BUILD_OPTIONS="..." |
306 |
||
307 |
ML_PLATFORM="..." |
|
308 |
ML_HOME="..." |
|
309 |
ML_SYSTEM="..." |
|
61407
7ba7b8103565
@{verbatim [display]} supersedes old alltt/ttbox;
wenzelm
parents:
61406
diff
changeset
|
310 |
ML_OPTIONS="..."\<close>} |
48578 | 311 |
|
61406 | 312 |
\<^medskip> |
61575 | 313 |
Isabelle sessions are defined via session ROOT files as described in |
314 |
(\secref{sec:session-root}). The totality of sessions is determined by |
|
315 |
collecting such specifications from all Isabelle component directories |
|
316 |
(\secref{sec:components}), augmented by more directories given via options |
|
317 |
\<^verbatim>\<open>-d\<close>~\<open>DIR\<close> on the command line. Each such directory may contain a session |
|
61503 | 318 |
\<^verbatim>\<open>ROOT\<close> file with several session specifications. |
48578 | 319 |
|
61575 | 320 |
Any session root directory may refer recursively to further directories of |
321 |
the same kind, by listing them in a catalog file \<^verbatim>\<open>ROOTS\<close> line-by-line. This |
|
322 |
helps to organize large collections of session specifications, or to make |
|
66576 | 323 |
\<^verbatim>\<open>-d\<close> command line options persistent (e.g.\ in |
61503 | 324 |
\<^verbatim>\<open>$ISABELLE_HOME_USER/ROOTS\<close>). |
48684
9170e10c651e
re-introduced ROOTS catalog files (cf. 47330b712f8f) which help to organize AFP or make -d options persistent;
wenzelm
parents:
48683
diff
changeset
|
325 |
|
61406 | 326 |
\<^medskip> |
61575 | 327 |
The subset of sessions to be managed is determined via individual \<open>SESSIONS\<close> |
328 |
given as command-line arguments, or session groups that are given via one or |
|
329 |
more options \<^verbatim>\<open>-g\<close>~\<open>NAME\<close>. Option \<^verbatim>\<open>-a\<close> selects all sessions. The build tool |
|
330 |
takes session dependencies into account: the set of selected sessions is |
|
331 |
completed by including all ancestors. |
|
48578 | 332 |
|
61406 | 333 |
\<^medskip> |
66737
2edc0c42c883
option -B for "isabelle build" and "isabelle imports";
wenzelm
parents:
66671
diff
changeset
|
334 |
One or more options \<^verbatim>\<open>-B\<close>~\<open>NAME\<close> specify base sessions. All descendants |
2edc0c42c883
option -B for "isabelle build" and "isabelle imports";
wenzelm
parents:
66671
diff
changeset
|
335 |
are included. |
2edc0c42c883
option -B for "isabelle build" and "isabelle imports";
wenzelm
parents:
66671
diff
changeset
|
336 |
|
2edc0c42c883
option -B for "isabelle build" and "isabelle imports";
wenzelm
parents:
66671
diff
changeset
|
337 |
\<^medskip> |
61575 | 338 |
One or more options \<^verbatim>\<open>-x\<close>~\<open>NAME\<close> specify sessions to be excluded. All |
339 |
descendents of excluded sessions are removed from the selection as specified |
|
340 |
above. Option \<^verbatim>\<open>-X\<close> is analogous to this, but excluded sessions are |
|
341 |
specified by session group membership. |
|
59892
2a616319c171
added isabelle build option -x, to exclude sessions;
wenzelm
parents:
59891
diff
changeset
|
342 |
|
61406 | 343 |
\<^medskip> |
61575 | 344 |
Option \<^verbatim>\<open>-R\<close> reverses the selection in the sense that it refers to its |
345 |
requirements: all ancestor sessions excluding the original selection. This |
|
346 |
allows to prepare the stage for some build process with different options, |
|
347 |
before running the main build itself (without option \<^verbatim>\<open>-R\<close>). |
|
49131 | 348 |
|
61406 | 349 |
\<^medskip> |
61575 | 350 |
Option \<^verbatim>\<open>-D\<close> is similar to \<^verbatim>\<open>-d\<close>, but selects all sessions that are defined |
351 |
in the given directories. |
|
48737
f3bbb9ca57d6
added build option -D: include session directory and select its sessions;
wenzelm
parents:
48693
diff
changeset
|
352 |
|
61406 | 353 |
\<^medskip> |
66745 | 354 |
Option \<^verbatim>\<open>-S\<close> indicates a ``soft build'': the selection is restricted to |
355 |
those sessions that have changed sources (according to actually imported |
|
356 |
theories). The status of heap images is ignored. |
|
357 |
||
358 |
\<^medskip> |
|
61406 | 359 |
The build process depends on additional options |
61575 | 360 |
(\secref{sec:system-options}) that are passed to the prover eventually. The |
361 |
settings variable @{setting_ref ISABELLE_BUILD_OPTIONS} allows to provide |
|
61602 | 362 |
additional defaults, e.g.\ \<^verbatim>\<open>ISABELLE_BUILD_OPTIONS="document=pdf threads=4"\<close>. |
363 |
Moreover, the environment of system build options may be augmented on the |
|
364 |
command line via \<^verbatim>\<open>-o\<close>~\<open>name\<close>\<^verbatim>\<open>=\<close>\<open>value\<close> or \<^verbatim>\<open>-o\<close>~\<open>name\<close>, which abbreviates |
|
365 |
\<^verbatim>\<open>-o\<close>~\<open>name\<close>\<^verbatim>\<open>=true\<close> for Boolean options. Multiple occurrences of \<^verbatim>\<open>-o\<close> on |
|
366 |
the command-line are applied in the given order. |
|
48578 | 367 |
|
61406 | 368 |
\<^medskip> |
61575 | 369 |
Option \<^verbatim>\<open>-b\<close> ensures that heap images are produced for all selected |
370 |
sessions. By default, images are only saved for inner nodes of the hierarchy |
|
371 |
of sessions, as required for other sessions to continue later on. |
|
48578 | 372 |
|
61406 | 373 |
\<^medskip> |
61575 | 374 |
Option \<^verbatim>\<open>-c\<close> cleans all descendants of the selected sessions before |
375 |
performing the specified build operation. |
|
48595 | 376 |
|
61406 | 377 |
\<^medskip> |
66841 | 378 |
Option \<^verbatim>\<open>-f\<close> forces a fresh build of all selected sessions and their |
379 |
requirements. |
|
380 |
||
381 |
\<^medskip> |
|
61575 | 382 |
Option \<^verbatim>\<open>-n\<close> omits the actual build process after the preparatory stage |
383 |
(including optional cleanup). Note that the return code always indicates the |
|
384 |
status of the set of selected sessions. |
|
48595 | 385 |
|
61406 | 386 |
\<^medskip> |
61575 | 387 |
Option \<^verbatim>\<open>-j\<close> specifies the maximum number of parallel build jobs (prover |
388 |
processes). Each prover process is subject to a separate limit of parallel |
|
389 |
worker threads, cf.\ system option @{system_option_ref threads}. |
|
48578 | 390 |
|
61406 | 391 |
\<^medskip> |
64265 | 392 |
Option \<^verbatim>\<open>-N\<close> enables cyclic shuffling of NUMA CPU nodes. This may help |
393 |
performance tuning on Linux servers with separate CPU/memory modules. |
|
394 |
||
395 |
\<^medskip> |
|
61575 | 396 |
Option \<^verbatim>\<open>-s\<close> enables \<^emph>\<open>system mode\<close>, which means that resulting heap images |
63669 | 397 |
and log files are stored in @{path "$ISABELLE_HOME/heaps"} instead of the |
68219 | 398 |
default location @{path "$ISABELLE_HOME_USER/heaps"}. |
48578 | 399 |
|
61406 | 400 |
\<^medskip> |
61575 | 401 |
Option \<^verbatim>\<open>-v\<close> increases the general level of verbosity. Option \<^verbatim>\<open>-l\<close> lists |
402 |
the source files that contribute to a session. |
|
59891
9ce697050455
added isabelle build option -k, for fast off-line checking of theory sources;
wenzelm
parents:
59446
diff
changeset
|
403 |
|
61406 | 404 |
\<^medskip> |
61575 | 405 |
Option \<^verbatim>\<open>-k\<close> specifies a newly proposed keyword for outer syntax (multiple |
406 |
uses allowed). The theory sources are checked for conflicts wrt.\ this |
|
407 |
hypothetical change of syntax, e.g.\ to reveal occurrences of identifiers |
|
408 |
that need to be quoted. |
|
409 |
\<close> |
|
59891
9ce697050455
added isabelle build option -k, for fast off-line checking of theory sources;
wenzelm
parents:
59446
diff
changeset
|
410 |
|
48578 | 411 |
|
58618 | 412 |
subsubsection \<open>Examples\<close> |
48578 | 413 |
|
58618 | 414 |
text \<open> |
48578 | 415 |
Build a specific logic image: |
61407
7ba7b8103565
@{verbatim [display]} supersedes old alltt/ttbox;
wenzelm
parents:
61406
diff
changeset
|
416 |
@{verbatim [display] \<open>isabelle build -b HOLCF\<close>} |
48578 | 417 |
|
61406 | 418 |
\<^smallskip> |
419 |
Build the main group of logic images: |
|
61407
7ba7b8103565
@{verbatim [display]} supersedes old alltt/ttbox;
wenzelm
parents:
61406
diff
changeset
|
420 |
@{verbatim [display] \<open>isabelle build -b -g main\<close>} |
48578 | 421 |
|
61406 | 422 |
\<^smallskip> |
66748 | 423 |
Build all descendants (and requirements) of \<^verbatim>\<open>FOL\<close> and \<^verbatim>\<open>ZF\<close>: |
424 |
@{verbatim [display] \<open>isabelle build -B FOL -B ZF\<close>} |
|
425 |
||
426 |
\<^smallskip> |
|
427 |
Build all sessions where sources have changed (ignoring heaps): |
|
428 |
@{verbatim [display] \<open>isabelle build -a -S\<close>} |
|
429 |
||
430 |
\<^smallskip> |
|
61575 | 431 |
Provide a general overview of the status of all Isabelle sessions, without |
432 |
building anything: |
|
61407
7ba7b8103565
@{verbatim [display]} supersedes old alltt/ttbox;
wenzelm
parents:
61406
diff
changeset
|
433 |
@{verbatim [display] \<open>isabelle build -a -n -v\<close>} |
48578 | 434 |
|
61406 | 435 |
\<^smallskip> |
61575 | 436 |
Build all sessions with HTML browser info and PDF document preparation: |
61407
7ba7b8103565
@{verbatim [display]} supersedes old alltt/ttbox;
wenzelm
parents:
61406
diff
changeset
|
437 |
@{verbatim [display] \<open>isabelle build -a -o browser_info -o document=pdf\<close>} |
48578 | 438 |
|
61406 | 439 |
\<^smallskip> |
61575 | 440 |
Build all sessions with a maximum of 8 parallel prover processes and 4 |
441 |
worker threads each (on a machine with many cores): |
|
61407
7ba7b8103565
@{verbatim [display]} supersedes old alltt/ttbox;
wenzelm
parents:
61406
diff
changeset
|
442 |
@{verbatim [display] \<open>isabelle build -a -j8 -o threads=4\<close>} |
48595 | 443 |
|
61406 | 444 |
\<^smallskip> |
61575 | 445 |
Build some session images with cleanup of their descendants, while retaining |
446 |
their ancestry: |
|
61407
7ba7b8103565
@{verbatim [display]} supersedes old alltt/ttbox;
wenzelm
parents:
61406
diff
changeset
|
447 |
@{verbatim [display] \<open>isabelle build -b -c HOL-Algebra HOL-Word\<close>} |
48595 | 448 |
|
61406 | 449 |
\<^smallskip> |
450 |
Clean all sessions without building anything: |
|
61407
7ba7b8103565
@{verbatim [display]} supersedes old alltt/ttbox;
wenzelm
parents:
61406
diff
changeset
|
451 |
@{verbatim [display] \<open>isabelle build -a -n -c\<close>} |
48737
f3bbb9ca57d6
added build option -D: include session directory and select its sessions;
wenzelm
parents:
48693
diff
changeset
|
452 |
|
61406 | 453 |
\<^smallskip> |
61575 | 454 |
Build all sessions from some other directory hierarchy, according to the |
455 |
settings variable \<^verbatim>\<open>AFP\<close> that happens to be defined inside the Isabelle |
|
456 |
environment: |
|
61407
7ba7b8103565
@{verbatim [display]} supersedes old alltt/ttbox;
wenzelm
parents:
61406
diff
changeset
|
457 |
@{verbatim [display] \<open>isabelle build -D '$AFP'\<close>} |
49131 | 458 |
|
61406 | 459 |
\<^smallskip> |
61575 | 460 |
Inform about the status of all sessions required for AFP, without building |
461 |
anything yet: |
|
61407
7ba7b8103565
@{verbatim [display]} supersedes old alltt/ttbox;
wenzelm
parents:
61406
diff
changeset
|
462 |
@{verbatim [display] \<open>isabelle build -D '$AFP' -R -v -n\<close>} |
58618 | 463 |
\<close> |
48578 | 464 |
|
66671 | 465 |
|
466 |
section \<open>Maintain theory imports wrt.\ session structure\<close> |
|
467 |
||
468 |
text \<open> |
|
469 |
The @{tool_def "imports"} tool helps to maintain theory imports wrt.\ |
|
470 |
session structure. It supports three main operations via options \<^verbatim>\<open>-I\<close>, |
|
471 |
\<^verbatim>\<open>-M\<close>, \<^verbatim>\<open>-U\<close>. Its command-line usage is: @{verbatim [display] |
|
472 |
\<open>Usage: isabelle imports [OPTIONS] [SESSIONS ...] |
|
473 |
||
474 |
Options are: |
|
66737
2edc0c42c883
option -B for "isabelle build" and "isabelle imports";
wenzelm
parents:
66671
diff
changeset
|
475 |
-B NAME include session NAME and all descendants |
66671 | 476 |
-D DIR include session directory and select its sessions |
66851
c75769065548
more informative Imports.Report with actual session imports (minimized);
wenzelm
parents:
66841
diff
changeset
|
477 |
-I operation: report session imports |
66671 | 478 |
-M operation: Mercurial repository check for theory files |
479 |
-R operate on requirements of selected sessions |
|
480 |
-U operation: update theory imports to use session qualifiers |
|
481 |
-X NAME exclude sessions from group NAME and all descendants |
|
482 |
-a select all sessions |
|
483 |
-d DIR include session directory |
|
484 |
-g NAME select session group NAME |
|
485 |
-i incremental update according to session graph structure |
|
486 |
-o OPTION override Isabelle system OPTION (via NAME=VAL or NAME) |
|
487 |
-v verbose |
|
488 |
-x NAME exclude session NAME and all descendants |
|
489 |
||
490 |
Maintain theory imports wrt. session structure. At least one operation |
|
491 |
needs to be specified (see options -I -M -U).\<close>} |
|
492 |
||
493 |
\<^medskip> |
|
494 |
The selection of sessions and session directories works as for @{tool build} |
|
66737
2edc0c42c883
option -B for "isabelle build" and "isabelle imports";
wenzelm
parents:
66671
diff
changeset
|
495 |
via options \<^verbatim>\<open>-B\<close>, \<^verbatim>\<open>-D\<close>, \<^verbatim>\<open>-R\<close>, \<^verbatim>\<open>-X\<close>, \<^verbatim>\<open>-a\<close>, \<^verbatim>\<open>-d\<close>, \<^verbatim>\<open>-g\<close>, \<^verbatim>\<open>-x\<close> (see |
66671 | 496 |
\secref{sec:tool-build}). |
497 |
||
498 |
\<^medskip> |
|
499 |
Option \<^verbatim>\<open>-o\<close> overrides Isabelle system options as for @{tool build} |
|
500 |
(see \secref{sec:tool-build}). |
|
501 |
||
502 |
\<^medskip> |
|
503 |
Option \<^verbatim>\<open>-v\<close> increases the general level of verbosity. |
|
504 |
||
505 |
\<^medskip> |
|
66851
c75769065548
more informative Imports.Report with actual session imports (minimized);
wenzelm
parents:
66841
diff
changeset
|
506 |
Option \<^verbatim>\<open>-I\<close> determines reports session imports: |
c75769065548
more informative Imports.Report with actual session imports (minimized);
wenzelm
parents:
66841
diff
changeset
|
507 |
|
c75769065548
more informative Imports.Report with actual session imports (minimized);
wenzelm
parents:
66841
diff
changeset
|
508 |
\<^descr>[Potential session imports] are derived from old-style use of theory |
c75769065548
more informative Imports.Report with actual session imports (minimized);
wenzelm
parents:
66841
diff
changeset
|
509 |
files from other sessions via the directory structure. After declaring |
c75769065548
more informative Imports.Report with actual session imports (minimized);
wenzelm
parents:
66841
diff
changeset
|
510 |
those as \isakeyword{sessions} in the corresponding \<^verbatim>\<open>ROOT\<close> file entry, a |
c75769065548
more informative Imports.Report with actual session imports (minimized);
wenzelm
parents:
66841
diff
changeset
|
511 |
proper session-qualified theory name can be used (cf.\ option \<^verbatim>\<open>-U\<close>). For |
c75769065548
more informative Imports.Report with actual session imports (minimized);
wenzelm
parents:
66841
diff
changeset
|
512 |
example, adhoc \<^theory_text>\<open>imports\<close> \<^verbatim>\<open>"~~/src/HOL/Library/Multiset"\<close> becomes formal |
c75769065548
more informative Imports.Report with actual session imports (minimized);
wenzelm
parents:
66841
diff
changeset
|
513 |
\<^theory_text>\<open>imports\<close> \<^verbatim>\<open>"HOL-Library.Multiset"\<close> after adding \isakeyword{sessions} |
c75769065548
more informative Imports.Report with actual session imports (minimized);
wenzelm
parents:
66841
diff
changeset
|
514 |
\<^verbatim>\<open>"HOL-Library"\<close> to the \<^verbatim>\<open>ROOT\<close> entry. |
c75769065548
more informative Imports.Report with actual session imports (minimized);
wenzelm
parents:
66841
diff
changeset
|
515 |
|
c75769065548
more informative Imports.Report with actual session imports (minimized);
wenzelm
parents:
66841
diff
changeset
|
516 |
\<^descr>[Actual session imports] are derived from the session qualifiers of all |
c75769065548
more informative Imports.Report with actual session imports (minimized);
wenzelm
parents:
66841
diff
changeset
|
517 |
currently imported theories. This helps to minimize dependencies in the |
c75769065548
more informative Imports.Report with actual session imports (minimized);
wenzelm
parents:
66841
diff
changeset
|
518 |
session import structure to what is actually required. |
66671 | 519 |
|
520 |
\<^medskip> |
|
521 |
Option \<^verbatim>\<open>-M\<close> checks imported theories against the Mercurial repositories of |
|
522 |
the underlying session directories; non-repository directories are ignored. |
|
523 |
This helps to find files that are accidentally ignored, e.g.\ due to |
|
524 |
rearrangements of the session structure. |
|
525 |
||
526 |
\<^medskip> |
|
527 |
Option \<^verbatim>\<open>-U\<close> updates theory imports with old-style directory specifications |
|
528 |
to canonical session-qualified theory names, according to the theory name |
|
529 |
space imported via \isakeyword{sessions} within the \<^verbatim>\<open>ROOT\<close> specification. |
|
530 |
||
531 |
Option \<^verbatim>\<open>-i\<close> modifies the meaning of option \<^verbatim>\<open>-U\<close> to proceed incrementally, |
|
532 |
following to the session graph structure in bottom-up order. This may |
|
533 |
lead to more accurate results in complex session hierarchies. |
|
534 |
\<close> |
|
535 |
||
536 |
subsubsection \<open>Examples\<close> |
|
537 |
||
538 |
text \<open> |
|
539 |
Determine potential session imports for some project directory: |
|
540 |
@{verbatim [display] \<open>isabelle imports -I -D 'some/where/My_Project'\<close>} |
|
541 |
||
542 |
\<^smallskip> |
|
543 |
Mercurial repository check for some project directory: |
|
544 |
@{verbatim [display] \<open>isabelle imports -M -D 'some/where/My_Project'\<close>} |
|
545 |
||
546 |
\<^smallskip> |
|
547 |
Incremental update of theory imports for some project directory: |
|
548 |
@{verbatim [display] \<open>isabelle imports -U -i -D 'some/where/My_Project'\<close>} |
|
549 |
\<close> |
|
550 |
||
68116 | 551 |
|
68152
619de043389f
guard result exports via export_pattern -- avoid bombing client via huge blobs;
wenzelm
parents:
68116
diff
changeset
|
552 |
section \<open>Retrieve theory exports \label{sec:tool-export}\<close> |
68116 | 553 |
|
554 |
text \<open> |
|
555 |
The @{tool_def "export"} tool retrieves theory exports from the session |
|
556 |
database. Its command-line usage is: @{verbatim [display] |
|
557 |
\<open>Usage: isabelle export [OPTIONS] SESSION |
|
558 |
||
559 |
Options are: |
|
560 |
-D DIR target directory for exported files (default: "export") |
|
561 |
-d DIR include session directory |
|
562 |
-l list exports |
|
563 |
-n no build of session |
|
564 |
-o OPTION override Isabelle system OPTION (via NAME=VAL or NAME) |
|
565 |
-s system build mode for session image |
|
566 |
-x PATTERN extract files matching pattern (e.g. "*:**" for all) |
|
567 |
||
568 |
List or export theory exports for SESSION: named blobs produced by |
|
68290 | 569 |
isabelle build. Option -l or -x is required; option -x may be repeated. |
68116 | 570 |
|
571 |
The PATTERN language resembles glob patterns in the shell, with ? and * |
|
572 |
(both excluding ":" and "/"), ** (excluding ":"), and [abc] or [^abc], |
|
573 |
and variants {pattern1,pattern2,pattern3}.\<close>} |
|
574 |
||
575 |
\<^medskip> |
|
576 |
The specified session is updated via @{tool build} |
|
577 |
(\secref{sec:tool-build}), with the same options \<^verbatim>\<open>-d\<close>, \<^verbatim>\<open>-o\<close>, \<^verbatim>\<open>-s\<close>. The |
|
578 |
option \<^verbatim>\<open>-n\<close> suppresses the implicit build process: it means that a |
|
579 |
potentially outdated session database is used! |
|
580 |
||
581 |
\<^medskip> |
|
582 |
Option \<^verbatim>\<open>-l\<close> lists all stored exports, with compound names |
|
583 |
\<open>theory\<close>\<^verbatim>\<open>:\<close>\<open>name\<close>. |
|
584 |
||
585 |
\<^medskip> |
|
586 |
Option \<^verbatim>\<open>-x\<close> extracts stored exports whose compound name matches the given |
|
587 |
pattern. Note that wild cards ``\<^verbatim>\<open>?\<close>'' and ``\<^verbatim>\<open>*\<close>'' do not match the |
|
588 |
separators ``\<^verbatim>\<open>:\<close>'' and ``\<^verbatim>\<open>/\<close>''; the wild card \<^verbatim>\<open>**\<close> matches over directory |
|
589 |
name hierarchies separated by ``\<^verbatim>\<open>/\<close>''. Thus the pattern ``\<^verbatim>\<open>*:**\<close>'' matches |
|
68290 | 590 |
\<^emph>\<open>all\<close> theory exports. Multiple options \<^verbatim>\<open>-x\<close> refer to the union of all |
591 |
specified patterns. |
|
68116 | 592 |
|
593 |
Option \<^verbatim>\<open>-D\<close> specifies an alternative base directory for option \<^verbatim>\<open>-x\<close>: the |
|
594 |
default is \<^verbatim>\<open>export\<close> within the current directory. Each theory creates its |
|
595 |
own sub-directory hierarchy, using the session-qualified theory name. |
|
596 |
\<close> |
|
597 |
||
48578 | 598 |
end |