Chiebot-Mirror
/
meson
mirror of https://github.com/mesonbuild/meson.git
8
0
Fork 0
Code Issues Projects Releases Wiki Activity

[Docs] Built-in options page cleanup (fixes #5165) [skip ci]

Browse Source 
- Added missing universal options.
- Split options in `directories` and `core` groups.
- Sorted alphabetically some of the groups.
- Removed `cross-file` from options, since it's not an option.
pull/5178/head
TheQwertiest 6 years ago committed by Jussi Pakkanen
parent 3b7ec01692
commit c0d287c1bf
1 changed files with 28 additions and 19 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 47
      docs/markdown/Builtin-options.md

47
docs/markdown/Builtin-options.md
Unescape View File

@ -24,30 +24,23 @@ Installation options are all relative to the prefix, except:
* When the prefix is `/usr`: `sysconfdir` defaults to `/etc`, `localstatedir` defaults to `/var`, and `sharedstatedir` defaults to `/var/lib`
* When the prefix is `/usr/local`: `localstatedir` defaults to `/var/local`, and `sharedstatedir` defaults to `/var/local/lib`
### Directories
| Option | Default value | Description |
| ------ | ------------- | ----------- |
| prefix | see below | Installation prefix |
| libdir | see below | Library directory |
| libexecdir | libexec | Library executable directory |
| bindir | bin | Executable directory |
| sbindir | sbin | System executable directory |
| includedir | include | Header file directory |
| datadir | share | Data file directory |
| mandir | share/man | Manual page directory |
| includedir | include | Header file directory |
| infodir | share/info | Info page directory |
| libdir | see below | Library directory |
| libexecdir | libexec | Library executable directory |
| localedir | share/locale | Locale data directory |
| sysconfdir | etc | Sysconf data directory |
| localstatedir | var | Localstate data directory |
| mandir | share/man | Manual page directory |
| sbindir | sbin | System executable directory |
| sharedstatedir | com | Architecture-independent data directory |
| werror | false | Treat warnings as errors |
| warning_level {0, 1, 2, 3} | 1 | Set the warning level. From 0 = none to 3 = highest |
| layout {mirror,flat} | mirror | Build directory layout. |
| default_library {shared, static, both} | shared | Default library type. |
| backend {ninja, vs,<br>vs2010, vs2015, vs2017, xcode} | | Backend to use (default: ninja). |
| stdsplit | | Split stdout and stderr in test logs. |
| errorlogs | | Whether to print the logs from failing tests. |
| cross-file CROSS_FILE | | File describing cross compilation environment. |
| wrap-mode {default, nofallback, nodownload, forcefallback} | | Special wrap mode to use |
| sysconfdir | etc | Sysconf data directory |
`prefix` defaults to `C:/` on Windows, and `/usr/local/` otherwise. You should always
@ -57,9 +50,25 @@ override this value.
implementation is [currently buggy](https://github.com/mesonbuild/meson/issues/2038)
on Linux platforms.
There are various other options to set, for instance the backend to use and
the path to the cross-file while cross compiling, which won't be repeated here.
Please see the output of `meson --help`.
### Core options
| Option | Default value | Description |
| ------ | ------------- | ----------- |
| auto_features {enabled, disabled, auto} | auto | Override value of all 'auto' features |
| backend {ninja, vs,<br>vs2010, vs2015, vs2017, xcode} | ninja | Backend to use |
| buildtype {plain, debug,<br>debugoptimized, release, minsize, custom} | debug | Build type to use |
| debug | true | Debug |
| default_library {shared, static, both} | shared | Default library type |
| errorlogs | true | Whether to print the logs from failing tests. |
| install_umask {preserve, 0000-0777} | 022 | Default umask to apply on permissions of installed files |
| layout {mirror,flat} | mirror | Build directory layout |
| optimization {0, g, 1, 2, 3, s} | 0 | Optimization level |
| stdsplit | true | Split stdout and stderr in test logs |
| strip | false | Strip targets on install |
| unity {on, off, subprojects} | off | Unity build |
| warning_level {0, 1, 2, 3} | 1 | Set the warning level. From 0 = none to 3 = highest |
| werror | false | Treat warnings as errors |
| wrap-mode {default, nofallback,<br>nodownload, forcefallback} | default | Wrap mode to use |
## Base options
@ -77,7 +86,6 @@ platforms or with all compilers:
| b_bitcode | false | true, false | Embed Apple bitcode, see below |
| b_colorout | always | auto, always, never | Use colored output |
| b_coverage | false | true, false | Enable coverage tracking |
| b_vscrt | from_buildtype| none, md, mdd, mt, mtd, from_buildtype | VS runtime library to use (since 0.48.0) |
| b_lundef | true | true, false | Don't allow undefined symbols when linking |
| b_lto | false | true, false | Use link time optimization |
| b_ndebug | false | true, false, if-release | Disable asserts |
@ -86,6 +94,7 @@ platforms or with all compilers:
| b_sanitize | none | see below | Code sanitizer to use |
| b_staticpic | true | true, false | Build static libraries as position independent |
| b_pie | false | true, false | Build position-independent executables (since 0.49.0)|
| b_vscrt | from_buildtype| none, md, mdd, mt, mtd, from_buildtype | VS runtime library to use (since 0.48.0) |
The value of `b_sanitize` can be one of: `none`, `address`, `thread`,
`undefined`, `memory`, `address,undefined`.

Write Preview
Loading…
Cancel
Save