Merge pull request #265 from grondo/suzannepaterno-totalview-flux-doc

Update documentation for using TotalView with Flux

jobs/debugging.rst

@@ -1,7 +1,7 @@
 .. _debugging:
 
 ==============
-Debugging Jobs 
+Debugging Jobs
 ==============
 
 Flux supports parallel debuggers such as Rogue Wave Software (RWS)'s
@@ -11,8 +11,8 @@ Flux supports parallel debuggers such as Rogue Wave Software (RWS)'s
 Parallel Debugging using TotalView
 ----------------------------------
 
-Debugging your MPI job from the beginning of
-parallel program execution:
+Debugging your MPI job from the beginning
+of parallel program execution:
 
 .. code-block:: console
 
@@ -26,10 +26,13 @@ Attaching to an already running job:
   $ PID=$!
   $ totalview -pid ${PID} /proc/${PID}/exe
 
-You can also just type ``totalview`` without ``-pid`` option and
-then use its ``Start a Debugging Session``
-GUI option to select the process of this ``flux-job`` command:
-``A running program (attach)``.
+You can also just type ``totalview`` without ``-pid`` option.
+
+For the TotalView Classic user interface, select the process of this
+``flux-job`` command with
+:menuselection:`Start a Debugging Session --> A running program (attach)`.
+
+For new UI: use :menuselection:`Attach To Process`.
 
 .. note::
   You use TotalView with the newly invoked ``flux job attach``
@@ -47,6 +50,16 @@ can be handy when you debug a large-scale job. Please refer to
 
 .. _TotalView user guide: https://docs.roguewave.com/en/totalview/current/html/
 
+Exiting TotalView without completing a full run of your code may not clean
+up the Flux job.  In that case you will need to cancel the flux job manually.
+
+.. code-block:: console
+
+  $ flux cancel <JOBID>
+
+.. note::
+  Use ``flux jobs`` to find <JOBID>
+
 ----------------------------------------------
 Better Handling of Flux's Internal Exec Events
 ----------------------------------------------