Update build docs for windows

[kristjanvalur]

Some windows build tips gathered by trial and error.
Probably needs formatting and entering to whatever source editor was used to create the Readme :)

[Swatinem]

left some comments, looks good otherwise.

[Swatinem]

What do you mean by that? The -B flag specifies the output directory of the VC project, otherwise it would just clutter the working directory.

[kristjanvalur]

Sorry, that was unclear. You don't need the -DCMAKE_BUILD_TYPE=RelWithDebInfo setting there, although it is harmless. All the configurations are embedded in the resulting .vcxproj files.

[Mixaill]

You do not need it in case of MSVS generator or other multi-configuration projects, but you can use -G Ninja for example. In case of Ninja or Make you should specify build type.

[kristjanvalur]

Right you are. So it may well be left in place though. It is harmless enough :)

[Swatinem]

Its unfortunate that --parallel is just ignored on Windows. I found that you actually need to set a cflag to have parallel compilation like so:

sentry-native/tests/cmake.py

Lines 138 to 141 in 06d4360

	if sys.platform == "win32":
	# MP = object level parallelism, WX = warnings as errors
	cpus = os.cpu_count()
	cflags.append("/WX /MP{}".format(cpus))

Though I’m not really sure if there might be a better way here. Documentation is quite bad :-(

[kristjanvalur]

Right but the point I was trying to make was that if you do add --parallel, then the build step will only create the Debug configuration and ignores --config. Took me half an hour of experimentation last night to figure out what was going on. If you leave out the --parallel flag, then it will build whatever configuration you specify with --config

[Swatinem]

ohhh, I think in that case it might be a different manifestation of #512, which means that cmakes option parsing is broken

[kristjanvalur]

could be. Don't know what the best solution is. Only that I am not an avid cmake user myself and always struggle a bit when using it. Wanted to help save people from the problems I had :)

[Mixaill]

Already handled in https://github.com/getsentry/sentry-native/blob/master/CMakeLists.txt#L343-L366

[kristjanvalur]

Right, but it probably ought to be pointed out to users of the sentry.lib library, who otherwise need to hunt through their linker errors to figure out which windows libraries to include. It is already mentioned that winhttp.lib is a dependency but the others aren't mentioned.

[kristjanvalur]

So, what do we do with this? Looking at Readme.md, it looks to me as it comes from some external editor. This PR was not really meant for direct pulling, rather as a suggestion for updates.

[Swatinem]

Its just how my vscode (or actually prettier) autoformatted that, so no problem. I can also just copy-paste this in.

[kristjanvalur]

Right, but you probably do want to edit it for style. So feel free to just grab whatever from it and close the PR :) þri., 27. apr. 2021 kl. 09:02 skrifaði Arpad Borsos < ***@***.***>:

…

Its just how my vscode (or actually prettier) autoformatted that, so no problem. I can also just copy-paste this in. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#528 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABN3FRYHZYM7CXZT3SVF5QLTKZ4SVANCNFSM43OHVCAA> .

[supervacuus]

The raised topics in this PR concerning the CMake config/build parameters when using the MSBuild generator are all valid points. But I think we covered them in the docs a while back by providing more contrasting build examples: https://docs.sentry.io/platforms/native/#install