命令行命令

调用 Meson 有两种不同的方法。首先,您可以使用命令 /path/to/source/meson.py 从源树中直接运行它。Meson 也可能被安装,在这种情况下,命令就简化为 meson。为了简便起见,本手册只使用后一种格式。

Meson 使用以下语法调用:meson [COMMAND] [COMMAND_OPTIONS]

本节描述所有可用的命令及其一些可选参数。最常见的流程是运行 setup,然后运行 compile,最后运行 install

要查看特定命令所有可用选项的完整列表,请使用以下语法:meson COMMAND --help

configure

$ meson configure [-h] [--prefix PREFIX] [--bindir BINDIR]
                  [--datadir DATADIR] [--includedir INCLUDEDIR]
                  [--infodir INFODIR] [--libdir LIBDIR]
                  [--licensedir LICENSEDIR] [--libexecdir LIBEXECDIR]
                  [--localedir LOCALEDIR] [--localstatedir LOCALSTATEDIR]
                  [--mandir MANDIR] [--sbindir SBINDIR]
                  [--sharedstatedir SHAREDSTATEDIR]
                  [--sysconfdir SYSCONFDIR]
                  [--auto-features {enabled,disabled,auto}]
                  [--backend {ninja,vs,vs2010,vs2012,vs2013,vs2015,vs2017,vs2019,vs2022,xcode,none}]
                  [--genvslite {vs2022}]
                  [--buildtype {plain,debug,debugoptimized,release,minsize,custom}]
                  [--debug] [--default-library {shared,static,both}]
                  [--default-both-libraries {shared,static,auto}]
                  [--errorlogs] [--install-umask INSTALL_UMASK]
                  [--layout {mirror,flat}]
                  [--optimization {plain,0,g,1,2,3,s}] [--prefer-static]
                  [--stdsplit] [--strip] [--unity {on,off,subprojects}]
                  [--unity-size UNITY_SIZE]
                  [--warnlevel {0,1,2,3,everything}] [--werror]
                  [--wrap-mode {default,nofallback,nodownload,forcefallback,nopromote}]
                  [--force-fallback-for FORCE_FALLBACK_FOR] [--vsenv]
                  [--pkgconfig.relocatable]
                  [--python.bytecompile PYTHON.BYTECOMPILE]
                  [--python.install-env {auto,prefix,system,venv}]
                  [--python.platlibdir PYTHON.PLATLIBDIR]
                  [--python.purelibdir PYTHON.PURELIBDIR]
                  [--python.allow-limited-api]
                  [--pkg-config-path PKG_CONFIG_PATH]
                  [--build.pkg-config-path BUILD.PKG_CONFIG_PATH]
                  [--cmake-prefix-path CMAKE_PREFIX_PATH]
                  [--build.cmake-prefix-path BUILD.CMAKE_PREFIX_PATH]
                  [-D option] [--clearcache] [--no-pager]
                  [builddir]

更改已配置的 Meson 项目的选项。

positional arguments:
  builddir

options:
  -h, --help                            show this help message and exit
  --prefix PREFIX                       Installation prefix.
  --bindir BINDIR                       Executable directory.
  --datadir DATADIR                     Data file directory.
  --includedir INCLUDEDIR               Header file directory.
  --infodir INFODIR                     Info page directory.
  --libdir LIBDIR                       Library directory.
  --licensedir LICENSEDIR               Licenses directory (default: ).
  --libexecdir LIBEXECDIR               Library executable directory.
  --localedir LOCALEDIR                 Locale data directory.
  --localstatedir LOCALSTATEDIR         Localstate data directory.
  --mandir MANDIR                       Manual page directory.
  --sbindir SBINDIR                     System executable directory.
  --sharedstatedir SHAREDSTATEDIR       Architecture-independent data directory.
  --sysconfdir SYSCONFDIR               Sysconf data directory.
  --auto-features {enabled,disabled,auto}
                                        Override value of all 'auto' features
                                        (default: auto).
  --backend {ninja,vs,vs2010,vs2012,vs2013,vs2015,vs2017,vs2019,vs2022,xcode,none}
                                        Backend to use (default: ninja).
  --genvslite {vs2022}                  Setup multiple buildtype-suffixed ninja-
                                        backend build directories, and a
                                        [builddir]_vs containing a Visual Studio
                                        meta-backend with multiple
                                        configurations that calls into them
                                        (default: vs2022).
  --buildtype {plain,debug,debugoptimized,release,minsize,custom}
                                        Build type to use (default: debug).
  --debug                               Enable debug symbols and other
                                        information
  --default-library {shared,static,both}
                                        Default library type (default: shared).
  --default-both-libraries {shared,static,auto}
                                        Default library type for both_libraries
                                        (default: shared).
  --errorlogs                           Whether to print the logs from failing
                                        tests
  --install-umask INSTALL_UMASK         Default umask to apply on permissions of
                                        installed files (default: 022).
  --layout {mirror,flat}                Build directory layout (default:
                                        mirror).
  --optimization {plain,0,g,1,2,3,s}    Optimization level (default: 0).
  --prefer-static                       Whether to try static linking before
                                        shared linking
  --stdsplit                            Split stdout and stderr in test logs
  --strip                               Strip targets on install
  --unity {on,off,subprojects}          Unity build (default: off).
  --unity-size UNITY_SIZE               Unity block size (default: (2, None,
                                        4)).
  --warnlevel {0,1,2,3,everything}      Compiler warning level to use (default:
                                        1).
  --werror                              Treat warnings as errors
  --wrap-mode {default,nofallback,nodownload,forcefallback,nopromote}
                                        Wrap mode (default: default).
  --force-fallback-for FORCE_FALLBACK_FOR
                                        Force fallback for those subprojects
                                        (default: []).
  --vsenv                               Activate Visual Studio environment
  --pkgconfig.relocatable               Generate pkgconfig files as relocatable
  --python.bytecompile PYTHON.BYTECOMPILE
                                        Whether to compile bytecode (default:
                                        (-1, 2, 0)).
  --python.install-env {auto,prefix,system,venv}
                                        Which python environment to install to
                                        (default: prefix).
  --python.platlibdir PYTHON.PLATLIBDIR
                                        Directory for site-specific, platform-
                                        specific files (default: ).
  --python.purelibdir PYTHON.PURELIBDIR
                                        Directory for site-specific, non-
                                        platform-specific files (default: ).
  --python.allow-limited-api            Whether to allow use of the Python
                                        Limited API
  --pkg-config-path PKG_CONFIG_PATH     List of additional paths for pkg-config
                                        to search (default: []). (just for host
                                        machine)
  --build.pkg-config-path BUILD.PKG_CONFIG_PATH
                                        List of additional paths for pkg-config
                                        to search (default: []). (just for build
                                        machine)
  --cmake-prefix-path CMAKE_PREFIX_PATH
                                        List of additional prefixes for cmake to
                                        search (default: []). (just for host
                                        machine)
  --build.cmake-prefix-path BUILD.CMAKE_PREFIX_PATH
                                        List of additional prefixes for cmake to
                                        search (default: []). (just for build
                                        machine)
  -D option                             Set the value of an option, can be used
                                        several times to set multiple options.
  --clearcache                          Clear cached state (e.g. found
                                        dependencies)
  --no-pager                            Do not redirect output to a pager

大多数参数与 setup 中的参数相同。

注意:重新配置项目不会将选项重置为其默认值(即使它们在 meson.build 中被更改)。

示例

列出所有可用的选项

meson configure builddir

更改单个选项的值

meson configure builddir -Doption=new_value

compile

(自 0.54.0 起)

$ meson compile [-h] [--clean] [-C WD] [-j JOBS] [-l LOAD_AVERAGE] [-v]
                [--ninja-args NINJA_ARGS] [--vs-args VS_ARGS]
                [--xcode-args XCODE_ARGS]
                [TARGET ...]

构建已配置的 Meson 项目的默认目标或指定目标。

positional arguments:
  TARGET                                Targets to build. Target has the
                                        following format: [PATH_TO_TARGET/]TARGE
                                        T_NAME.TARGET_SUFFIX[:TARGET_TYPE].

options:
  -h, --help                            show this help message and exit
  --clean                               Clean the build directory.
  -C WD                                 directory to cd into before running
  -j JOBS, --jobs JOBS                  The number of worker jobs to run (if
                                        supported). If the value is less than 1
                                        the build program will guess.
  -l LOAD_AVERAGE, --load-average LOAD_AVERAGE
                                        The system load average to try to
                                        maintain (if supported).
  -v, --verbose                         Show more verbose output.
  --ninja-args NINJA_ARGS               Arguments to pass to `ninja` (applied
                                        only on `ninja` backend).
  --vs-args VS_ARGS                     Arguments to pass to `msbuild` (applied
                                        only on `vs` backend).
  --xcode-args XCODE_ARGS               Arguments to pass to `xcodebuild`
                                        (applied only on `xcode` backend).

--verbose 参数自 0.55.0 起可用。

目标

(自 0.55.0 起)

TARGET 具有以下语法 [PATH/]NAME.SUFFIX[:TYPE],其中

  • NAME:来自 meson.build 的目标名称(例如,来自 executable('foo', ...)foo)。
  • SUFFIX:来自 meson.build 的目标后缀名称(例如,来自 executable('foo', suffix: 'exe', ...)exe)。
  • PATH:相对于根 meson.build 文件的目标路径。注意:对于在根 meson.build 中指定的 target,相对路径为 ./
  • TYPE:目标的类型。可以是以下之一:'executable'、'static_library'、'shared_library'、'shared_module'、'custom'、'alias'、'run'、'jar'。

如果生成的 TARGET 可用于在 meson.build 中唯一标识目标,则可以省略 PATHSUFFIXTYPE

请注意,SUFFIX 在 1.3.0 之前并不存在。

后端特定参数

(自 0.55.0 起)

BACKEND-args 使用以下语法

如果您只传递单个字符串,则认为它包含所有以逗号分隔的值。因此,调用以下命令

$ meson compile --ninja-args=-n,-d,explain

会将 -n-dexplain 参数添加到 ninja 调用中。

如果您需要在字符串值中包含逗号或空格,则需要使用适当的 shell 引号传递该值,如下所示

$ meson compile "--ninja-args=['a,b', 'c d']"

示例

构建项目

meson compile -C builddir

在 ninja 后端上执行 dry run,并提供额外的调试信息

meson compile --ninja-args=-n,-d,explain

构建三个目标:两个名称相同但类型不同的 foo 目标,以及一个 bar 目标

meson compile foo:shared_library foo:static_library bar

生成覆盖率 html 报告(如果可用)

ninja coverage-html

dist

(自 0.52.0 起)

$ meson dist [-h] [-C WD] [--allow-dirty] [--formats FORMATS]
             [--include-subprojects] [--no-tests]

从当前源树生成发布存档。

options:
  -h, --help             show this help message and exit
  -C WD                  directory to cd into before running
  --allow-dirty          Allow even when repository contains uncommitted
                         changes.
  --formats FORMATS      Comma separated list of archive types to create.
                         Supports xztar (default), bztar, gztar, and zip.
  --include-subprojects  Include source code of subprojects that have been used
                         for the build.
  --no-tests             Do not build and test generated packages.

有关更多信息,请参阅 关于创建发布的说明

示例

创建发布存档

meson dist -C builddir

init

(自 0.45.0 起)

$ meson init [-h] [-C WD] [-n NAME] [-e EXECUTABLE] [-d DEPS]
             [-l {c,cpp,cs,cuda,d,fortran,java,objc,objcpp,rust,vala}] [-b]
             [--builddir BUILDDIR] [-f] [--type {executable,library}]
             [--version VERSION]
             [sourcefile ...]

根据模板创建一组基本的构建文件。

positional arguments:
  sourcefile                            source files. default: all recognized
                                        files in current directory

options:
  -h, --help                            show this help message and exit
  -C WD                                 directory to cd into before running
  -n NAME, --name NAME                  project name. default: name of current
                                        directory
  -e EXECUTABLE, --executable EXECUTABLE
                                        executable name. default: project name
  -d DEPS, --deps DEPS                  dependencies, comma-separated
  -l {c,cpp,cs,cuda,d,fortran,java,objc,objcpp,rust,vala}, --language {c,cpp,cs,cuda,d,fortran,java,objc,objcpp,rust,vala}
                                        project language. default: autodetected
                                        based on source files
  -b, --build                           build after generation
  --builddir BUILDDIR                   directory for build
  -f, --force                           force overwrite of existing files and
                                        directories.
  --type {executable,library}           project type. default: executable based
                                        project
  --version VERSION                     project version. default: 0.1

示例

sourcedir 中创建一个项目

meson init -C sourcedir

env2mfile

此命令是实验性的,可能会发生变化。

{自 0.62.0 起}

$ meson env2mfile [-h] [--debarch DEBARCH] [--gccsuffix GCCSUFFIX] -o
                  OUTFILE [--cross] [--native] [--system SYSTEM]
                  [--subsystem SUBSYSTEM] [--kernel KERNEL] [--cpu CPU]
                  [--cpu-family CPU_FAMILY] [--endian {big,little}]

从当前环境创建本机和交叉文件,通常是通过嗅探环境变量,如 CCCFLAGS

options:
  -h, --help               show this help message and exit
  --debarch DEBARCH        The dpkg architecture to generate.
  --gccsuffix GCCSUFFIX    A particular gcc version suffix if necessary.
  -o OUTFILE               The output file.
  --cross                  Generate a cross compilation file.
  --native                 Generate a native compilation file.
  --system SYSTEM          Define system for cross compilation.
  --subsystem SUBSYSTEM    Define subsystem for cross compilation.
  --kernel KERNEL          Define kernel for cross compilation.
  --cpu CPU                Define cpu for cross compilation.
  --cpu-family CPU_FAMILY  Define cpu family for cross compilation.
  --endian {big,little}    Define endianness for cross compilation.

示例

自动检测当前交叉构建环境

meson env2mfile --cross -o current_cross.txt --cpu=arm7a --cpu-family=arm --system=linux

使用 Debian 系统信息生成交叉构建

meson env2mfile --cross --debarch=armhf -o deb_arm_cross.txt

introspect

$ meson introspect [-h] [--ast] [--benchmarks] [--buildoptions]
                   [--buildsystem-files] [--compilers] [--dependencies]
                   [--scan-dependencies] [--installed] [--install-plan]
                   [--machines] [--projectinfo] [--targets] [--tests]
                   [--backend {ninja,none,vs,vs2010,vs2012,vs2013,vs2015,vs2017,vs2019,vs2022,xcode}]
                   [-a] [-i] [-f]
                   [builddir]

显示有关已配置的 Meson 项目的信息。

positional arguments:
  builddir                              The build directory

options:
  -h, --help                            show this help message and exit
  --ast                                 Dump the AST of the meson file.
  --benchmarks                          List all benchmarks.
  --buildoptions                        List all build options.
  --buildsystem-files                   List files that make up the build
                                        system.
  --compilers                           List used compilers.
  --dependencies                        List external dependencies.
  --scan-dependencies                   Scan for dependencies used in the
                                        meson.build file.
  --installed                           List all installed files and
                                        directories.
  --install-plan                        List all installed files and directories
                                        with their details.
  --machines                            Information about host, build, and
                                        target machines.
  --projectinfo                         Information about projects.
  --targets                             List top level targets.
  --tests                               List all unit tests.
  --backend {ninja,none,vs,vs2010,vs2012,vs2013,vs2015,vs2017,vs2019,vs2022,xcode}
                                        The backend to use for the
                                        --buildoptions introspection.
  -a, --all                             Print all available information.
  -i, --indent                          Enable pretty printed JSON.
  -f, --force-object-output             Always use the new JSON format for
                                        multiple entries (even for 0 and 1
                                        introspection commands)

示例

显示有关 builddir 中已配置项目的基本信息

meson introspect builddir --projectinfo

install

(自 0.47.0 起)

$ meson install [-h] [-C WD] [--no-rebuild] [--only-changed] [--quiet]
                [--destdir DESTDIR] [--dry-run]
                [--skip-subprojects [SKIP_SUBPROJECTS]] [--tags TAGS]
                [--strip]

将项目安装到 setup 中指定的 prefix。

options:
  -h, --help                            show this help message and exit
  -C WD                                 directory to cd into before running
  --no-rebuild                          Do not rebuild before installing.
  --only-changed                        Only overwrite files that are older than
                                        the copied file.
  --quiet                               Do not print every file that was
                                        installed.
  --destdir DESTDIR                     Sets or overrides DESTDIR environment.
                                        (Since 0.57.0)
  --dry-run, -n                         Doesn't actually install, but print
                                        logs. (Since 0.57.0)
  --skip-subprojects [SKIP_SUBPROJECTS]
                                        Do not install files from given
                                        subprojects. (Since 0.58.0)
  --tags TAGS                           Install only targets having one of the
                                        given tags. (Since 0.60.0)
  --strip                               Strip targets even if strip option was
                                        not set during configure. (Since 0.62.0)

有关更多信息,请参阅 安装文档

示例

将项目安装到 prefix

meson install -C builddir

将项目安装到 $DESTDIR/prefix

DESTDIR=/path/to/staging/area meson install -C builddir

0.60.0 起,DESTDIR--destdir 可以是相对于构建目录的路径。执行脚本时,绝对路径将被设置为环境变量。

reprotest

(自 1.6.0 起)

$ meson reprotest [-h] [--intermediaries] [mesonargs ...]

简单的可重复构建测试器,它编译项目两次并检查最终结果是否相同。

此命令必须在您要测试的项目的源代码根目录中运行。

positional arguments:
  mesonargs         Arguments to pass to "meson setup".

options:
  -h, --help        show this help message and exit
  --intermediaries  Check intermediate files.

示例

meson reprotest

使用其默认设置构建当前项目。

meson reprotest --intermediaries -- --buildtype=debugoptimized

构建目标并检查所有中间文件(如目标文件)是否也相同。-- 后面的所有命令行参数将直接传递给底层的 meson 调用。只使用选项参数,即以连字符开头的参数,Meson 会自动设置目录参数。

rewrite

(自 0.50.0 起)

$ meson rewrite [-h] [-s SRCDIR] [-V] [-S]
                {target,tgt,kwargs,default-options,def,command,cmd} ...

修改 Meson 项目。

options:
  -h, --help                            show this help message and exit
  -s SRCDIR, --sourcedir SRCDIR         Path to source directory.
  -V, --verbose                         Enable verbose output
  -S, --skip-errors                     Skip errors instead of aborting

Rewriter commands:
  Rewrite command to execute

  {target,tgt,kwargs,default-options,def,command,cmd}
    target (tgt)                        Modify a target
    kwargs                              Modify keyword arguments
    default-options (def)               Modify the project default options
    command (cmd)                       Execute a JSON array of commands

有关更多信息,请参阅 Meson 文件重写器文档

setup

$ meson setup [-h] [--prefix PREFIX] [--bindir BINDIR] [--datadir DATADIR]
              [--includedir INCLUDEDIR] [--infodir INFODIR]
              [--libdir LIBDIR] [--licensedir LICENSEDIR]
              [--libexecdir LIBEXECDIR] [--localedir LOCALEDIR]
              [--localstatedir LOCALSTATEDIR] [--mandir MANDIR]
              [--sbindir SBINDIR] [--sharedstatedir SHAREDSTATEDIR]
              [--sysconfdir SYSCONFDIR]
              [--auto-features {enabled,disabled,auto}]
              [--backend {ninja,vs,vs2010,vs2012,vs2013,vs2015,vs2017,vs2019,vs2022,xcode,none}]
              [--genvslite {vs2022}]
              [--buildtype {plain,debug,debugoptimized,release,minsize,custom}]
              [--debug] [--default-library {shared,static,both}]
              [--default-both-libraries {shared,static,auto}] [--errorlogs]
              [--install-umask INSTALL_UMASK] [--layout {mirror,flat}]
              [--optimization {plain,0,g,1,2,3,s}] [--prefer-static]
              [--stdsplit] [--strip] [--unity {on,off,subprojects}]
              [--unity-size UNITY_SIZE] [--warnlevel {0,1,2,3,everything}]
              [--werror]
              [--wrap-mode {default,nofallback,nodownload,forcefallback,nopromote}]
              [--force-fallback-for FORCE_FALLBACK_FOR] [--vsenv]
              [--pkgconfig.relocatable]
              [--python.bytecompile PYTHON.BYTECOMPILE]
              [--python.install-env {auto,prefix,system,venv}]
              [--python.platlibdir PYTHON.PLATLIBDIR]
              [--python.purelibdir PYTHON.PURELIBDIR]
              [--python.allow-limited-api]
              [--pkg-config-path PKG_CONFIG_PATH]
              [--build.pkg-config-path BUILD.PKG_CONFIG_PATH]
              [--cmake-prefix-path CMAKE_PREFIX_PATH]
              [--build.cmake-prefix-path BUILD.CMAKE_PREFIX_PATH]
              [-D option] [--native-file NATIVE_FILE]
              [--cross-file CROSS_FILE] [-v] [--fatal-meson-warnings]
              [--reconfigure] [--wipe] [--clearcache]
              [builddir] [sourcedir]

为 Meson 项目配置构建目录。

自 0.64.0 起已弃用:这是默认的 Meson 命令(如果没有提供 COMMAND,则会调用它)。但是,为了避免与未来添加的命令发生冲突,必须明确提供命令,因此应明确使用“setup”。

自 1.1.0 起,即使构建目录尚不存在,也允许使用 --reconfigure,在这种情况下,该参数将被忽略。

自 1.3.0 起,如果构建目录已存在,则选项将使用命令行中给出的新值(-Dopt=value)进行更新。除非还指定了 --reconfigure,否则不会立即重新配置。这与 meson configure <builddir> -Dopt=value 的行为相同。

自 1.3.0 起,可以使用 meson setup --clearcache --reconfigure <builddir> 在单个命令中清除缓存并重新配置。

positional arguments:
  builddir
  sourcedir

options:
  -h, --help                            show this help message and exit
  --prefix PREFIX                       Installation prefix.
  --bindir BINDIR                       Executable directory.
  --datadir DATADIR                     Data file directory.
  --includedir INCLUDEDIR               Header file directory.
  --infodir INFODIR                     Info page directory.
  --libdir LIBDIR                       Library directory.
  --licensedir LICENSEDIR               Licenses directory (default: ).
  --libexecdir LIBEXECDIR               Library executable directory.
  --localedir LOCALEDIR                 Locale data directory.
  --localstatedir LOCALSTATEDIR         Localstate data directory.
  --mandir MANDIR                       Manual page directory.
  --sbindir SBINDIR                     System executable directory.
  --sharedstatedir SHAREDSTATEDIR       Architecture-independent data directory.
  --sysconfdir SYSCONFDIR               Sysconf data directory.
  --auto-features {enabled,disabled,auto}
                                        Override value of all 'auto' features
                                        (default: auto).
  --backend {ninja,vs,vs2010,vs2012,vs2013,vs2015,vs2017,vs2019,vs2022,xcode,none}
                                        Backend to use (default: ninja).
  --genvslite {vs2022}                  Setup multiple buildtype-suffixed ninja-
                                        backend build directories, and a
                                        [builddir]_vs containing a Visual Studio
                                        meta-backend with multiple
                                        configurations that calls into them
                                        (default: vs2022).
  --buildtype {plain,debug,debugoptimized,release,minsize,custom}
                                        Build type to use (default: debug).
  --debug                               Enable debug symbols and other
                                        information
  --default-library {shared,static,both}
                                        Default library type (default: shared).
  --default-both-libraries {shared,static,auto}
                                        Default library type for both_libraries
                                        (default: shared).
  --errorlogs                           Whether to print the logs from failing
                                        tests
  --install-umask INSTALL_UMASK         Default umask to apply on permissions of
                                        installed files (default: 022).
  --layout {mirror,flat}                Build directory layout (default:
                                        mirror).
  --optimization {plain,0,g,1,2,3,s}    Optimization level (default: 0).
  --prefer-static                       Whether to try static linking before
                                        shared linking
  --stdsplit                            Split stdout and stderr in test logs
  --strip                               Strip targets on install
  --unity {on,off,subprojects}          Unity build (default: off).
  --unity-size UNITY_SIZE               Unity block size (default: (2, None,
                                        4)).
  --warnlevel {0,1,2,3,everything}      Compiler warning level to use (default:
                                        1).
  --werror                              Treat warnings as errors
  --wrap-mode {default,nofallback,nodownload,forcefallback,nopromote}
                                        Wrap mode (default: default).
  --force-fallback-for FORCE_FALLBACK_FOR
                                        Force fallback for those subprojects
                                        (default: []).
  --vsenv                               Activate Visual Studio environment
  --pkgconfig.relocatable               Generate pkgconfig files as relocatable
  --python.bytecompile PYTHON.BYTECOMPILE
                                        Whether to compile bytecode (default:
                                        (-1, 2, 0)).
  --python.install-env {auto,prefix,system,venv}
                                        Which python environment to install to
                                        (default: prefix).
  --python.platlibdir PYTHON.PLATLIBDIR
                                        Directory for site-specific, platform-
                                        specific files (default: ).
  --python.purelibdir PYTHON.PURELIBDIR
                                        Directory for site-specific, non-
                                        platform-specific files (default: ).
  --python.allow-limited-api            Whether to allow use of the Python
                                        Limited API
  --pkg-config-path PKG_CONFIG_PATH     List of additional paths for pkg-config
                                        to search (default: []). (just for host
                                        machine)
  --build.pkg-config-path BUILD.PKG_CONFIG_PATH
                                        List of additional paths for pkg-config
                                        to search (default: []). (just for build
                                        machine)
  --cmake-prefix-path CMAKE_PREFIX_PATH
                                        List of additional prefixes for cmake to
                                        search (default: []). (just for host
                                        machine)
  --build.cmake-prefix-path BUILD.CMAKE_PREFIX_PATH
                                        List of additional prefixes for cmake to
                                        search (default: []). (just for build
                                        machine)
  -D option                             Set the value of an option, can be used
                                        several times to set multiple options.
  --native-file NATIVE_FILE             File containing overrides for native
                                        compilation environment.
  --cross-file CROSS_FILE               File describing cross compilation
                                        environment.
  -v, --version                         show program's version number and exit
  --fatal-meson-warnings                Make all Meson warnings fatal
  --reconfigure                         Set options and reconfigure the project.
                                        Useful when new options have been added
                                        to the project and the default value is
                                        not working.
  --wipe                                Wipe build directory and reconfigure
                                        using previous command line options.
                                        Useful when build directory got
                                        corrupted, or when rebuilding with a
                                        newer version of meson.
  --clearcache                          Clear cached state (e.g. found
                                        dependencies). Since 1.3.0.

有关更多信息,请参阅 Meson 简介页面

示例

使用默认值配置 builddir

meson setup builddir

subprojects

(自 0.49.0 起)

$ meson subprojects [-h]
                    {update,checkout,download,foreach,purge,packagefiles}
                    ...

管理 Meson 项目的子项目。自 0.59.0 起,默认情况下,命令会在多个子项目上并行运行,如果不需要并行运行,请使用 --num-processes=1

0.64.0 起,update 子命令不再从 WrapDB 下载新的 wrap 文件。请改用 meson wrap update 命令。

options:
  -h, --help                            show this help message and exit

Commands:
  {update,checkout,download,foreach,purge,packagefiles}
    update                              Update all subprojects from wrap files
    checkout                            Checkout a branch (git only)
    download                            Ensure subprojects are fetched, even if
                                        not in use. Already downloaded
                                        subprojects are not modified. This can
                                        be used to pre-fetch all subprojects and
                                        avoid downloads during configure.
    foreach                             Execute a command in each subproject
                                        directory.
    purge                               Remove all wrap-based subproject
                                        artifacts
    packagefiles                        Manage the packagefiles overlay

test

$ meson test [-h] [--maxfail MAXFAIL] [--repeat REPEAT] [--no-rebuild]
             [--gdb] [--gdb-path GDB_PATH] [-i] [--list]
             [--wrapper WRAPPER] [-C WD] [--suite SUITE] [--no-suite SUITE]
             [--no-stdsplit] [--print-errorlogs] [--benchmark]
             [--logbase LOGBASE] [-j NUM_PROCESSES] [-v] [-q]
             [-t TIMEOUT_MULTIPLIER] [--setup SETUP]
             [--test-args TEST_ARGS] [--max-lines MAX_LINES]
             [args ...]

运行已配置的 Meson 项目的测试。

positional arguments:
  args                                  Optional list of test names to run.
                                        "testname" to run all tests with that
                                        name, "subprojname:testname" to
                                        specifically run "testname" from
                                        "subprojname", "subprojname:" to run all
                                        tests defined by "subprojname".

options:
  -h, --help                            show this help message and exit
  --maxfail MAXFAIL                     Number of failing tests before aborting
                                        the test run. (default: 0, to disable
                                        aborting on failure)
  --repeat REPEAT                       Number of times to run the tests.
  --no-rebuild                          Do not rebuild before running tests.
  --gdb                                 Run test under gdb.
  --gdb-path GDB_PATH                   Path to the gdb binary (default: gdb).
  -i, --interactive                     Run tests with interactive input/output.
  --list                                List available tests.
  --wrapper WRAPPER                     wrapper to run tests with (e.g.
                                        Valgrind)
  -C WD                                 directory to cd into before running
  --suite SUITE                         Only run tests belonging to the given
                                        suite.
  --no-suite SUITE                      Do not run tests belonging to the given
                                        suite.
  --no-stdsplit                         Do not split stderr and stdout in test
                                        logs.
  --print-errorlogs                     Whether to print failing tests' logs.
  --benchmark                           Run benchmarks instead of tests.
  --logbase LOGBASE                     Base name for log file.
  -j NUM_PROCESSES, --num-processes NUM_PROCESSES
                                        How many parallel processes to use.
  -v, --verbose                         Do not redirect stdout and stderr
  -q, --quiet                           Produce less output to the terminal.
  -t TIMEOUT_MULTIPLIER, --timeout-multiplier TIMEOUT_MULTIPLIER
                                        Define a multiplier for test timeout,
                                        for example when running tests in
                                        particular conditions they might take
                                        more time to execute. (<= 0 to disable
                                        timeout)
  --setup SETUP                         Which test setup to use.
  --test-args TEST_ARGS                 Arguments to pass to the specified
                                        test(s) or all tests
  --max-lines MAX_LINES                 Maximum number of lines to show from a
                                        long test log. Since 1.5.0.

有关更多信息,请参阅 单元测试文档

1.2.0 起,您可以在 args 中使用通配符来匹配测试名称。例如,“bas*”将匹配所有以“bas”开头的测试名称。

1.2.0 起,提供与任何测试都不匹配的测试名称或通配符将导致错误。

示例

运行项目的测试

meson test -C builddir

只运行 specific_test_1specific_test_2

meson test -C builddir specific_test_1 specific_test_2

wrap

$ meson wrap [-h]
             {list,search,install,update,info,status,promote,update-db} ...

用于管理 WrapDB 依赖项的实用程序。

options:
  -h, --help                            show this help message and exit

Commands:
  {list,search,install,update,info,status,promote,update-db}
    list                                show all available projects
    search                              search the db by name
    install                             install the specified project
    update                              Update wrap files from WrapDB (Since
                                        0.63.0)
    info                                show available versions of a project
    status                              show installed and available versions of
                                        your projects
    promote                             bring a subsubproject up to the master
                                        project
    update-db                           Update list of projects available in
                                        WrapDB (Since 0.61.0)

有关更多信息,请参阅 WrapDB 工具文档

devenv

(自 0.58.0 起)

$ meson devenv [-h] [-C BUILDDIR] [--workdir WORKDIR] [--dump [DUMP]]
               [--dump-format {sh,export,vscode}]
               ...

运行命令,或者如果没有提供命令,则打开交互式 shell,并设置环境以便从构建目录运行项目,无需安装。

我们自动处理 bash 并相应地设置 $PS1。如果不需要自动 $PS1 覆盖(也许您有一个花哨的自定义提示),请设置 $MESON_DISABLE_PS1_OVERRIDE 环境变量,并在设置自定义提示时使用 $MESON_PROJECT_NAME,例如使用以下代码片段

...
if [[ -n "${MESON_PROJECT_NAME-}" ]];
then
  PS1+="[ ${MESON_PROJECT_NAME} ]"
fi
...

除了使用 meson.add_devenv() 设置的变量之外,还会在环境中设置以下变量。

  • MESON_DEVENV 定义为 '1'
  • MESON_PROJECT_NAME 定义为主项目的名称。
  • PKG_CONFIG_PATH 包含 Meson 生成 -uninstalled.pc 文件的目录。
  • PATH 包含每个目录,其中包含将安装到 bindir 中的可执行文件。在 Windows 上,它还包含每个包含运行这些可执行文件所需的 DLL 的目录。
  • LD_LIBRARY_PATH 包含每个目录,其中包含将安装到 libdir 中的共享库。这允许使用某些库的自定义构建来运行系统应用程序。例如,在从 git 构建 GTK 时,运行系统 GEdit。在 OSX 上,环境变量为 DYLD_LIBRARY_PATH,在 Windows 上为 PATH
  • GI_TYPELIB_PATH 包含每个包含 GObject Introspection 类型库的目录。在使用 gnome.generate_gir() 时,会自动设置此变量。
  • GSETTINGS_SCHEMA_DIR 自 0.59.0 起 包含每个包含 GSettings 架构的目录。在使用 gnome.compile_schemas() 时,会自动设置此变量。请注意,当在多个目录中使用 gnome.compile_schemas() 时,这需要 GLib >= 2.64。
  • QEMU_LD_PREFIX 自 1.0.0 起 设置为交叉编译时交叉文件中的 sys_root 值,并且该属性已定义。

自 0.62.0 起,如果正在安装 bash-completion 脚本,并且 shell 是 bash,则它们将被自动源代码化。

自 0.62.0 起,当使用与正在构建的库名称匹配的库名称安装 GDB 帮助程序脚本(*-gdb.py、*-gdb.gdb 和 *-gdb.csm)时,Meson 会将所需的自动加载命令添加到 <builddir>/.gdbinit 文件中。从顶层构建目录运行 gdb 时,该文件将由 gdb 自动加载。在需要加载其他 Python 模块的 Python 脚本的情况下,可能需要使用 meson.add_devenv() 修改 PYTHONPATH

自 0.63.0 起,在交叉编译到 Windows 时,使用 WINEPATH 代替 PATH,这允许使用 wine 运行 Windows 可执行文件。请注意,由于 WINEPATH 的大小目前限制为 1024 个字符,因此使用相对于构建目录根目录的路径。这意味着在使用 wine 运行时,当前工作目录必须是构建目录的根目录。

自 1.1.0 起meson devenv --dump [<filename>] 命令接受可选的文件名参数,以便将环境写入文件而不是打印到标准输出。

自 1.1.0 起,添加了 --dump-format 参数以选择应使用哪个 shell 格式。目前支持 3 种格式

  • sh:行采用 VAR=/prepend:$VAR:/append 格式。
  • export:与 sh 相同,但增加了 export VAR 行。
  • vscode:与 sh 相同,但没有 $VAR 替换,因为它们似乎没有得到 vscode 的正确支持。
positional arguments:
  command                           Command to run in developer environment
                                    (default: interactive shell)

options:
  -h, --help                        show this help message and exit
  -C BUILDDIR                       Path to build directory
  --workdir WORKDIR, -w WORKDIR     Directory to cd into before running
                                    (default: builddir, Since 1.0.0)
  --dump [DUMP]                     Only print required environment (Since
                                    0.62.0) Takes an optional file path (Since
                                    1.1.0)
  --dump-format {sh,export,vscode}  Format used with --dump (Since 1.1.0)

format

(自 1.5.0 起)

$ meson format [-h] [-q | -i] [-r] [-c meson.format] [-e] [-o OUTPUT]
               [sources ...]

格式化指定的 meson.build 文档。为了与 muon 兼容,fmtformat 的别名。

positional arguments:
  sources                               meson source files

options:
  -h, --help                            show this help message and exit
  -q, --check-only                      exit with 1 if files would be modified
                                        by meson format
  -i, --inplace                         format files in-place
  -r, --recursive                       recurse subdirs (requires --check-only
                                        or --inplace option)
  -c meson.format, --configuration meson.format
                                        read configuration from meson.format
  -e, --editor-config                   try to read configuration from
                                        .editorconfig
  -o OUTPUT, --output OUTPUT            output file (implies having exactly one
                                        input)

配置文件是一个 .ini 文件。如果在提供的构建文件旁边存在 meson.format 文件,并且命令行中没有提供配置文件,则自动使用 meson.format 文件。

如果命令行中没有提供构建文件,则会分析当前目录中的 meson.build 文件。

识别以下选项:

  • max_line_length (int): 当数组、字典、函数或方法的长度超过此值时,将每行格式化为一个参数(默认值为 80)。
  • indent_by (str): 要使用的缩进(默认值为四个空格 ' ')。
  • space_array (bool): 是否在 [] 和数组参数之间添加空格(默认值为 false)。
  • kwargs_force_multiline (bool): 如果为 true,一旦出现关键字参数,参数就会每行格式化一个(默认值为 false)。
  • wide_colon (bool): 如果为 true,在字典和关键字参数中的冒号之前添加空格(默认值为 false)。
  • no_single_comma_function (bool): 如果为 true,即使使用多行参数,如果只有一个参数,则永远不会在函数参数后面追加逗号(默认值为 false)。
  • end_of_line ('cr', 'lf', 'crlf', 'native'): 要使用的行尾(在使用 --output--inline 参数时应用)(默认值为 'native)。
  • indent_before_comments (str): 行内注释之前要使用的缩进(默认值为两个空格 ' ')。
  • simplify_string_literals (bool): 当为 true 时,如果多行字符串不包含换行符,则将其转换为单行字符串。如果格式化字符串不包含替换,则将其转换为普通字符串(默认值为 true)。
  • insert_final_newline (bool): 如果为 true,强制 meson.build 文件以换行符结尾(默认值为 true)。
  • tab_width (int): 制表符的宽度,用于计算 indent_by 使用制表符时的行长(默认值为 4)。
  • sort_files (bool): 当为 true 时,files() 函数的参数按字母顺序排序(默认值为 false)。
  • group_arg_value (bool): 当为 true 时,以 -- 开头的字符串参数,后面跟着没有 -- 的字符串参数,在多行参数中将分组到同一行(默认值为 false)。
  • use_editor_config (bool): 当为 true 时,也会使用来自 .editorconfig 的配置。

前六个选项与 muon fmt 命令相同。

还可以通过在命令行中提供 --editor-config 选项,或在配置文件中使用 use_editor_config 选项来使用 .editorconfig 文件。

当指定 --recursive 选项时,还会分析来自 subdirmeson.build 文件(必须与 --inplace--check-only 选项一起使用)。

muon fmt 的区别

meson format 命令应该与 muon fmt 命令兼容。但是,它具有更多功能,并且存在一些差异

  • 默认情况下,meson format 在行内注释之前放置两个空格,而 muon fmt 只放置一个空格。
  • muon fmt 可能会混合 crlf 和 lf 行尾,因为它不了解它们。meson format 在其产生的输出中始终保持一致。
  • muon fmt 只识别来自 .editorconfig 文件的 indent_by 选项。meson format 还识别 max_line_lengthend_of_lineinsert_final_newlinetab_width 选项。
  • meson format 有许多额外的格式规则(见上面的选项列表)。

搜索结果如下: