etl/docs/source/meson.md
John Wellbelove 4a88884b39
Issue/add hugo support for documentation (#1449)
* Add ranges

* Initial Hugo setup

* Work in progress

* Added selection for local or remote site

* Updated to 'light' theme

* Changed to using Hextra Hugo theme

* Changed to using Hextra Hugo theme

* Changed to Hextra Hugo theme

* Change to Hextra Hugo theme

* Updated Hugo setup.

* Updated Hugo setup.

# Conflicts:
#	docs/releases/_index.md

* Work in progress

* Added new fonts

Added new documentation

* Latest documentation updates

* Latest documentation updates

# Conflicts:
#	docs/containers/array.md
#	docs/containers/array_view.md
#	docs/containers/array_wrapper.md
#	docs/containers/bip_buffer_spsc_atomic.md
#	docs/containers/bitset.md
#	docs/containers/indirect_vector.md
#	docs/containers/vector.md
#	docs/getting-started/compilers.md

* Added bloom_filter markdown doc

* Added more documentation

Updated CSS for light and dark modes

* Fixed some menus

Added mode documentation files

* Updated CSS rules

Added badges to home page
Added uniqur_ptr + pool tutorial

* Fixed formatting on the home page markdown

Modified light amd dark code formatting

* Updated unique_ptr-with-pool

* Added container and shared message tutorials

* Updates to documentation

* Added const_multimap

* Updated source-formatting.md

* Added initial raw text files form Web site editor

* Innore coverage build directory

* Exported raw text documentation files from the web site editor

* Hugo updates

* Added Hugo intalation and markdown descriptions

* More addition to the documentation

* Added closure.md and updates to delegate.md

* Added format.md

* Added documentation for etl::delegate_observable, etl::function, Base64 codec

* Added io_port documentation

* Added basic_format_spec

* Added documentation for string_stream and string utilities.

* Added more documentation

Updated the documentation CSS

* Added documentation for clocks, day, duration

* Added more documentation for chrono classes

Updated callouts

* More chrono documentation

* Completed chrono documentation

* Maths functions documentation

* Completed maths documentation

* Completed maths documentation

* Completed maths documentation

* Completed maths documentation

* Added multiple documentation files

* Added iterator.md

* Added debug_count.md and versions.md

* Added debug_count.md and versions.md

* Added more documentation

* More documentation

* Added some design pattern documentation

Modified some of the layout files
Modified the About documentation

* Converted more documentation pages

Modified the site CSS

* Added more documentation

Moced some documentation files to new directories

* Added more documentation

Tweaks to CSS

* Added callback_timer_deferred_locked documentation

* Added callback_timer_locked documentation

* More documentation updates

* More documentation updates

* More documentation updates

* New documentation files.

Harmonised file name format

* New documentation files.

* Multiple document updates

* Multiple document updates

* Final conversion of web pages

* Updates before PR

* Updates before PR

* Updates before PR

# Conflicts:
#	docs/blog/_index.md

* Final pre PR updates

* Updates to message framework documentation

* Renamed directory

* Fix spelling

* Added author and date to blog files

Moved documentation files merged from development

* Fixed 'Description' typo

* Fix typos

# Conflicts:
#	docs/IO/io_port.md
#	docs/containers/sets/const-multiset.md
#	docs/containers/sets/const-set.md
#	docs/maths/correlation.md
#	docs/maths/gamma.md

* Renamed two files to lower case

* Minor renaming

* Added author and date

* Updated callout on bresenham_line.md

Added support for showing the ETL version on the documentation first page, by copying the version.txt file as a hugo asset.
Updated the Python 'update_release.py' to copy 'version.txt'

* Replace space in filename with hyphen.

Added more information to hugo-commands.md

* Replace space in filename with hyphen.

Added more information to hugo-commands.md

# Conflicts:
#	docs/getting-started/view-the-docs-locally/hugo-commands.md

* Added a link to pseudo_moving_average.md

* Updated title pages for groups

* Fixed missing 404 for non-existent pages

* Fixed coordinate variable names in the 'Calculating the intersection' example

---------

Co-authored-by: Roland Reichwein <Roland.Reichwein@bmw.de>
Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.com>
Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.co.uk>
2026-06-06 13:12:44 +01:00

3.3 KiB

title weight
Building ETL with Meson 2

Prerequisites

  • Meson >= 0.57.0
  • A C++17 compiler (GCC, Clang, or MSVC)
  • Ninja (default Meson backend)

UnitTest++ is fetched automatically as a Meson subproject — no manual dependency installation is needed.

Quick Start

# Configure (from the project root)
meson setup builddir

# Build
meson compile -C builddir

# Run tests
meson test -C builddir

Build Options

ETL project options

Option Type Default Description
use_stl bool true Build with STL support. When false, defines ETL_NO_STL.
enable_sanitizer bool false Enable AddressSanitizer and UndefinedBehaviorSanitizer (GCC/Clang only).

Meson built-in options

Option Type Default Description
cpp_std string c++17 C++ standard to compile with (e.g. c++20, c++23).
buildtype string debug Build type: plain, debug, debugoptimized, release, minsize.
werror bool false Treat compiler warnings as errors.

These are handled by Meson directly — no get_option() call is needed in the build files.

Examples

# No STL, C++23
meson setup builddir -Duse_stl=false -Dcpp_std=c++23

# Release build with sanitizers
meson setup builddir -Dbuildtype=release -Denable_sanitizer=true

# Override the C++ standard on an existing build directory
meson configure builddir -Dcpp_std=c++20

Selecting a Compiler

The compiler is chosen at configure time via environment variables:

# GCC
CC=gcc CXX=g++ meson setup builddir

# Clang
CC=clang CXX=clang++ meson setup builddir

# Specific versions
CC=gcc-14 CXX=g++-14 meson setup builddir
CC=clang-18 CXX=clang++-18 meson setup builddir

To switch compilers on an existing build directory, wipe it first:

CC=clang CXX=clang++ meson setup --wipe builddir

Or use separate directories per compiler:

CC=gcc CXX=g++ meson setup build-gcc
CC=clang CXX=clang++ meson setup build-clang

Running Tests

# Run all tests
meson test -C builddir

# Verbose output (shows individual test results)
meson test -C builddir -v

# Run the test binary directly
./builddir/test/etl_unit_tests

Sanitizers

On GCC and Clang, AddressSanitizer and UndefinedBehaviorSanitizer can be enabled via the enable_sanitizer option:

meson setup builddir -Denable_sanitizer=true

Note: UBSan may prevent certain constexpr evaluations involving function pointers from compiling (e.g. in the closure tests). This matches the CMake build, where sanitizers are also opt-in via ETL_ENABLE_SANITIZER=ON.

Using ETL as a Subproject

ETL can be consumed as a Meson subproject. In your project's subprojects/ directory, create an etl.wrap file, then use:

etl_dep = dependency('etl', fallback: ['etl', 'etl_dep'])

When built as a subproject, the ETL test suite is not compiled.