Compiling (Speeding up): Difference between revisions

From FreeCAD Documentation
(Remove space; add translate guards surrounding code)
(Marked this version for translation)
Line 13: Line 13:
When using {{incode|cmake}} to configure the build, you can disable the compilation of certain workbenches that you may not need at the moment. This is useful if you only need to test a few workbenches.
When using {{incode|cmake}} to configure the build, you can disable the compilation of certain workbenches that you may not need at the moment. This is useful if you only need to test a few workbenches.


<!--T:10-->
For example, to avoid building the FEM and Mesh workbenches:
For example, to avoid building the FEM and Mesh workbenches:
{{Code|code=
{{Code|code=
Line 18: Line 19:
}}
}}


<!--T:11-->
Use {{incode|cmake-gui}}, {{incode|cmake-curses-gui}}, or {{incode|cmake-qt-gui}} to display all the possible variables that can be edited in the configuration; using these interfaces you can easily switch on or off different workbenches.
Use {{incode|cmake-gui}}, {{incode|cmake-curses-gui}}, or {{incode|cmake-qt-gui}} to display all the possible variables that can be edited in the configuration; using these interfaces you can easily switch on or off different workbenches.


Line 23: Line 25:
After configuring with {{incode|cmake}}, the {{incode|make}} program launches the actual C++ compiler to work on the source code files. You can speed up compilation by working on various files at the same time. This is achieved with the {{incode|-j}} option of {{incode|make}}, which denotes the number of "jobs" or compilation commands that are run simultaneously. This option is an integer number.
After configuring with {{incode|cmake}}, the {{incode|make}} program launches the actual C++ compiler to work on the source code files. You can speed up compilation by working on various files at the same time. This is achieved with the {{incode|-j}} option of {{incode|make}}, which denotes the number of "jobs" or compilation commands that are run simultaneously. This option is an integer number.


<!--T:12-->
Run four compilation commands in parallel:
Run four compilation commands in parallel:


Line 31: Line 34:
<translate>
<translate>


<!--T:13-->
Compile as many files in parallel as the number of CPU cores in your system. This is useful if you have many cores and want to use them all to compile the software.
Compile as many files in parallel as the number of CPU cores in your system. This is useful if you have many cores and want to use them all to compile the software.
</translate>
</translate>
Line 38: Line 42:
<translate>
<translate>


<!--T:14-->
Compile as many files in parallel as the number of CPU cores in your system, minus two. Use this so that your system is still responsive to do some other task; for example, two cores will allow you to use a browser, while the rest of the cores keep compiling the software on the background.
Compile as many files in parallel as the number of CPU cores in your system, minus two. Use this so that your system is still responsive to do some other task; for example, two cores will allow you to use a browser, while the rest of the cores keep compiling the software on the background.
</translate>
</translate>

Revision as of 10:03, 13 July 2019

Other languages:
CompileOnMac
Third Party Libraries

FreeCAD is a large application that may take from 10 minutes to one hour to compile completely from source. This depends primarily on the CPU that you have, and the number of cores that are used in the compilation process. Here are some tips to shorten that process and make build times shorter.

CCache

Install ccache to cache builds.

Disable modules

When using cmake to configure the build, you can disable the compilation of certain workbenches that you may not need at the moment. This is useful if you only need to test a few workbenches.

For example, to avoid building the FEM and Mesh workbenches: 

cmake -DBUILD_FEM=OFF -DBUILD_MESH=OFF ../freecad-source

Use cmake-gui, cmake-curses-gui, or cmake-qt-gui to display all the possible variables that can be edited in the configuration; using these interfaces you can easily switch on or off different workbenches.

Number of jobs in parallel

After configuring with cmake, the make program launches the actual C++ compiler to work on the source code files. You can speed up compilation by working on various files at the same time. This is achieved with the -j option of make, which denotes the number of "jobs" or compilation commands that are run simultaneously. This option is an integer number.

Run four compilation commands in parallel: 

make -j4

Compile as many files in parallel as the number of CPU cores in your system. This is useful if you have many cores and want to use them all to compile the software. 

make -j$(nproc)

Compile as many files in parallel as the number of CPU cores in your system, minus two. Use this so that your system is still responsive to do some other task; for example, two cores will allow you to use a browser, while the rest of the cores keep compiling the software on the background. 

make -j$(nproc --ignore=2)

distcc

The distcc program can be used to perform distributed compilation of C and C++ code across several machines in a network.

CompileOnMac
Third Party Libraries
User documentation
Retrieved from "http://wiki.freecad.org/index.php?title=Compiling_(Speeding_up)&oldid=493301"