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

[README] Update optimized build instructions #1437

Merged
merged 1 commit into from
Mar 16, 2024
Merged

Conversation

armansito
Copy link
Contributor

  • Add instructions for optimized builds that work across Windows (MSVC) and Unix (Linux/macOS, using GCC/Clang).

  • Add log messages to CMakeLists.txt that prints out CMAKE_CXX_FLAGS_DEBUG and CMAKE_CXX_FLAGS_RELEASE. This seems to work on all platforms that I tested and profile useful information about the flags used by the underlying toolchain.

Fixes #1432

* Add instructions for optimized builds that work across Windows (MSVC)
  and Unix (Linux/macOS, using GCC/Clang).

* Add log messages to CMakeLists.txt that prints out
  `CMAKE_CXX_FLAGS_DEBUG` and `CMAKE_CXX_FLAGS_RELEASE`. This seems to
  work on all platforms that I tested and profile useful information
  about the flags used by the underlying toolchain.

Fixes #1432
@armansito armansito requested a review from a team March 16, 2024 20:36
@hollasch hollasch merged commit 57a68e8 into release Mar 16, 2024
@hollasch hollasch deleted the update-readme-2 branch March 16, 2024 20:37
```

We recommend building and running the `Release` version (especially before the final render) for
the fastest results, unless you need extra debugging information of the (default) debug build.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion: "information of the (default)" -> "information for the (default)

@rupsis
Copy link
Contributor

rupsis commented Mar 18, 2024

Might be a good idea to link to the ### Optimized Builds section from the Running The Programs section.

@armansito
Copy link
Contributor Author

Might be a good idea to link to the ### Optimized Builds section from the Running The Programs section.

Oh, good catch! I'll fix these up in a follow-up later today.

armansito added a commit that referenced this pull request Apr 7, 2024
Brought the running instructions to be in-sync with the new
build instructions. Also address review comments on #1437 by @rupsis
hollasch pushed a commit that referenced this pull request Apr 7, 2024
Brought the running instructions to be in-sync with the new
build instructions. Also address review comments on #1437 by @rupsis
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.

Clang --debug vs --release flags have no performance benefit
3 participants