diff --git a/.changelog/10917.txt b/.changelog/10917.txt new file mode 100644 index 000000000..ea4cbf286 --- /dev/null +++ b/.changelog/10917.txt @@ -0,0 +1,3 @@ +```release-note:bug +cli: Fixed the help message for the `nomad alloc signal` command +``` diff --git a/command/alloc_signal.go b/command/alloc_signal.go index 8e083d4a9..70b949912 100644 --- a/command/alloc_signal.go +++ b/command/alloc_signal.go @@ -15,9 +15,9 @@ type AllocSignalCommand struct { func (a *AllocSignalCommand) Help() string { helpText := ` -Usage: nomad alloc signal [options] +Usage: nomad alloc signal [options] - signal an existing allocation. This command is used to signal a specific alloc + Signal an existing allocation. This command is used to signal a specific alloc and its subtasks. If no task is provided then all of the allocations subtasks will receive the signal. @@ -32,11 +32,11 @@ General Options: Signal Specific Options: -s - Specify the signal that the selected tasks should receive. + Specify the signal that the selected tasks should receive. Defaults to SIGKILL. -task - Specify the individual task that will receive the signal. If task name is given - with both an argument and the '-task' option, preference is given to the '-task' + Specify the individual task that will receive the signal. If task name is given + with both an argument and the '-task' option, preference is given to the '-task' option. -verbose