diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/markdown/Contributing.md | 10 | ||||
| -rw-r--r-- | docs/markdown/External-Project-module.md | 4 | ||||
| -rw-r--r-- | docs/markdown/Reference-manual.md | 8 | ||||
| -rw-r--r-- | docs/markdown/Vala.md | 2 | ||||
| -rw-r--r-- | docs/markdown/howtox.md | 2 | ||||
| -rw-r--r-- | docs/markdown/snippets/waf.md | 5 |
6 files changed, 21 insertions, 10 deletions
diff --git a/docs/markdown/Contributing.md b/docs/markdown/Contributing.md index 77e5165..3e3ff22 100644 --- a/docs/markdown/Contributing.md +++ b/docs/markdown/Contributing.md @@ -264,15 +264,18 @@ current platform. The following values are currently supported: | type | Description | | ------------- | ------------------------------------------------------------------------------------------------------- | | `file` | No postprocessing, just use the provided path | +| `python_file` | Use the provided path while replacing the python directory. | | `dir` | To include all files inside the directory (for generated docs, etc). The path must be a valid directory | | `exe` | For executables. On Windows the `.exe` suffix is added to the path in `file` | | `shared_lib` | For shared libraries, always written as `name`. The appropriate suffix and prefix are added by platform | +| `python_lib` | For python libraries, while replacing the python directory. The appropriate suffix is added by platform | | `pdb` | For Windows PDB files. PDB entries are ignored on non Windows platforms | | `implib` | For Windows import libraries. These entries are ignored on non Windows platforms | +| `py_implib` | For Windows import libraries. These entries are ignored on non Windows platforms | | `implibempty` | Like `implib`, but no symbols are exported in the library | | `expr` | `file` is an expression. This type should be avoided and removed if possible | -Except for the `file` and `expr` types, all paths should be provided *without* a suffix. +Except for the `file`, `python_file` and `expr` types, all paths should be provided *without* a suffix. | Argument | Applies to | Description | | -----------|----------------------------|-------------------------------------------------------------------------------| @@ -284,6 +287,11 @@ parameter, `version`, this is us a string in `X.Y.Z` format that will be applied to the library. Each version to be tested must have a single version. The harness will apply this correctly per platform: +The `python_file`, `python_lib`, and `py_implib` types have basic support for configuring the string with the `@<VAR>@` syntax: + +- `@PYTHON_PLATLIB@`: python `get_install_dir` directory relative to prefix +- `@PYTHON_PURELIB@`: python `get_install_dir(pure: true)` directory relative to prefix + `pdb` takes an optional `language` argument. This determines which compiler/linker should generate the pdb file. Because it's possible to mix compilers that do and don't generate pdb files (dmd's optlink diff --git a/docs/markdown/External-Project-module.md b/docs/markdown/External-Project-module.md index 866564e..640caaf 100644 --- a/docs/markdown/External-Project-module.md +++ b/docs/markdown/External-Project-module.md @@ -63,6 +63,10 @@ directory and executable. Note that if a bootstrap script is required (e.g. `autogen.sh` when building from git instead of tarball), it can be done using `run_command()` before calling `add_project()` method. +*Since 0.60.0* If the first positional argument is `'waf'`, special treatment +is done for the [waf](https://waf.io/) build system. The waf executable must be +found either in the current directory, or in system `PATH`. + Keyword arguments: - `configure_options`: An array of strings to be passed as arguments to the diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md index fd78a1e..fd156f9 100644 --- a/docs/markdown/Reference-manual.md +++ b/docs/markdown/Reference-manual.md @@ -780,12 +780,6 @@ creating the final list. The returned object also has methods that are documented in the [object methods section](#build-target-object) below. -### find_library() - -*(since 0.31.0)* **(deprecated)** Use `find_library()` method of -[the compiler object](#compiler-object) as obtained from -`meson.get_compiler(lang)`. - ### find_program() ``` meson @@ -2865,7 +2859,7 @@ env.prepend('MY_PATH', '0') ### `external library` object -This object is returned by [`find_library()`](#find_library) and +This object is returned by [`find_library()`](#compiler-object) and contains an external (i.e. not built as part of this project) library. This object has the following methods: diff --git a/docs/markdown/Vala.md b/docs/markdown/Vala.md index d3edce0..606cf0d 100644 --- a/docs/markdown/Vala.md +++ b/docs/markdown/Vala.md @@ -38,7 +38,7 @@ map Vala code to the library's C programming interface. It is the [`pkg-config`](https://www.freedesktop.org/wiki/Software/pkg-config/) tool that makes finding these installed files all work seamlessly behind the scenes. When a `pkg-config` file doesn't exist for the -library then the [`find_library()`](Reference-manual.md#find_library) +library then the `find_library()` method of the [compiler object](Reference-manual.md#compiler-object) needs to be used. Examples are given later. diff --git a/docs/markdown/howtox.md b/docs/markdown/howtox.md index 1521f72..5c64bcb 100644 --- a/docs/markdown/howtox.md +++ b/docs/markdown/howtox.md @@ -85,7 +85,7 @@ executable(..., override_options : ['c_std=c11']) ## Enable threads -Lots of people seem to do this manually with `find_library('pthread')` +Lots of people seem to do this manually with `cc.find_library('pthread')` or something similar. Do not do that. It is not portable. Instead do this. diff --git a/docs/markdown/snippets/waf.md b/docs/markdown/snippets/waf.md new file mode 100644 index 0000000..87634a0 --- /dev/null +++ b/docs/markdown/snippets/waf.md @@ -0,0 +1,5 @@ +## Waf support in external-project module + +If the first argument is `'waf'`, special treatment is done for the +[waf](https://waf.io/) build system. The waf executable must be +found either in the current directory, or in system `PATH`. |