Skip to content

Commit

Permalink
capture segfault in troubleshooting section
Browse files Browse the repository at this point in the history
  • Loading branch information
bruceravel committed Jan 24, 2024
1 parent 14ca0fd commit 6b185cc
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 12 deletions.
Binary file added docs/_images/segfault.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 19 additions & 12 deletions docs/trouble.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,26 +41,33 @@ To resume BlueSky, type the command ``fg`` and hit ``Enter``.
You will find yourself back at the BlueSky prompt and can carry on
normally.

Exiting BlueSky
---------------
Exiting or crashing bsui
------------------------

Another possibility is that BlueSky has exited entirely |nd| possibly
because something has happened to put the program into an unworkable
state. This will usually be accompanied by a lengthy `stack trace`,
state. This will often be accompanied by a lengthy `stack trace`,
i.e. a bunch of weird code and error messages printed to the terminal
window, followed by the yellow and magenta prompt seen in the picture
above.
above. Other times, there may simply be a message about a
"Segmentation fault" and a "core dump". An example of a segmentation
fault is shown here:

.. _fig-segfault:
.. figure:: _images/segfault.png
:target: _images/segfault.png
:width: 100%
:align: center

An example of bsui crashing with a segfault

In this case, simply hit up arrow once (or possible a few times) until
you find the ``bsui`` command. Hit ``Enter``.
The previous bsui session cannot be recovered at this point. You will
have to restart bsui and restart your data collection.

If hitting up arrow does not uncover the correct command, simply
type ``bsui`` at the command line with the yellow and magenta
prompt, then hit ``Enter``.
In this case, at the command line, type ``bsui`` and hit ``Enter``.

This will start a new BlueSky session and should remember all the
metadata from the ``start_experiment`` command that began your
experiment.
This will start a new BlueSky session and should restore the state of
your experiment from before the crash.

.. You will then need to :numref:`restart your user session (Section %s)
<start_end>` by issuing the ``BMMuser.start_experiment()`` command with the
Expand Down

0 comments on commit 6b185cc

Please sign in to comment.