Update documentation for using TotalView with Flux #265
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cmoussa1
approved these changes
Mar 2, 2024
jobs/debugging.rst
Outdated
| @@ -48,8 +48,8 @@ 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. | |||
| Exiting TotalView without completing a full run of your code, may not clean | |||
There was a problem hiding this comment.
I don't think a comma is needed here after code.
There was a problem hiding this comment.
Just pushed a couple fixes including dropping that comma!
There was a problem hiding this comment.
Looks like @garlick caught this in his fixes below!
garlick
force-pushed
the
suzannepaterno-totalview-flux-doc
branch
from
27591f4 to
a9de8c5
Compare
garlick
approved these changes
Mar 2, 2024
jobs/debugging.rst
Outdated
| @@ -47,6 +48,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. | |||
jobs/debugging.rst
Outdated
Comment on lines
69
to
80
| This code should either be added to the site-wide ``.tvdrc`` file | ||
| This code has been added to the site-wide ``.tvdrc`` file |
There was a problem hiding this comment.
Since these docs are not site dependent, it seems like the original was better?
jobs/debugging.rst
Outdated
| @@ -48,8 +48,8 @@ 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. | |||
| Exiting TotalView without completing a full run of your code, may not clean | |||
There was a problem hiding this comment.
Just pushed a couple fixes including dropping that comma!
|
Thanks! I'll set MWP. |
Add a few updates for the different UIs as well as some info on canceling flux job
Problem: There's some trailing whitespace and long lines in the jobs/debugging.rst doc. Fix up formatting.
Problem: totalview menu options are not formatted properly. Use the :guilabel: role.
Problem: referencing the presumed content of a site wide totalview config file is inappropriate in site independent docs. Restore the earlier language. Also drop a superfluous comma.
grondo
force-pushed
the
suzannepaterno-totalview-flux-doc
branch
from
a9de8c5 to
bdbd334
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds the helpful TotalView doc updates by @suzannepaterno from #251 without the merge commits. I was unable to force push to the other PR.