Skip to content

runtime: document signals caught and handled by the runtime #12534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
nightlyone opened this issue Sep 7, 2015 · 4 comments
Closed

runtime: document signals caught and handled by the runtime #12534

nightlyone opened this issue Sep 7, 2015 · 4 comments
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge
Milestone

Comments

@nightlyone
Copy link
Contributor

Various signals (e.g. SIGQUIT) are handled by the runtime and lead to special default actions in all Go programs.

It would be great to document these somewhere (e.g. os/signal) so people can find these magic signals and their expected/current behavior somewhere.

@mlafeldt
Copy link

mlafeldt commented Sep 7, 2015

Today I tried to remember the signal which causes a Go program to dump all goroutines. Even through googling it was hard to figure out that SIGQUIT is the right answer. So 👍 for adding this information to a well-known location.

@ianlancetaylor ianlancetaylor changed the title os/signal: Document signals caught and handled by the runtime runtime: Document signals caught and handled by the runtime Sep 8, 2015
@ianlancetaylor
Copy link
Contributor

Good idea but I don't think os/signal is the right place for this. Setting the package to runtime for now.

@ianlancetaylor ianlancetaylor added this to the Go1.6 milestone Sep 8, 2015
@ianlancetaylor ianlancetaylor added the Documentation Issues describing a change to documentation. label Sep 8, 2015
@rsc rsc changed the title runtime: Document signals caught and handled by the runtime runtime: document signals caught and handled by the runtime Nov 5, 2015
@rsc
Copy link
Contributor

rsc commented Nov 23, 2015

FWIW the argument for putting these docs in os/signal (perhaps with a forward reference from package runtime) is that os/signal's funcs change the behavior. It's easier to describe both the default and modified behaviors in one place.

@rsc
Copy link
Contributor

rsc commented Nov 24, 2015

Dup of #9896.

@rsc rsc closed this as completed Nov 24, 2015
@golang golang locked and limited conversation to collaborators Nov 27, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge
Projects
None yet
Development

No branches or pull requests

5 participants