diff options
Diffstat (limited to 'docs/markdown/Build-options.md')
| -rw-r--r-- | docs/markdown/Build-options.md | 49 |
1 files changed, 26 insertions, 23 deletions
diff --git a/docs/markdown/Build-options.md b/docs/markdown/Build-options.md index 429b9b2..4a0b178 100644 --- a/docs/markdown/Build-options.md +++ b/docs/markdown/Build-options.md @@ -66,16 +66,16 @@ empty. The `value` parameter specifies the default value of the option and if it is unset then the values of `choices` will be used as the default. -As of 0.47.0 -Dopt= and -Dopt=[] both pass an empty list, before this -Dopt= -would pass a list with an empty string. +As of 0.47.0 -Dopt= and -Dopt=[] both pass an empty list, before this +-Dopt= would pass a list with an empty string. This type is available since version 0.44.0 ### Features -A `feature` option has three states: `enabled`, `disabled` or `auto`. It is intended -to be passed as value for the `required` keyword argument of most functions. -Currently supported in +A `feature` option has three states: `enabled`, `disabled` or `auto`. +It is intended to be passed as value for the `required` keyword +argument of most functions. Currently supported in [`dependency()`](Reference-manual.md#dependency), [`find_library()`](Reference-manual.md#compiler-object), [`find_program()`](Reference-manual.md#find_program) and @@ -85,10 +85,11 @@ Currently supported in - `auto` is the same as passing `required : false`. - `disabled` do not look for the dependency and always return 'not-found'. -When getting the value of this type of option using `get_option()`, a special -[feature option object](Reference-manual.md#feature-option-object) -is returned instead of the string representation of the option's value. -This object can be passed to `required`: +When getting the value of this type of option using `get_option()`, a +special [feature option +object](Reference-manual.md#feature-option-object) is returned instead +of the string representation of the option's value. This object can be +passed to `required`: ```meson d = dependency('foo', required : get_option('myfeature')) @@ -112,13 +113,14 @@ if get_option('myfeature').enabled() endif ``` -If the value of a `feature` option is set to `auto`, that value is overridden by -the global `auto_features` option (which defaults to `auto`). This is intended -to be used by packagers who want to have full control on which dependencies are -required and which are disabled, and not rely on build-deps being installed -(at the right version) to get a feature enabled. They could set -`auto_features=enabled` to enable all features and disable explicitly only the -few they don't want, if any. +If the value of a `feature` option is set to `auto`, that value is +overridden by the global `auto_features` option (which defaults to +`auto`). This is intended to be used by packagers who want to have +full control on which dependencies are required and which are +disabled, and not rely on build-deps being installed (at the right +version) to get a feature enabled. They could set +`auto_features=enabled` to enable all features and disable explicitly +only the few they don't want, if any. This type is available since version 0.47.0 @@ -200,8 +202,8 @@ option. ## Built-in build options -There are a number of [built-in options][builtin_opts]. To get the current list execute `meson -configure` in the build directory. +There are a number of [built-in options][builtin_opts]. To get the +current list execute `meson configure` in the build directory. [builtin_opts]: https://mesonbuild.com/Builtin-options.html @@ -209,9 +211,10 @@ configure` in the build directory. #### Startup project -The backend\_startup\_project option can be set to define the default project -that will be executed with the "Start debugging F5" action in visual studio. -It should be the same name as an executable target name. +The `backend_startup_project` option can be set to define the default +project that will be executed with the "Start debugging F5" action in +visual studio. It should be the same name as an executable target +name. ```meson project('my_project', 'c', default_options: ['backend_startup_project=my_exe']) @@ -222,5 +225,5 @@ executable('my_exe', ...) #### Max links -The backend\_max\_links can be set to limit the number of processes that ninja -will use to link. +The `backend_max_links` can be set to limit the number of processes +that ninja will use to link. |