Skip to content

Conversation

Sreekala-Gopakumar
Copy link
Contributor

@Sreekala-Gopakumar Sreekala-Gopakumar commented Sep 24, 2025

Part 1 - 07 Oct 2025

OpenJ9 Glossary terms

Co-authored by Copilot
Signed-off-by: Sreekala Gopakumar [email protected]

@Sreekala-Gopakumar Sreekala-Gopakumar self-assigned this Sep 24, 2025
@Sreekala-Gopakumar
Copy link
Contributor Author

Sreekala-Gopakumar commented Sep 24, 2025

@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!

@pshipton
Copy link
Member

pshipton commented Sep 24, 2025

Looks reasonable to me. @amicic and @dmitripivkine should check the GC definitions.

We need the AI attribution.
https://github.com/eclipse-openj9/openj9/blob/master/CONTRIBUTING.md#generative-artificial-intelligence-usage-guidelines
// Some sections generated by <YOUR AI ASSISTANT>
and in the commit
Co-authored by <YOUR AI ASSISTANT>

@Sreekala-Gopakumar
Copy link
Contributor Author

Jenkins doc stage

@Sreekala-Gopakumar
Copy link
Contributor Author

Jenkins doc stage

@Sreekala-Gopakumar
Copy link
Contributor Author

Jenkins doc stage

@Sreekala-Gopakumar
Copy link
Contributor Author

@pshipton @amicic @dmitripivkine - Could you please check the definitions and let me know if the definitions are ok from OpenJ9 perspective. Thanks!

| **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. |
Copy link
Member

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?

Copy link
Contributor Author

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?

Copy link
Member

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?

Copy link
Contributor Author

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.

Copy link
Member

@pshipton pshipton Oct 10, 2025

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.

Copy link
Contributor Author

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.

| **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. |
Copy link
Member

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

Copy link
Contributor Author

@Sreekala-Gopakumar Sreekala-Gopakumar Oct 10, 2025

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."?

Copy link
Member

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.

@pshipton
Copy link
Member

pshipton commented Oct 9, 2025

Jenkins doc stage

*
* 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 -->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pls specify Microsoft Copilot

Part 1 - 07 Oct 2025

OpenJ9 Glossary terms

Co-authored by Microsoft Copilot
Signed-off-by: Sreekala Gopakumar [email protected]
@Sreekala-Gopakumar
Copy link
Contributor Author

Jenkins doc stage

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants