-
Notifications
You must be signed in to change notification settings - Fork 481
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
Documentation for setting build type on Windows is outdated. #5136
Comments
It is still good to note that RelWithDebInfo is the "debug" option, but it is no longer needed to choose one specifically. For me, it seems "Release" is the new default. |
Feel free to make a PR with doc fixes -- the people trying to follow the docs are often the best people to revise the docs |
I will note that I recently ran into a case on Linux where no build type was selected, which gave me a weird combination of compiler flags. I didn't catch it until I was trying to narrow down the behavior of I would definitely suggest making a clean build folder from scratch to verify the behavior you're seeing before updating the docs. But even then, we haven't deliberately changed our default build type, so any "new" behavior you're seeing might be specific to you. Maybe you can just change the phrasing from e.g. "you must change the build type from Debug" to "ensure that the build type is not set to Debug". My understanding is that "Debug" is an option native to CMake, so if we don't document that it shouldn't be used, some people might see it and try to use it. |
I'll see about making a docs PR when I get home since it's likely not too big a change. |
In the instructions for building the source in Visual Studio, it mentions changing the type to Release or RelWithDebInfo instead of Debug. As far as I can tell, this is no longer a necessary step as Debug never shows up as an option for me.
Referenced doc: https://docs.dfhack.org/en/stable/docs/dev/compile/Compile.html#id7
The text was updated successfully, but these errors were encountered: