You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/command-line-options.adoc
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -77,9 +77,9 @@ These options decide the analyses to be executed and their behaviors. We divided
77
77
78
78
To execute an analysis, you need to specify its _id_ and _options_ (if necessary). All available analyses in Tai-e and their information (e.g., _id_ and available _options_) are listed in the analysis configuration file `src/main/resources/tai-e-analyses.yml`.
79
79
80
-
There are two mutually-exclusive approaches to specify the analyses, by command-line options or by file, as described below.
80
+
There are two mutually-exclusive approaches to specify the analyses, by command-line **options** or by **file**, as described below.
Specify analyses by command-line options. For running analysis with id `A`, just give `-a A`. For specifying some analysis options for `A`, just append them to analysis id (connected by `=`), and separate them by `;`, for example:
85
85
@@ -99,13 +99,13 @@ The option system is expressive, and it supports various types of option values,
99
99
100
100
Option `-a` is repeatable, so that if you need to execute multiple analyses in a single run of Tai-e, say `A1` and `A2`, just repeat `-a` like: `-a A1 -a A2`.
101
101
102
-
==== Plan file (-p, --plan-file): `-p <file-path>`
102
+
* Plan file (-p, --plan-file): `-p <file-path>`
103
103
104
104
Alternatively, you can specify the analyses to be executed (called an analysis plan) in a plan file, and use `-p` to process the file. Similar to `-a`, you need to specify the _id_ and _options_ (if necessary) for each analysis in the file. The plan file should be written in YAML.
105
105
106
106
Note that options `-a` and `-p` are mutually-exclusive, thus you _cannot_ specify them simultaneously. See <<analysis-management#analysis-management, Analysis Management>> for more information about these two options.
107
107
108
-
==== Keep results of specific analyses (-kr, --keep-result): `-kr <id>[,<id>...]`
108
+
* Keep results of specific analyses (-kr, --keep-result): `-kr <id>[,<id>...]`
109
109
110
110
By default, Tai-e keeps results of all executed analyses in memory. If you run multiple analyses and care about the results of only some of them, you could use this option to specify these analyses, then every time Tai-e executes an analysis, it will automatically detect and clean the analysis results which are not used by subsequent analyses to save memory.
111
111
@@ -125,7 +125,10 @@ By default, Tai-e keeps results of all executed analyses in memory. If you run m
125
125
126
126
* World cache mode (-wc, --world-cache-mode)
127
127
** Enable world cache mode to save build time by caching the completed built world to the disk.
128
-
** When enabled, it will attempt to load the cached world instead of rebuilding it from scratch, provided that the analyzed program (i.e. classPath, mainClass and so on) remain unchanged. This option is particularly useful during development, when the analyzed program remains the same, but the analyzer code is modified and run repeatedly, thus saving developers' valuable time.
128
+
** When enabled, it will attempt to load the cached world instead of rebuilding it from scratch, resulting in a substantial acceleration of world-building process. This applies as long as the analyzed program (i.e. classPath, mainClass and so on) remain unchanged. This option is particularly useful during analysis development, when the analyzed program remains the same, but the analyzer code is modified and run repeatedly, thus saving developers' valuable time.
** By default, Tai-e stores all outputs, such as logs, IR, and various analysis results, in the `output` folder within the current working directory. If you prefer to save outputs to a different directory, simply use this option.
0 commit comments