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

Build troubleshooting for long builds #2447

Conversation

AMZN-alexpete
Copy link
Contributor

@AMZN-alexpete AMZN-alexpete commented Jul 5, 2023

Change summary

Troubleshooting steps for long builds or builds that freeze or lock up a computer with high CPU core counts

Submission Checklist:

  • Descriptive active voice - Do descriptive sentences have a clear subject and action verb?
  • Answer the question at hand - Does the documentation answer a what, why, how, or where type of question?
  • Consistency - Does the content consistently follow the Style Guide?
  • Help the user - Does the documentation show the user something meaningful?

Signed-off-by: Alex Peterson <26804013+AMZN-alexpete@users.noreply.github.com>
@nicholas-rh
Copy link
Contributor

May or may not be relevant here since they are enabled by default and already mentioned throughout the rest of the documentation, but unity builds are significantly faster (by 2x or more) for me in comparison to non-unity builds.

@AMZN-alexpete
Copy link
Contributor Author

Considering adding an image showing VS 2022's GUI for setting Maximum number of parallel builds
image
and maximum concurrent c++ compilations
image

Copy link
Contributor

@lemonade-dm lemonade-dm left a comment

Choose a reason for hiding this comment

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

We should also mention on Linux that the build could run out of memory and cause OOM killer to run or for certain install cause the machine to reboot.

The cmake --build --j/--parallel option can be used to reduce the number of parallel.

For example on a 12-core 32-GiB machine, the user might want to reduce the number of parallel build jobs to 6 if they are noticing their compile processes are being killed.

cmake --build <build-dir> --j 6 --config profile --target MyProject.GameLauncher -- <generator specific options>

Signed-off-by: Alex Peterson <26804013+AMZN-alexpete@users.noreply.github.com>
@AMZN-alexpete
Copy link
Contributor Author

Went ahead and added those VS 2022 menu images, suggestion to use unity builds, and cmake parallel build option.

Signed-off-by: Alex Peterson <26804013+AMZN-alexpete@users.noreply.github.com>
Copy link
Contributor

@lemonade-dm lemonade-dm left a comment

Choose a reason for hiding this comment

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

Looks good to me

@AMZN-alexpete AMZN-alexpete requested review from willihay and removed request for galibzon and mbalfour-amzn July 14, 2023 15:08
@AMZN-alexpete
Copy link
Contributor Author

Added @willihay to the review

content/docs/user-guide/build/troubleshooting.md Outdated Show resolved Hide resolved
content/docs/user-guide/build/troubleshooting.md Outdated Show resolved Hide resolved
content/docs/user-guide/build/troubleshooting.md Outdated Show resolved Hide resolved
content/docs/user-guide/build/troubleshooting.md Outdated Show resolved Hide resolved
content/docs/user-guide/build/troubleshooting.md Outdated Show resolved Hide resolved
content/docs/user-guide/build/troubleshooting.md Outdated Show resolved Hide resolved
content/docs/user-guide/build/troubleshooting.md Outdated Show resolved Hide resolved
content/docs/user-guide/build/troubleshooting.md Outdated Show resolved Hide resolved
content/docs/user-guide/build/troubleshooting.md Outdated Show resolved Hide resolved
content/docs/user-guide/build/troubleshooting.md Outdated Show resolved Hide resolved
Signed-off-by: Alex Peterson <26804013+AMZN-alexpete@users.noreply.github.com>
@AMZN-alexpete AMZN-alexpete merged commit 995992f into o3de:development Nov 6, 2023
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants