aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDylan Baker <dylan@pnwbakers.com>2019-04-09 09:05:23 -0700
committerNirbheek Chauhan <nirbheek.chauhan@gmail.com>2019-04-09 16:34:10 +0000
commit67ca2d5bdce2d48e569d7bf4ebdbecc9f2e28ebf (patch)
tree504f0d7616de0717f443eb37c186ab797cc26b60 /docs
parent6fcf6dfd68d80d8e462dea34fa3be7b8010571fe (diff)
downloadmeson-67ca2d5bdce2d48e569d7bf4ebdbecc9f2e28ebf.zip
meson-67ca2d5bdce2d48e569d7bf4ebdbecc9f2e28ebf.tar.gz
meson-67ca2d5bdce2d48e569d7bf4ebdbecc9f2e28ebf.tar.bz2
docs: Document pkg_config_path and cross_ options [skip ci]
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/Builtin-options.md41
1 files changed, 24 insertions, 17 deletions
diff --git a/docs/markdown/Builtin-options.md b/docs/markdown/Builtin-options.md
index c15c520..4c76445 100644
--- a/docs/markdown/Builtin-options.md
+++ b/docs/markdown/Builtin-options.md
@@ -52,23 +52,30 @@ on Linux platforms.
### 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 |
+Options that have a separate cross option will be prefixed with
+cross\_, for example, "cross_pkg_config_path" controls the paths
+pkg-config will search for host dependencies in a cross compile.
+They have no effect when the host and build machines are the same.
+
+
+| Option | Default value | Description | Has Separate cross |
+| ------ | ------------- | ----------- | ------------------ |
+| auto_features {enabled, disabled, auto} | auto | Override value of all 'auto' features | no |
+| backend {ninja, vs,<br>vs2010, vs2015, vs2017, xcode} | ninja | Backend to use | no |
+| buildtype {plain, debug,<br>debugoptimized, release, minsize, custom} | debug | Build type to use | no |
+| debug | true | Debug | no |
+| default_library {shared, static, both} | shared | Default library type | no |
+| errorlogs | true | Whether to print the logs from failing tests. | no |
+| install_umask {preserve, 0000-0777} | 022 | Default umask to apply on permissions of installed files | no |
+| layout {mirror,flat} | mirror | Build directory layout | no |
+| optimization {0, g, 1, 2, 3, s} | 0 | Optimization level | no |
+| stdsplit | true | Split stdout and stderr in test logs | no |
+| strip | false | Strip targets on install | no |
+| unity {on, off, subprojects} | off | Unity build | no |
+| warning_level {0, 1, 2, 3} | 1 | Set the warning level. From 0 = none to 3 = highest | no |
+| werror | false | Treat warnings as errors | no |
+| wrap-mode {default, nofallback,<br>nodownload, forcefallback} | default | Wrap mode to use | no |
+| pkg_config_path {OS separated path} | '' | Additional paths for pkg-config to search before builtin paths | yes |
## Base options