[#1136] Remove the unused DocBook xinclude supplements from the server tool messages - #1141
Merged
vharseko merged 1 commit intoOct 1, 2026
Conversation
…ments from the server tool messages SUPPLEMENT_DESCRIPTION_PSEARCH_INFO_20002 and SUPPLEMENT_DESCRIPTION_CONTROLS_20003 in tool.properties still carried DocBook <xinclude:include> values, but nothing references them: ldapsearch and the common controls argument take their supplements from ToolsMessages and CliMessages, which already hold the AsciiDoc include:: form. Remove the two messages so that wiring one of them to a server tool cannot bring the OpenIdentityPlatform#1128 leftover back. Fixes OpenIdentityPlatform#1136
maximthomas
approved these changes
Oct 1, 2026
maximthomas
left a comment
maximthomas
left a comment
Contributor
There was a problem hiding this comment.
praise: The change deletes exactly the two dead keys and nothing else.
SUPPLEMENT_DESCRIPTION_PSEARCH_INFO_20002andSUPPLEMENT_DESCRIPTION_CONTROLS_20003have no reader at the head: a repo-widegit grepfinds those key names only inopendj-ldap-toolkit/.../tools.properties:399andopendj-cli/.../cli.properties:461, whichLDAPSearch.java:292andCommonArguments.java:173read through their own modules' message classes.- The conflict note is accurate:
git merge-treeagainst #1132's head gives a single hunk attool.properties:2616, and keeping only #1132'sSUPPLEMENT_DESCRIPTION_UPGRADE_CLI_20004=include::./_description-upgrade.adoc[]line resolves it.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #1136
Problem
After #1132, two DocBook
xincludevalues remain in the server tool messages (tool.properties):Nothing references
ToolMessages.SUPPLEMENT_DESCRIPTION_PSEARCH_INFOorToolMessages.SUPPLEMENT_DESCRIPTION_CONTROLS.LDAPSearchtakes its supplement fromToolsMessages(tools.properties), andCommonArgumentstakes its supplement fromCliMessages(cli.properties). Both of those copies already use the AsciiDocinclude::./_….adoc[]form. No localizedtool_*.propertiescarries either key.Change
Remove the two messages. Converting them to
include::instead would keep dead code. If one of them were later wired to a server tool, the #1128 leftover would come back. The# Supplements …comment stays, because 20004 and 20016 still follow it.Verification
mvn -o -pl "opendj-server-legacy,!opendj-maven-plugin" -am test-compile: BUILD SUCCESS (main and test sources).ToolMessages.class, the only remainingSUPPLEMENT_DESCRIPTION_*constants areUPGRADE_CLIandBACKEND_TOOL_SUBCMD_LIST_INDEX_STATUS.Note
#1132 changes the adjacent line (
SUPPLEMENT_DESCRIPTION_UPGRADE_CLI_20004), so the second of the two PRs to merge gets a trivial textual conflict. To resolve it, keep only the new 20004 line from #1132.