Skip to content

Commit b7b835e

Browse files
author
Sonia Mathew
committed
Generated HTML for Release 3.0.0
1 parent 63ef904 commit b7b835e

159 files changed

Lines changed: 9898 additions & 1628 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/404.html

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -348,6 +348,8 @@
348348

349349

350350

351+
352+
351353

352354

353355

@@ -1126,6 +1128,70 @@
11261128

11271129

11281130

1131+
1132+
<li class="md-nav__item md-nav__item--nested">
1133+
1134+
1135+
1136+
1137+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_12" >
1138+
1139+
1140+
1141+
1142+
1143+
1144+
1145+
1146+
1147+
1148+
1149+
1150+
1151+
<div class="md-nav__link md-nav__link--index ">
1152+
<a href="/code-realtime/learning/">Learning</a>
1153+
1154+
<label for="__nav_2_12">
1155+
<span class="md-nav__icon md-icon"></span>
1156+
</label>
1157+
1158+
</div>
1159+
1160+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_12_label" aria-expanded="false">
1161+
<label class="md-nav__title" for="__nav_2_12">
1162+
<span class="md-nav__icon md-icon"></span>
1163+
Learning
1164+
</label>
1165+
<ul class="md-nav__list" data-md-scrollfix>
1166+
1167+
1168+
1169+
1170+
1171+
1172+
1173+
1174+
<li class="md-nav__item">
1175+
<a href="/code-realtime/learning/art-tutorial/" class="md-nav__link">
1176+
Art Tutorial
1177+
</a>
1178+
</li>
1179+
1180+
1181+
1182+
1183+
</ul>
1184+
</nav>
1185+
</li>
1186+
1187+
1188+
1189+
1190+
1191+
1192+
1193+
1194+
11291195
<li class="md-nav__item">
11301196
<a href="/code-realtime/contributing/" class="md-nav__link">
11311197
Contributing

docs/art-lang/cpp-extensions/index.html

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -363,6 +363,8 @@
363363

364364

365365

366+
367+
366368

367369

368370

@@ -1241,6 +1243,70 @@
12411243

12421244

12431245

1246+
1247+
<li class="md-nav__item md-nav__item--nested">
1248+
1249+
1250+
1251+
1252+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_12" >
1253+
1254+
1255+
1256+
1257+
1258+
1259+
1260+
1261+
1262+
1263+
1264+
1265+
1266+
<div class="md-nav__link md-nav__link--index ">
1267+
<a href="../../learning/">Learning</a>
1268+
1269+
<label for="__nav_2_12">
1270+
<span class="md-nav__icon md-icon"></span>
1271+
</label>
1272+
1273+
</div>
1274+
1275+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_12_label" aria-expanded="false">
1276+
<label class="md-nav__title" for="__nav_2_12">
1277+
<span class="md-nav__icon md-icon"></span>
1278+
Learning
1279+
</label>
1280+
<ul class="md-nav__list" data-md-scrollfix>
1281+
1282+
1283+
1284+
1285+
1286+
1287+
1288+
1289+
<li class="md-nav__item">
1290+
<a href="../../learning/art-tutorial/" class="md-nav__link">
1291+
Art Tutorial
1292+
</a>
1293+
</li>
1294+
1295+
1296+
1297+
1298+
</ul>
1299+
</nav>
1300+
</li>
1301+
1302+
1303+
1304+
1305+
1306+
1307+
1308+
1309+
12441310
<li class="md-nav__item">
12451311
<a href="../../contributing/" class="md-nav__link">
12461312
Contributing

docs/art-lang/index.html

Lines changed: 175 additions & 68 deletions
Large diffs are not rendered by default.

docs/building/art-compiler/index.html

Lines changed: 97 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -363,6 +363,8 @@
363363

364364

365365

366+
367+
366368

367369

368370

@@ -981,6 +983,13 @@
981983
buildVariants
982984
</a>
983985

986+
</li>
987+
988+
<li class="md-nav__item">
989+
<a href="#clean" class="md-nav__link">
990+
clean
991+
</a>
992+
984993
</li>
985994

986995
<li class="md-nav__item">
@@ -1277,6 +1286,70 @@
12771286

12781287

12791288

1289+
1290+
<li class="md-nav__item md-nav__item--nested">
1291+
1292+
1293+
1294+
1295+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_12" >
1296+
1297+
1298+
1299+
1300+
1301+
1302+
1303+
1304+
1305+
1306+
1307+
1308+
1309+
<div class="md-nav__link md-nav__link--index ">
1310+
<a href="../../learning/">Learning</a>
1311+
1312+
<label for="__nav_2_12">
1313+
<span class="md-nav__icon md-icon"></span>
1314+
</label>
1315+
1316+
</div>
1317+
1318+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_12_label" aria-expanded="false">
1319+
<label class="md-nav__title" for="__nav_2_12">
1320+
<span class="md-nav__icon md-icon"></span>
1321+
Learning
1322+
</label>
1323+
<ul class="md-nav__list" data-md-scrollfix>
1324+
1325+
1326+
1327+
1328+
1329+
1330+
1331+
1332+
<li class="md-nav__item">
1333+
<a href="../../learning/art-tutorial/" class="md-nav__link">
1334+
Art Tutorial
1335+
</a>
1336+
</li>
1337+
1338+
1339+
1340+
1341+
</ul>
1342+
</nav>
1343+
</li>
1344+
1345+
1346+
1347+
1348+
1349+
1350+
1351+
1352+
12801353
<li class="md-nav__item">
12811354
<a href="../../contributing/" class="md-nav__link">
12821355
Contributing
@@ -1388,6 +1461,13 @@
13881461
buildVariants
13891462
</a>
13901463

1464+
</li>
1465+
1466+
<li class="md-nav__item">
1467+
<a href="#clean" class="md-nav__link">
1468+
clean
1469+
</a>
1470+
13911471
</li>
13921472

13931473
<li class="md-nav__item">
@@ -1498,18 +1578,18 @@ <h2 id="location-and-launching">Location and Launching</h2>
14981578
</code></pre>
14991579
<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 <a href="../../settings/#jvm-args"><code>code-rt.languageServer.jvmArgs</code></a>), but it's not required to do so.</p>
15001580
<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>
1501-
<pre><code>C:\openjdk-17\bin\java -jar c:\Users\MATTIAS.MOHLIN\testarea\install\VSCode\data\extensions\secure-dev-ops.code-realtime-ce-1.0.0\bin\artcompiler.jar
1502-
10:24:53 : INFO : Art Compiler 1.0.0-20231212_1212
1503-
10:24:53 : INFO : Copyright (C) HCL Technologies Ltd. 2022, 2023.
1504-
10:24:54 : INFO : Arguments:
1581+
<pre><code>C:\Users\MATTIAS.MOHLIN\testarea\install\VSCode\data\extensions\secure-dev-ops.code-realtime-ce-3.0.0\bin&gt; java -jar artcompiler.jar
1582+
15:08:40 : INFO : Art Compiler 3.0.0-20250909_1223
1583+
15:08:40 : INFO : Copyright (C) HCL Technologies Ltd. 2022, 2025.
1584+
15:08:40 : INFO : Arguments:
15051585
Usage: java -jar artcompiler.jar &lt;options&gt;
15061586
Options:
15071587
LIST OF OPTIONS
15081588

15091589
All options with argument can be used in format &lt;option&gt; &lt;argument&gt; or &lt;option&gt;=&lt;argument&gt;.
15101590
</code></pre>
15111591
<h2 id="art-compiler-options">Art Compiler Options</h2>
1512-
<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>
15131593
<pre><code>&lt;option&gt; &lt;argument&gt;
15141594
</code></pre>
15151595
<p>or like this</p>
@@ -1535,6 +1615,10 @@ <h2 id="art-compiler-options">Art Compiler Options</h2>
15351615
<td align="left">Path</td>
15361616
</tr>
15371617
<tr>
1618+
<td><a href="#clean">clean</a></td>
1619+
<td align="left">N/A</td>
1620+
</tr>
1621+
<tr>
15381622
<td><a href="#cwd">cwd</a></td>
15391623
<td align="left">Path</td>
15401624
</tr>
@@ -1572,6 +1656,12 @@ <h3 id="buildconfig">buildConfig</h3>
15721656
<p>A build configuration is useful when you want to build a TC that uses <a href="../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 <a href="../build-variants/#build-configuration">here</a>.</p>
15731657
<h3 id="buildvariants">buildVariants</h3>
15741658
<p>Specifies a Build Variants script to use for the build. Read more about build variants <a href="../build-variants/">here</a>. </p>
1659+
<h3 id="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 <a href="../build-variants/">Build Variants</a> and have changed the <a href="../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+
<div class="admonition note">
1662+
<p class="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>
15751665
<h3 id="cwd">cwd</h3>
15761666
<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 <a href="#out">--out</a> or <a href="#tc">--tc</a>, the path will be resolved against the current working directory. </p>
15771667
<h3 id="generate">generate</h3>
@@ -1580,6 +1670,8 @@ <h3 id="help">help</h3>
15801670
<p>Use this option to print information about the <a href="#version">version</a> and all available <a href="#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>
15811671
<h3 id="out">out</h3>
15821672
<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 <a href="#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 <a href="../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>
15831675
<h3 id="ruleconfig">ruleConfig</h3>
15841676
<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 <a href="../../art-lang/#rule_config"><code>rule_config</code></a> property in an Art file. For example:</p>
15851677
<pre><code>--ruleConfig &quot;W0009,X7001&quot;

0 commit comments

Comments
 (0)