Skip to content

Commit 3184ba5

Browse files
committed
[GR-69453] Update BuildOutput.md in reference-manual.
PullRequest: graal/22056
2 parents 655ee7e + e50ca64 commit 3184ba5

File tree

2 files changed

+18
-8
lines changed

2 files changed

+18
-8
lines changed

docs/reference-manual/native-image/BuildOutput.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ Below is the example output when building a native executable of the `HelloWorld
2323
================================================================================
2424
GraalVM Native Image: Generating 'helloworld' (executable)...
2525
================================================================================
26-
[1/8] Initializing... (5.1s @ 0.23GB)
26+
[1/8] Initializing... (2.0s @ 0.19GB)
2727
Builder configuration:
28-
- Java version: 26+12, vendor version: Oracle GraalVM 26-dev+12.1
28+
- Java version: 26+12, vendor version: GraalVM CE 26-dev+12.1
2929
- Graal compiler: optimization level: 2, target machine: x86-64-v3
30-
- C compiler: gcc (linux, x86_64, 13.3.0)
30+
- C compiler: gcc (linux, x86_64, 15.2.1)
3131
- Assertions: enabled, system assertions: enabled
3232
- 1 user-specific feature(s):
3333
- com.oracle.svm.thirdparty.gson.GsonFeature
@@ -116,6 +116,14 @@ On Oracle GraalVM, the line also shows information about [Profile-Guided Optimiz
116116
#### <a name="glossary-ccompiler"></a>C Compiler
117117
The C compiler executable, vendor, target architecture, and version info used by the Native Image build process.
118118

119+
#### <a name="glossary-builder-assertions"></a>Assertions in the Builder
120+
This shows whether Java assertions and system assertions are enabled for the Native Image Builder process.
121+
Enabling them can help the GraalVM team identify and debug problems in the Builder.
122+
123+
#### <a name="glossary-user-specific-features"></a>User-Specific Features
124+
All [`Features`](https://www.graalvm.org/sdk/javadoc/org/graalvm/nativeimage/hosted/Feature.html) that are provided or explicitly enabled by the user, or implicitly registered on the user's behalf (for example, by a framework).
125+
Internal features used by GraalVM Native Image are not included in this list.
126+
119127
#### <a name="glossary-gc"></a>Garbage Collector
120128
The garbage collector used within the generated executable:
121129
- The *Serial GC* is the default GC and optimized for low memory footprint and small Java heap sizes.
@@ -130,9 +138,9 @@ Use the `-Xmx` option when invoking your native executable (for example `./myapp
130138
This can also improve latency in some cases.
131139
Use the `-R:MaxHeapSize` option when building with Native Image to preconfigure the maximum heap size.
132140

133-
#### <a name="glossary-user-specific-features"></a>User-Specific Features
134-
All [`Features`](https://www.graalvm.org/sdk/javadoc/org/graalvm/nativeimage/hosted/Feature.html) that are either provided or specifically enabled by the user, or implicitly registered for the user, for example, by a framework.
135-
GraalVM Native Image deploys a number of internal features, which are excluded from this list.
141+
#### <a name="glossary-image-assertions"></a>Assertions in the Generated Image
142+
This shows whether Java assertions and system assertions are enabled in the generated image.
143+
Enabling them can help identifying and debugging problems in the Java code built into the image.
136144

137145
#### <a name="glossary-experimental-options"></a>Experimental Options
138146
A list of all active experimental options, including their origin and possible API option alternatives if available.

substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/ProgressReporter.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -265,15 +265,17 @@ public void printInitializeEnd(List<Feature> features, ImageClassLoader classLoa
265265
long maxHeapSize = SubstrateGCOptions.MaxHeapSize.getValue();
266266
String maxHeapValue = maxHeapSize == 0 ? Heap.getHeap().getGC().getDefaultMaxHeapSize() : ByteFormattingUtil.bytesToHuman(maxHeapSize);
267267

268-
l().a(" - ").a("Assertions: ").a(SubstrateUtil.assertionsEnabled() ? "enabled" : "disabled").a(", system assertions: ").a(getSystemAssertionStatus() ? "enabled" : "disabled")
268+
l().a(" - ").doclink("Assertions", "#glossary-builder-assertions").a(": ").a(SubstrateUtil.assertionsEnabled() ? "enabled" : "disabled").a(", system assertions: ")
269+
.a(getSystemAssertionStatus() ? "enabled" : "disabled")
269270
.println();
270271

271272
printFeatures(features);
272273

273274
// Image Configuration section
274275
l().a(" ").a("Image configuration:").println();
275276
l().a(" - ").doclink("Garbage collector", "#glossary-gc").a(": ").a(gcName).a(" (").doclink("max heap size", "#glossary-gc-max-heap-size").a(": ").a(maxHeapValue).a(")").println();
276-
l().a(" - ").a("Assertions: ").a(RuntimeAssertionsSupport.singleton().getDefaultAssertionStatus() ? "enabled" : "disabled").a(" (class-specific config may apply), system assertions: ")
277+
l().a(" - ").doclink("Assertions", "#glossary-image-assertions").a(": ").a(RuntimeAssertionsSupport.singleton().getDefaultAssertionStatus() ? "enabled" : "disabled")
278+
.a(" (class-specific config may apply), system assertions: ")
277279
.a(RuntimeAssertionsSupport.singleton().getDefaultSystemAssertionStatus() ? "enabled" : "disabled").println();
278280

279281
printExperimentalOptions(classLoader);

0 commit comments

Comments
 (0)