Skip to content

[Doc] Broker JVM options in docs/cn/Configuration_System.md are syntactically invalid (missing ":" after -XX) #11278

Description

@chennaji9

Description

The JVM options listed in docs/cn/Configuration_System.md (Section 1, broker JVM parameters) are syntactically invalid and cannot be used to start a JVM.

Examples of the broken text currently in the page:

-XXMaxDirectMemorySize=15g
-XX+AlwaysPreTouch
-XX-UseBiasedLocking
-XX+UseG1GC -XXG1HeapRegionSize=16m
-XXG1ReservePercent=25
-XXInitiatingHeapOccupancyPercent=30
-XX+UseGCLogFileRotation
-XXNumberOfGCLogFiles=5
-XXGCLogFileSize=30m
-Xloggcdevshmmq_gc_%p.log123

All -XX options are missing the colon after -XX (e.g. it must be -XX:MaxDirectMemorySize=15g, -XX:+AlwaysPreTouch), and the -Xloggc example lost its colon and path separators.

Verification: java -XXMaxDirectMemorySize=15g -version fails with Unrecognized option: -XXMaxDirectMemorySize=15g and exit code 1.

The correct spellings already exist in docs/en/Configuration_System.md (e.g. -XX:MaxDirectMemorySize=15g, -XX:+AlwaysPreTouch) and in distribution/bin/runbroker.sh (-XX:+AlwaysPreTouch, -XX:MaxDirectMemorySize=15g). It looks like the Chinese page was translated/mangled at some point and the colons were dropped.

Expected behavior

A user copying the JVM options from the Chinese system-configuration doc should get options that a JVM accepts, matching the English page and runbroker.sh. Today every copy-pasted option in that section fails with Unrecognized option, which is particularly unfriendly for Chinese-speaking users following the official doc.

No activity

Activity on this issue will appear here.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions