-
Notifications
You must be signed in to change notification settings - Fork 75
Glossary items #1593
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Glossary items #1593
Conversation
@pshipton - This is a trial for creation of a glossary for OpenJ9 by using AI. Could you please check whether the definitions are applicable to OpenJ9? If they are then I will continue adding glossary terms to this table in this same PR and submit them for your review. After we have a reasonable number of glossary terms, we can merge these changes and make it available to the users in batches in different releases. I will use this PR for adding terms and submitting them for your review till we are ready to merge. I will create a new PR for the next batch after that. Please let me know if this strategy is ok. Thanks! |
Looks reasonable to me. @amicic and @dmitripivkine should check the GC definitions. We need the AI attribution. |
f89afeb
to
d9161ac
Compare
Jenkins doc stage |
d9161ac
to
67e3322
Compare
Jenkins doc stage |
67e3322
to
ab5135b
Compare
Jenkins doc stage |
@pshipton @amicic @dmitripivkine - Could you please check the definitions and let me know if the definitions are ok from OpenJ9 perspective. Thanks! |
docs/glossaryterm.md
Outdated
| **Class Data Sharing (CDS)** | VM feature that shares class metadata between VM instances to reduce startup time and memory usage. | | ||
| **Classpath (`-classpath`)** | Specifies the search path for application classes and resources. | | ||
| **Compressed References** | A memory optimization technique that stores object references in 32-bit format on 64-bit systems to reduce memory footprint. | | ||
| **Condition Exception Handling** | Refers to the mechanisms provided by OpenJ9 for managing exceptions and error conditions during Java application execution. These mechanisms include APIs and tools for diagnosing and responding to runtime issues. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is this definition for?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure what you are asking. The definition is for Condition Exception Handling?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, where is Condition Exception Handling referred to?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is coming in the TOC only (under API Documentation -> Java 8 API). We can delete it from the Glossary if it is not required.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think the definition is correct, we should either delete it or get it right. The only reference to "Condition Exception Handling" is the link, which is probably not correctly named. The actual documentation is for z/OS Language Environment condition handling.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Then it is better that it is deleted.
docs/glossaryterm.md
Outdated
| **Classpath (`-classpath`)** | Specifies the search path for application classes and resources. | | ||
| **Compressed References** | A memory optimization technique that stores object references in 32-bit format on 64-bit systems to reduce memory footprint. | | ||
| **Condition Exception Handling** | Refers to the mechanisms provided by OpenJ9 for managing exceptions and error conditions during Java application execution. These mechanisms include APIs and tools for diagnosing and responding to runtime issues. | | ||
| **CRIU (Checkpoint/Restore In Userspace)** | Linux tool for checkpointing and restoring processes, which are used in OpenJ9. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is used in OpenJ9? are -> is
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"The processes, which are used in OpenJ9" not "the Linux tool which is used in....". I think it might be clearer if I change the sentence to "Linux tool for checkpointing and restoring processes that are used in OpenJ9."?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Linux tool for checkpointing and restoring processes that run using OpenJ9.
Jenkins doc stage |
docs/glossaryterm.md
Outdated
* | ||
* SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0 OR GPL-2.0-only WITH OpenJDK-assembly-exception-1.0 | ||
--> | ||
<!--Some sections generated by Copilot --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pls specify Microsoft Copilot
ab5135b
to
28970f0
Compare
Part 1 - 07 Oct 2025 OpenJ9 Glossary terms Co-authored by Microsoft Copilot Signed-off-by: Sreekala Gopakumar [email protected]
28970f0
to
4b9df5f
Compare
Jenkins doc stage |
Part 1 - 07 Oct 2025
OpenJ9 Glossary terms
Co-authored by Copilot
Signed-off-by: Sreekala Gopakumar [email protected]