Skip to content
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

Clarify what a restart means #966

Merged
merged 4 commits into from
Dec 6, 2023
Merged

Clarify what a restart means #966

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
43f867c
Clarify what a restart means
mlucool Sep 1, 2023
3e7e4a4
Review feedback
mlucool Sep 1, 2023
76c9a62
Fix review comments
mlucool Sep 6, 2023
2153323
Merge branch 'main' into rip
mlucool Nov 27, 2023
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
7 changes: 7 additions & 0 deletions docs/messaging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1049,6 +1049,13 @@ multiple cases:
IPythonQt client) to force a kernel restart to get a clean kernel without
losing client-side state like history or inlined figures.

A restart should only restart the kernel and its subprocesses and not any
parent processes. That is, a restart should be "in-place". For local kernels,
there is typically no parent process so a "hard" restart and an in-place
restart are identical whereas for remote kernels this is not generally the same.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great! Maybe worth giving an example, e.g. for a kernel running a container, the container may be kept running and a new kernel process started in the same container without restarting the container. It may also be worth making clear that this is a note for the code starting kernels, since most docs here are about how the kernel should respond to messages.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thoughts on the new wording?


.. versionchanged:: 5.4
mlucool marked this conversation as resolved.
Show resolved Hide resolved

The client sends a shutdown request to the kernel, and once it receives the
reply message (which is otherwise empty), it can assume that the kernel has
completed shutdown safely. The request is sent on the `control` channel.
Expand Down