Use readable names for cluster channel/map options in documentation AND sample configurations #929
+84
−7
Conversation
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
markt-asf
added a commit
that referenced
this pull request
Jan 7, 2026
Documents the human-readable versions of the options. Also notes which ones are NO-OPs. https://bz.apache.org/bugzilla/show_bug.cgi?id=62814 Based on PR #929 by archan0621
Contributor
|
Thanks for the PR. I used it as the basis of a fix I applied manually as there were a couple of additional points that may not have been immediately obvious:
|
markt-asf
added a commit
that referenced
this pull request
Jan 7, 2026
Documents the human-readable versions of the options. Also notes which ones are NO-OPs. https://bz.apache.org/bugzilla/show_bug.cgi?id=62814 Based on PR #929 by archan0621
markt-asf
added a commit
that referenced
this pull request
Jan 7, 2026
Documents the human-readable versions of the options. Also notes which ones are NO-OPs. https://bz.apache.org/bugzilla/show_bug.cgi?id=62814 Based on PR #929 by archan0621
markt-asf
added a commit
that referenced
this pull request
Jan 7, 2026
Documents the human-readable versions of the options. Also notes which ones are NO-OPs. https://bz.apache.org/bugzilla/show_bug.cgi?id=62814 Based on PR #929 by archan0621
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.
Fix 62814: Use readable names for cluster channel/map options in documentation AND sample configurations
This patch updates several clustering documentation files to clarify that
both channelSendOptions and mapSendOptions accept human-readable option
names in addition to the existing integer bitmask values.
Tomcat already supports readable names (e.g., "async", "sync,use_ack"),
but the current documentation focuses primarily on numeric flags and
does not explicitly mention that mapSendOptions also supports the same
syntax. This can lead to confusion when configuring BackupManager or
interpreting sample configurations.
Changes included:
references to readable option names. Improved consistency with the
configuration reference.
to document readable names and clarify default behavior.
updated clustering documentation.
No functional code changes are included in this patch. This is a
documentation update only.
Please let me know if further adjustments or additional examples are
desired. I am happy to iterate on the patch.