apple / apple/foundationdb

Help text for fdbcli suspend command is unclear

Open
#6,156 0 comments 0 reactions 1 assignee Claimed by @sfc-gh-etschannen View on GitHub
Dominant language
C++
Stars
16.7k
Forks
1.6k
Avg merge
1d 20h
Merged PRs (30d)
126

Description

The help text for the suspend command in fdbcli does not really describe what it means to suspend a process. It also says:

```
For each IP:port pair in , attempt to suspend the processes for the
specified SECONDS after which the process will die.
```

This I think is exposing the implementation details in a somewhat confusing way. The `SECONDS` parameter is meant to determine how long the process will be suspended, and possibly killing the process is how we actually unsuspend it, but this assumes some knowledge of what's happening under the hood that isn't explained else where in this text.

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.