bookkeeper icon indicating copy to clipboard operation
bookkeeper copied to clipboard

Docs: CLI docs are badly out of date

Open dlg99 opened this issue 3 years ago • 1 comments

BUG REPORT

Multiple utilities have new options added, these do not show up in the documentation on the web site.

Docs: https://bookkeeper.apache.org/docs/reference/cli#bookkeeper-shell-listunderreplicated

-missingreplica N | Bookie Id of missing replica
-excludingmissingreplica N | Bookie Id of missing replica to ignore
-printmissingreplica | Whether to print missingreplicas list?

Code:

        public ListUnderreplicatedCmd() {
            super(CMD_LISTUNDERREPLICATED);
            opts.addOption("missingreplica", true, "Bookie Id of missing replica");
            opts.addOption("excludingmissingreplica", true, "Bookie Id of missing replica to ignore");
            opts.addOption("printmissingreplica", false, "Whether to print missingreplicas list?");
            opts.addOption("printreplicationworkerid", false, "Whether to print replicationworkerid?");
        }

and

    public static class LURFlags extends CliFlags{

        @Parameter(names = { "-pmr", "--printmissingreplica" }, description = "Whether to print missingreplicas list?")
        private boolean printMissingReplica;

        @Parameter(names = { "-prw",
            "--printreplicationworkerid" }, description = "Whether wo print replicationworkerid?")
        private boolean printReplicationWorkerId;

        @Parameter(names = { "-mr", "--missingreplica" }, description = "Bookie Id of missing replica")
        private String missingReplica = DEFAULT;

        @Parameter(names = { "-emr", "--excludingmissingreplica" }, description = "Bookie Id of missing replica to "
                                                                                  + "ignore")
        private String excludingMissingReplica = DEFAULT;

        @Parameter(names =  {"-l", "--ledgeridformatter"}, description = "Set ledger id formatter")
        private String ledgerIdFormatter = DEFAULT;
    }

Similarly with other CLI commands

dlg99 avatar Apr 19 '22 19:04 dlg99

How about generation these docs by code?

hezhangjian avatar Jun 10 '24 23:06 hezhangjian