Update some parallel documentation #5515
Merged
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
wthrowe
requested changes
Sep 29, 2023
| \snippet Test_DetectHangArray.cpp deadlock_analysis_function | ||
|
|
||
| If this function is specified in the metavariables and a deadlock occurs, this | ||
| function and all the simple actions in it will run. The information printed |
There was a problem hiding this comment.
What do you mean by "simple actions in [a function]"?
There was a problem hiding this comment.
The function named run_deadlock_analysis_simple_actions calls simple actions.
There was a problem hiding this comment.
OK, yeah, I guess that should have been clear if I'd paid more attention.
| @@ -806,15 +806,15 @@ will be invoked; in this case the callback function re-runs | |||
| \snippet Test_AlgorithmGlobalCache.cpp check_mutable_cache_item_is_ready | |||
|
|
|||
| Note that `Parallel::mutable_cache_item_is_ready` is called on a local | |||
| core and does no parallel communication. | |||
| node and does no parallel communication. | |||
There was a problem hiding this comment.
"the local node". (There's only one.)
docs/DevGuide/Parallelization.md
Outdated
|
|
||
| ### 2. Retrieving the item | ||
|
|
||
| The item is retrieved using `Parallel::get` just like for constant items. | ||
| For example, to retrieve the item `Tags::VectorOfDoubles`: | ||
| \snippet Test_AlgorithmGlobalCache.cpp retrieve_mutable_cache_item | ||
|
|
||
| Note that `Parallel::get` is called on a local core and does no | ||
| Note that `Parallel::get` is called on a local node and does no |
knelli2
force-pushed
the
parallel_docs
branch
from
cba6c8e to
85cf806
Compare
|
Squashed the "the"s. |
wthrowe
approved these changes
Sep 29, 2023
kidder
approved these changes
Sep 29, 2023
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.
Proposed changes
Some of it was out of date. Also added some info and warnings.
Upgrade instructions
Code review checklist
make docto generate the documentation locally intoBUILD_DIR/docs/html.Then open
index.html.code review guide.
bugfixornew featureif appropriate.Further comments