Skip to content

Commit b99ab9c

Browse files
committed
[GR-45420] Update the documentation to explain the PGO mode
PullRequest: graal/14303
2 parents a70163a + 8388a2b commit b99ab9c

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,10 @@ Use `-Ob` to enable quick build mode, which speeds up the [compilation stage](#s
9191
The targeted machine type can be selected with the `-march` option and defaults to `x86-64-v3` on AMD64 and `armv8-a` on AArch64.
9292
See [here](#recommendation-cpu) for recommendations on how to use this option.
9393
94-
On Oracle GraalVM, the line also shows whether [Profile-Guided Optimizations](#recommendation-pgo) are *on* or *off*.
94+
On Oracle GraalVM, the line also shows information about [Profile-Guided Optimizations (PGO)](#recommendation-pgo).
95+
- `off`: PGO is not used
96+
- `user-provided`: PGO is enabled and uses a user-provided profile
97+
- `ML-inferred`: A machine learning (ML) model is used to infer profiles for control split branches statically.
9598
9699
#### <a name="glossary-ccompiler"></a>C Compiler
97100
The C compiler executable, vendor, target architecture, and version info used by the Native Image build process.

docs/reference-manual/native-image/assets/build-output-schema-v0.9.1.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@
6161
"title": "The marchine type targeted by Graal"
6262
},
6363
"pgo": {
64-
"type": "boolean",
65-
"default": "",
66-
"title": "Whether Profile-Guided Optimizations are enabled or not (Oracle GraalVM only)"
64+
"type": ["string", "null"],
65+
"default": null,
66+
"title": "The name of the PGO mode (or null if PGO is not used) (Oracle GraalVM only)"
6767
}
6868
},
6969
"title": "Information about the Graal compiler"

0 commit comments

Comments
 (0)