Skip to content

HDDS-14998. Use line.separator in option descriptions#10063

Open
adoroszlai wants to merge 1 commit intoapache:masterfrom
adoroszlai:HDDS-14998
Open

HDDS-14998. Use line.separator in option descriptions#10063
adoroszlai wants to merge 1 commit intoapache:masterfrom
adoroszlai:HDDS-14998

Conversation

@adoroszlai
Copy link
Copy Markdown
Contributor

What changes were proposed in this pull request?

Use platform-specific line separator in CLI command/option descriptions instead of hard-coded \n.

https://picocli.info/#_format_specifiers

https://issues.apache.org/jira/browse/HDDS-14998

How was this patch tested?

Verified help is formatted OK (same as before) for few commands:

$ ozone sh volume create --help
...
      <value>              URI of the volume.
                           Ozone URI could either be a full URI or short URI.
                           Full URI should start with o3://, in case of non-HA
                           clusters it should be followed by the host name and
                           optionally the port number. In case of HA clusters
                           the service id should be used. Service id provides a
                           logical name for multiple hosts and it is defined
                           in the property ozone.om.service.ids.
                           Example of a full URI with host name and port number
                           for a key:
                           o3://omhostname:9862/vol1/bucket1/key1
                           With a service id for a volume:
                           o3://omserviceid/vol1/
                           Short URI should start from the volume.
                           Example of a short URI for a bucket:
                           vol1/bucket1
                           Any unspecified information will be identified from
                           the config files.
...

$ ozone sh bucket setacl --help
...
  -a, -al, --acl, --acls=<values>[,<values>...]
                        Comma separated ACL list:
                        Example: user:user2:a OR user:user1:rw,group:hadoop:a
                        r = READ, w = WRITE, c = CREATE, d = DELETE, l = LIST,
                          a = ALL, n = NONE, x = READ_ACL, y = WRITE_ACL.
...

$ ozone debug auditparser --help
...
Commands:
  load, l      Load ozone audit log files.

               To load an audit log to database:
               ozone debug auditparser <path to db file> load <logs>

  template, t  Execute template query.

               To run a template query on the audit logs loaded to the database:
               ozone debug auditparser <path to db file> template <template>

               Following templates are available:
               (Template)              (Description)
               top5users              : Top 5 users.
               top5cmds               : Top 5 commands.
               top5activetimebyseconds: Top 5 active times, grouped by seconds.

  query, q     Execute custom query.

               To run a custom read-only query on the audit logs loaded to the
                 database:
               ozone debug auditparser <path to db file> query <query>

https://github.com/adoroszlai/ozone/actions/runs/24202134040

@adoroszlai adoroszlai self-assigned this Apr 9, 2026
@Russole
Copy link
Copy Markdown
Contributor

Russole commented Apr 11, 2026

Thanks @adoroszlai for working on this. LGTM!

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants