apple / apple/foundationdb

Exclude help message is misleading

Open
#6,341 1 comment 0 reactions 0 assignees View on GitHub
operations
Dominant language
C++
Stars
16.7k
Forks
1.6k
Avg merge
1d 20h
Merged PRs (30d)
126

Description

I think the `exclude` help message is a little bit confusing:

```
fdb> exclude
...
To find out whether it is safe to remove one or more of these
servers from the cluster, type `exclude '.
To return one of these servers to the cluster, type `include '.
```

The message could be interpreted that it's harmless to run `exclude ` but in fact this will exclude the addresses if those are not already excluded. I think we should add a warning above this command, that this will exclude those addresses if they are not already excluded.

Contributor guide

Open the contributing guide

Research direction

Search the fdb CLI sources for the `exclude` help text shown in the issue. Add a warning explaining that `exclude ` performs the exclusion when the addresses are not already excluded, then verify the interactive help output.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
cli, databases, distributed-systems
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.