Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: CLI docs are badly out of date #3223

Open
dlg99 opened this issue Apr 19, 2022 · 1 comment
Open

Docs: CLI docs are badly out of date #3223

dlg99 opened this issue Apr 19, 2022 · 1 comment
Labels

Comments

@dlg99
Copy link
Contributor

dlg99 commented Apr 19, 2022

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 dlg99 added the type/bug label Apr 19, 2022
@hezhangjian
Copy link
Member

How about generation these docs by code?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants