apache / apache/bookkeeper

Docs: CLI docs are badly out of date

Open
#3,223 1 comment 0 reactions 0 assignees View on GitHub
type/bug
Dominant language
Java
Stars
2k
Forks
976
Avg merge
6d 15h
Merged PRs (30d)
7

Description

**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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.