Godot: Documentation for building godot on all the platforms uses single threaded build

Created on 21 Nov 2017  路  8Comments  路  Source: godotengine/godot

ie for OSX the documentation shows:

scons platform=osx

But this takes ~20 minutes to build.

The build goes an order of magnitude faster if you put scons -j 8 so the documentation should probably show that command by default for all the platforms.

archived documentation buildsystem

Most helpful comment

People should read http://docs.godotengine.org/en/latest/development/compiling/introduction_to_the_buildsystem.html which describes it.

We can add a .. seealso:: link to the top of each platform-specific page if need be, but I prefer we don't make the instructions more complex for each platform by cluttering with machine and OS-specific instructions about -j. The point of those commands is to show the important options, not the more advanced ones that will indeed be used by people who compile daily, and who should read the docs fully :)

All 8 comments

Tihs section section of the Introduction article talks about the usage of multiple cores for compilation, though.

(It also mentions that it can be a bit wonky, so it's probably left out for safety.)

Multiple cores ARE wonky on Windows.

The README links right to this page ( http://docs.godotengine.org/en/latest/development/compiling/index.html ). I'm thinking people are probably just going to click their platform.

-j builds seem to work fine under OS X fwiw.

Well, it is wonky only on windows, so, I guess it might be extended with -j $(sysctl -n hw.ncpu) (untested).

I thought that it's usually -j $(nproc) (unless that's a Linux-specific command)?

Yeah.

-bash: nproc: command not found

$(sysctl -n hw.ncpu) works though.

People should read http://docs.godotengine.org/en/latest/development/compiling/introduction_to_the_buildsystem.html which describes it.

We can add a .. seealso:: link to the top of each platform-specific page if need be, but I prefer we don't make the instructions more complex for each platform by cluttering with machine and OS-specific instructions about -j. The point of those commands is to show the important options, not the more advanced ones that will indeed be used by people who compile daily, and who should read the docs fully :)

Closing as per the above :)

Was this page helpful?
0 / 5 - 0 ratings