Skip to content

Removed references to the Update Tool in docs - #25655

Merged
OndroMih merged 6 commits into
eclipse-ee4j:masterfrom
Ariho-Seth:master
Aug 7, 2025
Merged

Removed references to the Update Tool in docs#25655
OndroMih merged 6 commits into
eclipse-ee4j:masterfrom
Ariho-Seth:master

Conversation

@Ariho-Seth

Copy link
Copy Markdown
Contributor

In this PR, the Update tool is removed from the docs since it doesn't exist in Eclipse GlassFish anymore.

Fixes #24304

Signed-off-by: Atwijukire Ariho Seth <120330466+Ariho-Seth@users.noreply.github.com>
@Ariho-Seth
Ariho-Seth marked this pull request as ready for review August 4, 2025 12:36
@Ariho-Seth

Copy link
Copy Markdown
Contributor Author

Hello @OndroMih, please review this PR and see if there's anything to adjust

Comment on lines 52 to 54
For information about how to create IPS packages, see the
http://wikis.oracle.com/display/IpsBestPractices/[IPS best practices
document] (`http://wikis.oracle.com/display/IpsBestPractices/`).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This can be removed too.

[--virtualservers virtual_servers]
[--contextroot context_root]
[--precompilejsp={false|true}]
[--verify={false|true}]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This can stay, see comment below.

Comment thread docs/reference-manual/src/main/asciidoc/deploy.adoc
[--force={false|true}]
[--virtualservers virtual_servers]
[--contextroot context_root]
[--verify={false|true}]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can stay, as per my other comment.

Comment thread docs/reference-manual/src/main/asciidoc/deploydir.adoc
during deployment. Instead, JSPs are compiled during runtime.
Default is false.

--verify

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can stay, as per my other comment - just remove the reference to the Update Tool

[--generatermistubs={false|true}]
[--contextroot context_root]
[--precompilejsp={true|false}]
[--verify={false|true}]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can stay, as per my other comment

during deployment. Instead, JSPs are compiled during runtime.
Default is false.

--verify

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can stay, as per my other comment - just remove the reference to the Update Tool

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Sure thing, I've added the suggested changes, Please peruse through and see .

Signed-off-by: Atwijukire Ariho Seth <120330466+Ariho-Seth@users.noreply.github.com>
Comment on lines +91 to +94
`--verify`::
If set to true and the required verifier packages are installed from
the Update Tool, the syntax and semantics of the deployment descriptor
is verified. Default is `false`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Please revert the indentation (remove the additional spaces in the beginnings of lines)

Comment on lines +105 to +108
`--verify`::
If set to true and the required verifier packages are installed from
the Update Tool, the syntax and semantics of the deployment descriptor
is verified. Default is `false`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Please revert the indentation (remove the additional spaces in the beginnings of lines)

Comment on lines +78 to +81
`--verify`::
If set to true and the required verifier packages are installed from
the Update Tool, the syntax and semantics of the deployment descriptor
is verified. Default is `false`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Please revert the indentation (remove the additional spaces in the beginnings of lines)

@OndroMih OndroMih left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

All looks good in the final PDFs, just remove the unnecessry indentation to keep things aligned in the source.

Signed-off-by: Atwijukire Ariho Seth <120330466+Ariho-Seth@users.noreply.github.com>
@Ariho-Seth

Copy link
Copy Markdown
Contributor Author

All looks good in the final PDFs, just remove the unnecessry indentation to keep things aligned in the source.

Sorry about that negligence :), but I hope now all is good.

@OndroMih

OndroMih commented Aug 4, 2025

Copy link
Copy Markdown
Contributor

I'm a bit pedantic :)

Now I noticed that you put back mentions of Update Tool in the documentation of the --verify option:

 If set to true and the required verifier packages are installed from
  the Update Tool, the syntax and semantics of the deployment descriptor
  is verified. Default is `false`.

Can you remove Update Tool everywhere, so that it reads something like:

 If set to true and the required verifier packages are installed,
  the syntax and semantics of the deployment descriptor
  is verified. Default is `false`.

Signed-off-by: Atwijukire Ariho Seth <120330466+Ariho-Seth@users.noreply.github.com>
@Ariho-Seth

Copy link
Copy Markdown
Contributor Author

I'm a bit pedantic :)

Now I noticed that you put back mentions of Update Tool in the documentation of the --verify option:

 If set to true and the required verifier packages are installed from
  the Update Tool, the syntax and semantics of the deployment descriptor
  is verified. Default is `false`.

Can you remove Update Tool everywhere, so that it reads something like:

 If set to true and the required verifier packages are installed,
  the syntax and semantics of the deployment descriptor
  is verified. Default is `false`.

"Pediatric!", I think it's fine to choose quality,
I've fixed the --verify option too. I'm ready to make any more adjustments for quality

@OndroMih OndroMih left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think you missed to remove mention of Update Tool in deploy.1, deploydir.1 and redeploy.1 files.

There are still some references to the Update Tool in the upgrade guide, but I think we can leave them there. The upgrade guide should be completely updated, I raised an issue for that: #25656

@@ -95,7 +95,6 @@ OPTIONS
If set to true and the required verifier packages are installed
from the Update Tool, the syntax and semantics of the deployment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

One more reference to Update Tool to remove :)

@OndroMih

OndroMih commented Aug 4, 2025

Copy link
Copy Markdown
Contributor

I would also remove mentions of the Update Tool in the FAQ. The documentation is for the current GlassFish version, not for legacy versions. And the Update Tool is not available anymore. Not even for old GlassFish versions, because the update service is not available anymore. The Update Tool may be there it it wouldn't be able to download and install modules.

We still have documentation for GlassFish 5, which is available here: https://glassfish.org/docs/#5.1.0. This documentation contains info about the Update Tool and we're not going to remove it from there.

Signed-off-by: Atwijukire Ariho Seth <120330466+Ariho-Seth@users.noreply.github.com>
@Ariho-Seth

Copy link
Copy Markdown
Contributor Author

I've also removed its references from the FAQs too

@OndroMih

OndroMih commented Aug 4, 2025

Copy link
Copy Markdown
Contributor

Perfect. One last thing - can you remove references to Update Tool also in deploy.1 and redeploy.1 files?

Signed-off-by: Atwijukire Ariho Seth <120330466+Ariho-Seth@users.noreply.github.com>
@Ariho-Seth

Copy link
Copy Markdown
Contributor Author

Perfect. One last thing - can you remove references to Update Tool also in deploy.1 and redeploy.1 files?

Hello @OndroMih, are there changes we need to add in here?

@Ariho-Seth
Ariho-Seth requested a review from OndroMih August 7, 2025 11:18
@OndroMih
OndroMih merged commit ab63848 into eclipse-ee4j:master Aug 7, 2025
2 checks passed
@OndroMih

OndroMih commented Aug 7, 2025

Copy link
Copy Markdown
Contributor

All good now, thanks @Ariho-Seth !

@Ariho-Seth

Copy link
Copy Markdown
Contributor Author

Welcome @OndroMih, Thanks for your unwavering efforts to improve me too.

bvfalcon pushed a commit to bvfalcon/eclipse-glassfish that referenced this pull request Apr 25, 2026
Removed references to the Update Tool in docs
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.

Documentation: Remove references to Update Tool in the documentation guides

2 participants