Skip to content

Commit 92d1931

Browse files
committed
Fix screenshots and broken references in the Build Report reference documentation.
1 parent 547609a commit 92d1931

10 files changed

+6
-6
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: docs
3-
toc_group: build-report
3+
toc_group: build-overview
44
link_title: Build Report
55
permalink: /reference-manual/native-image/overview/build-report/
66
redirect_from: /reference-manual/native-image/build-report/
@@ -88,9 +88,9 @@ Each section is described in detail the following subsections.
8888

8989
The *Summary* section provides a general overview of the build.
9090
The section consists of four subsections that correspond to a stage in the build process or provide additional useful information:
91-
- [*Environment*](BuildOutput.md#a-namestage-initializingainitializing) provides the information about the environment used in the build (Java version, GraalVM version, Graal compiler configuration, and so on).
92-
- [*Analysis Results*](BuildOutput.md#a-namestage-analysisaperforming-analysis) displays the results of the points-to analysis (Types, Fields, and Methods) grouped by category (Reachable, Reflection, JNI, and Loaded).
93-
- [*Image Details*](BuildOutput.md#a-namestage-creatingacreating-image) gives an overview of the contents of the binary. The chart visualizes how different parts of the binary (Code area, Image heap, Debug info, and Other data) relate to each other in terms of their size.
91+
- [*Environment*](BuildOutput.md#stage-initializing) provides the information about the environment used in the build (Java version, GraalVM version, Graal compiler configuration, and so on).
92+
- [*Analysis Results*](BuildOutput.md#stage-analysis) displays the results of the points-to analysis (Types, Fields, and Methods) grouped by category (Reachable, Reflection, JNI, and Loaded).
93+
- [*Image Details*](BuildOutput.md#stage-creating) gives an overview of the contents of the binary. The chart visualizes how different parts of the binary (Code area, Image heap, Debug info, and Other data) relate to each other in terms of their size.
9494
- [*Security Report*](BuildOutput.md#security-report) reports various kinds of security-related information about the build (Deserialization, Embedded SBOM, and Backwards-Edge Control-Flow Integrity (CFI)).
9595
- [*Resource Usage*](BuildOutput.md#resource-usage-statistics) provides additional information about the resources used for the build (Garbage collection, Peak RSS, and CPU load) as well as total time spent generating the binary.
9696

@@ -154,7 +154,7 @@ Similarly, the reverse can be achieved by clicking ↑ (shown in the first ro
154154
155155
### Image Heap
156156

157-
The object heap of the binary is broken down and grouped by object type (similar to the [Image Heap](BuildOutput.md#a-nameglossary-image-heapaimage-heap) table in CLI Build Output).
157+
The object heap of the binary is broken down and grouped by object type (similar to the [Image Heap](BuildOutput.md#glossary-image-heap) table in CLI Build Output).
158158
The main difference is that Build Report shows a complete list of object types along with more detailed information such as their counts, sizes, and relative percentages (visualized in the form of progress bars).
159159

160160
One common use case for the full list is to determine if any instances of a specific class are a part of the image heap (using *Find in page*).

docs/reference-manual/native-image/guides/optimize-file-size.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Registering wrong or too many Java types for reflection can also increase the si
9696
Moreover, build-time initialization, if not used towards a specific goal, can cause large Java objects such as empty caches to be accidentally included in the image heap and, thus, cause bloat in a native executable.
9797

9898
Generally, it is a good idea to check file size, number of embedded resources, or other metrics from time to time, for example, when adding or updating dependencies, or even monitor build metrics frequently.
99-
For this, you can use the [machine-readable version of the build output](../overview/BuildOutput.md#machine-readable-build-output) or the [build reports for GitHub Actions](https://medium.com/graalvm/native-image-build-reports-and-update-notifications-351aca964a55){:target="_blank"}.
99+
For this, you can use the [machine-readable version of the build output](../BuildOutput.md#machine-readable-build-output) or the [build reports for GitHub Actions](https://medium.com/graalvm/native-image-build-reports-and-update-notifications-351aca964a55){:target="_blank"}.
100100

101101
There are other Native Image techniques that can positively affect the executable size, besides improving other metrics, for example, [Profile-Guided Optimizations (PGO)](optimize-native-executable-with-pgo.md).
102102

-1.39 KB
Loading
-1.21 KB
Loading
-1.92 KB
Loading
-772 Bytes
Loading
-13.5 KB
Loading
-1.56 KB
Loading
-24.6 KB
Loading
-36.8 KB
Loading

0 commit comments

Comments
 (0)