Skip to content

docs: clarify Upgrade blocks until child responds #88

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.

Sign up for GitHub

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

Open
Solaris-star wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: clarify Upgrade blocks until child responds #88

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion upgrader.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,13 @@ func (u *Upgrader) HasParent() bool {
return u.parent != nil
}

// Upgrade triggers an upgrade.
// Upgrade starts a zero-downtime upgrade of the current process.
//
// It does not return immediately after spawning the child: the call blocks
// until the upgrade either succeeds or fails. On failure it returns an error
// (for example if the child exits uncleanly or the process is already
// upgrading/terminating). On success the parent should drain work and exit
// so the child can take over.
func (u *Upgrader) Upgrade() error {
response := make(chan error, 1)
select {
Expand Down