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.

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

Adds a note about out of memory errors and provides a way to fix that #253

Merged

Conversation

onurtore
Copy link
Contributor

@onurtore onurtore commented Jun 7, 2022

🦟 Bug fix

Fixes gz-physics #349

Summary

Adds a note about possible out of memory errors and provides a way to fix that. I changed the documentation in here rather than gz-physics because this error occurs during parallel building of packages.

Checklist

  • [+] Signed all commits for DCO
  • Added tests
  • [+] Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

@onurtore onurtore requested a review from mabelzhang as a code owner June 7, 2022 17:55
@github-actions github-actions bot added 🌱 garden Gazebo Garden 🏯 fortress Ignition Fortress 🏰 citadel Ignition Citadel labels Jun 7, 2022
@onurtore
Copy link
Contributor Author

onurtore commented Jun 7, 2022

While I created a PR for this, I am not sure whether adding this would be beneficial for newcomers because related documentation part starts to get crowded.

@onurtore onurtore force-pushed the otore19/master/compilation_seg_fault branch from db7d8a4 to a0fb20e Compare June 7, 2022 18:10
Signed-off by: Onur Berk Tore otore19@ku.edu.tr
@onurtore onurtore force-pushed the otore19/master/compilation_seg_fault branch from a0fb20e to fe3c1f0 Compare June 7, 2022 18:12
Copy link
Contributor

@chapulina chapulina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure whether adding this would be beneficial for newcomers because related documentation part starts to get crowded.

That's a good point, I feel like that section should be straight-forward and offer just the commands that the user needs, with a small note pointing to another section below that provides more information for those who need it or want it.

I think this PR is ok as is, because it's not causing the problem, just adding to it. But it would be great to open a new PR after this is merged which organizes things a bit better.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏰 citadel Ignition Citadel 🏯 fortress Ignition Fortress 🌱 garden Gazebo Garden
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants