-
Notifications
You must be signed in to change notification settings - Fork 41
Add doc for scorep #204
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.
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
Add doc for scorep #204
Conversation
This comment has been minimized.
This comment has been minimized.
|
preview available: https://docs.tds.cscs.ch/204 |
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces a new documentation page for Score-P and other VI-HPS performance tools, updates the devtools index to reference it, and assigns ownership for the new docs.
- Add
docs/software/devtools/vihps.mdcovering Score-P, Vampir, Cube & Scalasca, and usage examples - Update
docs/software/devtools/index.mdto include a link to the VI-HPS tools section - Extend
.github/CODEOWNERSto assign an owner for the new documentation
Reviewed Changes
Copilot reviewed 3 out of 8 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/software/devtools/vihps.md | New guide for Score-P and related VI-HPS tools |
| docs/software/devtools/index.md | Added “[VI-HPS Tools]” entry to the devtools list |
| .github/CODEOWNERS | Added ownership for docs/software/devtools/vihps |
Comments suppressed due to low confidence (3)
docs/software/devtools/vihps.md:29
- The reference
[ref-uenv]isn’t defined in this file. Either add a link definition (e.g. at the bottom) or convert it to an inline URL to avoid a broken link.
The VI-HPS uenv is named `scorep` and it can be loaded into your environment as explained here and in the [uenv documentation][ref-uenv].
docs/software/devtools/vihps.md:81
- [nitpick] Grammar: change "one of the report type" to "one of the report types" for correct pluralization.
Pick one of the report type in your jobscript before running the executable compiled with `scorep`:
docs/software/devtools/vihps.md:1
- [nitpick] This anchor syntax is uncommon—please verify it renders correctly or consider using a more standard Markdown heading ID (e.g.
## VI-HPS tools {#ref-devtools-vihps}) for consistency.
[](){#ref-devtools-vihps}
|
preview available: https://docs.tds.cscs.ch/204 |
bcumming
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks JG!
I have a few nit picks.
The main one is that the images of the product logos are not needed, and would increase the size of the repository by 230kb.
|
preview available: https://docs.tds.cscs.ch/204 |
|
preview available: https://docs.tds.cscs.ch/204 |
|
preview available: https://docs.tds.cscs.ch/204 |
No description provided.