Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Documentation updates #3385

Closed
6 tasks done
Tracked by #3384
bgeltz opened this issue Mar 27, 2024 · 0 comments
Closed
6 tasks done
Tracked by #3384

Documentation updates #3385

bgeltz opened this issue Mar 27, 2024 · 0 comments
Assignees
@cmcantalupo @dannosliwcd @sidjana @bgeltz
Labels
task tasks associated with stories
Milestone
YR24 WW17

Comments

@bgeltz
Copy link
Contributor

bgeltz commented Mar 27, 2024 •
edited by cmcantalupo

estimate 1
Parent [feature/story]: #3384

Done criteria:

  • Read through all existing documentation and re-word/re-flow as necessary to match the new directory structure of the source repository.
  • Runtime README needs to be filled in the new libgeopm directory. It needs to be rewritten. Be brave; use the delete key.
  • Documentation about things like "you MUST use the performance cpufreq governor" can be removed/relaxed. We're not just concerned with HPC anymore. Similarly, CPU affinity requirements.
  • geopmsession man page needs to be updated: Documentation for geopmsession and geopmaccess is lacking many details #1804
  • build.rst will need to be updated with the new procedure
  • devel.rst needs to be updated
@bgeltz bgeltz mentioned this issue Mar 27, 2024
Closed
4 tasks
@bgeltz bgeltz added this to the YR24 WW13 milestone Mar 27, 2024
@bgeltz bgeltz added the task tasks associated with stories label Mar 27, 2024
@bgeltz bgeltz modified the milestones: YR24 WW13, YR24 WW15 Apr 10, 2024
@cmcantalupo cmcantalupo mentioned this issue Apr 23, 2024
Merged
3 tasks
@bgeltz bgeltz modified the milestones: YR24 WW15, YR24 WW17 Apr 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cmcantalupo cmcantalupo

@dannosliwcd dannosliwcd

@sidjana sidjana

@bgeltz bgeltz

Labels
task tasks associated with stories
Projects
None yet
Milestone
YR24 WW17
Development

No branches or pull requests
4 participants
@cmcantalupo @dannosliwcd @sidjana @bgeltz