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
@@ -1498,18 +1578,18 @@ <h2 id="location-and-launching">Location and Launching</h2>
1498
1578
</code></pre>
1499
1579
<p>Often you don't need to use any JVM option, but if the application is huge you may need to increase the memory of the JVM. Refer to the documentation of your JVM for a list of available JVM options. You may want to use the same JVM options as are used when launching the Art Language Server (see the setting <ahref="../../settings/#jvm-args"><code>code-rt.languageServer.jvmArgs</code></a>), but it's not required to do so.</p>
1500
1580
<p>To test that the Art Compiler can be successfully launched you can try to invoke it without any arguments. You should see an output similar to the below:</p>
<p>The Art Compiler accepts options in the form of command-line arguments to <code>artcompiler.jar</code> that start with single or double dash (<code>-</code> or <code>--</code>). Many options can take an argument which then needs to be of the correct type (Boolean, Path etc). You can specify the argument for an option either like this</p>
1592
+
<p>The Art Compiler accepts options in the form of command-line arguments to <code>artcompiler.jar</code> that start with single or double dash (<code>-</code> or <code>--</code>). Many options can take an argument which then needs to be of the correct type (String, Path etc). You can specify the argument for an option either like this</p>
<p>A build configuration is useful when you want to build a TC that uses <ahref="../build-variants/">build variants</a>. It provides values for build variant settings and hence specifies a certain variant of the application to be built. Read more about build configurations <ahref="../build-variants/#build-configuration">here</a>.</p>
1573
1657
<h3id="buildvariants">buildVariants</h3>
1574
1658
<p>Specifies a Build Variants script to use for the build. Read more about build variants <ahref="../build-variants/">here</a>. </p>
1659
+
<h3id="clean">clean</h3>
1660
+
<p>If this option is set, the Art Compiler will perform a clean build by first removing the output folder if it already exists (as a result of a previous build). Clean builds take longer to perform since all C++ files have to be regenerated and recompiled. Normally you don't need to do a clean build, but in some cases it may be necessary. For example, if you are using <ahref="../build-variants/">Build Variants</a> and have changed the <ahref="../build-variants/#build-configuration">build configuration</a>, then a clean build is recommended to ensure that all changes are picked up by the build. If you do a clean build, but the output folder for some reason cannot be deleted, then the build will fail. A typical situation when this happens is when the built executable is running because you forgot to terminate it. If the executable is running it cannot be deleted, and hence the output folder also cannot be deleted.</p>
1661
+
<divclass="admonition note">
1662
+
<pclass="admonition-title">Note</p>
1663
+
<p>If you only want to remove binaries produced by make, and not the generated source files, you can instead run <code>make clean</code>. This makes the subsequent build slightly faster since not all C++ files need to be regenerated.</p>
1664
+
</div>
1575
1665
<h3id="cwd">cwd</h3>
1576
1666
<p>Set the current working directory. By default this is the location from which you launch the Art Compiler. If you use a relative path in options that take a path as argument, such as <ahref="#out">--out</a> or <ahref="#tc">--tc</a>, the path will be resolved against the current working directory. </p>
1577
1667
<h3id="generate">generate</h3>
@@ -1580,6 +1670,8 @@ <h3 id="help">help</h3>
1580
1670
<p>Use this option to print information about the <ahref="#version">version</a> and all available <ahref="#art-compiler-options">options</a>. This is the same information as is printed if launching the Art Compiler without any options. If this option is passed, all other options are ignored.</p>
1581
1671
<h3id="out">out</h3>
1582
1672
<p>Set the output folder which controls where generated files will be placed. By default it is set to the folder that contains the folder containing the built <ahref="#tc">TC</a>. It hence by default corresponds to the workspace folder used when building from the UI. If you want to place generated files in a different location when building from the command-line you can set this option to another folder. Relative paths specified as <ahref="../transformation-configurations/#targetfolder">targetFolder</a> in TCs will be resolved against the specified <code>--out</code> folder.</p>
1673
+
<pre><code>--out C:\temp\artcompiler_output
1674
+
</code></pre>
1583
1675
<h3id="ruleconfig">ruleConfig</h3>
1584
1676
<p>Specifies which validation rules that should be enabled, and what severity the problems they find should have. Rules are configured using the same syntax as is used for the <ahref="../../art-lang/#rule_config"><code>rule_config</code></a> property in an Art file. For example:</p>
0 commit comments