docs: document --stop-signals flag in README#213
Open
bejaratommy wants to merge 1 commit intoDarthSim:masterfrom
Open
docs: document --stop-signals flag in README#213bejaratommy wants to merge 1 commit intoDarthSim:masterfrom
bejaratommy wants to merge 1 commit intoDarthSim:masterfrom
Conversation
The -i/--stop-signals flag (OVERMIND_STOP_SIGNALS env var) has been part of Overmind for a long time but was never documented in the README. This adds a section explaining how to use it, including the supported signal names, right after the auto-restart section where process lifecycle control options are grouped. Fixes DarthSim#201 Signed-off-by: bejaratommy <tommy@bejarano.io>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds documentation for the
-i/--stop-signalsflag (OVERMIND_STOP_SIGNALSenv var) to the README.Why
The flag has been implemented in the codebase but was never documented in the README. Users have no way to discover it without reading source code.
Fixes #201
Changes
Added a new "Specifying stop signals" subsection after the auto-restart section (where other process lifecycle options are grouped), documenting:
-ishort flag and--stop-signalslong flagOVERMIND_STOP_SIGNALSenv var equivalentprocess=signal,process=signalformat