diff options
| author | Charles Brunet <charles.brunet@optelgroup.com> | 2023-02-20 08:05:03 -0500 |
|---|---|---|
| committer | Eli Schwartz <eschwartz93@gmail.com> | 2023-02-27 14:29:38 -0500 |
| commit | c7943b993d18c311966a29a796dadafc1ffbbc62 (patch) | |
| tree | 150882b404aa217d049bc28cf838d87334d0d693 | |
| parent | 07076db73e81340b5d71a7e727e830550f2fc4c8 (diff) | |
| download | meson-c7943b993d18c311966a29a796dadafc1ffbbc62.tar.gz | |
Improve unity build documentation
| -rw-r--r-- | docs/markdown/Unity-builds.md | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/docs/markdown/Unity-builds.md b/docs/markdown/Unity-builds.md index 833383d88..7a95b2d73 100644 --- a/docs/markdown/Unity-builds.md +++ b/docs/markdown/Unity-builds.md @@ -33,7 +33,21 @@ As an example, if both `src1.c` and `src2.c` contain a static function or variable of the same name, there will be a clash. Meson has built-in support for unity builds. To enable them, just pass -`--unity on` on the command line or enable unity builds with the GUI. +`--unity on` on the command line or enable unity builds in you project +default_options. No code changes are necessary apart from the potential clash issue discussed above. Meson will automatically generate all the necessary inclusion files for you. + +You may modify unity settings for a given build target using +the `override_options` parameter. This may be useful when a build +target is not compatible with unity build. + +The `unity` option can also have the value `subprojects`, to build +subprojects with unity, while building the main project incrementally. + +The `unity_size` option allows to specify the number of source files +included per unity file. The default is 4. Having more source files +per unity file will speed up full builds, but slow down incremental +builds. To get only one unity file per build target, you can use +a very big number for `unity_size`. |