diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/markdown/Builtin-options.md | 6 | ||||
| -rw-r--r-- | docs/markdown/Contributing.md | 9 | ||||
| -rw-r--r-- | docs/markdown/Reference-manual.md | 58 | ||||
| -rw-r--r-- | docs/markdown/Reference-tables.md | 5 |
4 files changed, 46 insertions, 32 deletions
diff --git a/docs/markdown/Builtin-options.md b/docs/markdown/Builtin-options.md index 39db4fa..8137cff 100644 --- a/docs/markdown/Builtin-options.md +++ b/docs/markdown/Builtin-options.md @@ -12,11 +12,7 @@ universal options, base options, compiler options. A list of these options can be found by running `meson --help`. All these can be set by passing to `meson` (aka `meson setup`) in any of -these ways: - -| --option=value | -| --option value | -| -Doption=value | +these ways: `--option=value`, `--option value`, `-Doption=value`. They can also be edited after setup using `meson configure`. diff --git a/docs/markdown/Contributing.md b/docs/markdown/Contributing.md index e385be2..c0eea29 100644 --- a/docs/markdown/Contributing.md +++ b/docs/markdown/Contributing.md @@ -167,6 +167,8 @@ Continuous integration systems currently used: allows `[skip ci]` anywhere in the commit messages. - [AppVeyor](https://www.appveyor.com/docs/how-to/filtering-commits/#skip-directive-in-commit-message) requires `[skip ci]` or `[skip appveyor]` in the commit title. +- [Sider](https://sider.review) + runs Flake8 (see below) ## Documentation @@ -208,6 +210,13 @@ $ cd meson $ flake8 ``` +To run it automatically before committing: + +```console +$ flake8 --install-hook=git +$ git config --bool flake8.strict true +``` + ## C/C++ coding style Meson has a bunch of test code in several languages. The rules for diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md index 688af37..df8531c 100644 --- a/docs/markdown/Reference-manual.md +++ b/docs/markdown/Reference-manual.md @@ -1398,6 +1398,28 @@ the following methods. `MESON_INSTALL_DESTDIR_PREFIX`, and `MESONINTROSPECT` set. All additional arguments are passed as parameters. + Meson uses the `DESTDIR` environment variable as set by the + inherited environment to determine the (temporary) installation + location for files. Your install script must be aware of this while + manipulating and installing files. The correct way to handle this is + with the `MESON_INSTALL_DESTDIR_PREFIX` variable which is always set + and contains `DESTDIR` (if set) and `prefix` joined together. This + is useful because both are usually absolute paths and there are + platform-specific edge-cases in joining two absolute paths. + + In case it is needed, `MESON_INSTALL_PREFIX` is also always set and + has the value of the `prefix` option passed to Meson. + + `MESONINTROSPECT` contains the path to the introspect command that + corresponds to the `meson` executable that was used to configure the + build. (This might be a different path then the first executable + found in `PATH`.) It can be used to query build configuration. Note + that the value will contain many parts, f.ex., it may be `python3 + /path/to/meson.py introspect`. The user is responsible for splitting + the string to an array if needed by splitting lexically like a UNIX + shell would. If your script uses Python, `shlex.split()` is the + easiest correct way to do this. + - `add_postconf_script(script_name, arg1, arg2, ...)` will run the executable given as an argument after all project files have been generated. This script will have the environment variables @@ -1461,26 +1483,6 @@ the following methods. build](Unity-builds.md) (multiple sources are combined before compilation to reduce build time) and `false` otherwise. - To determine the installation location, the script should use the - `DESTDIR`, `MESON_INSTALL_PREFIX`, `MESON_INSTALL_DESTDIR_PREFIX` - variables. `DESTDIR` will be set only if it is inherited from the - outside environment. `MESON_INSTALL_PREFIX` is always set and has - the value of the `prefix` option passed to - Meson. `MESON_INSTALL_DESTDIR_PREFIX` is always set and contains - `DESTDIR` and `prefix` joined together. This is useful because both - are absolute paths, and many path-joining functions such as - [`os.path.join` in - Python](https://docs.python.org/3/library/os.path.html#os.path.join) - special-case absolute paths. - - `MESONINTROSPECT` contains the path to the introspect command that - corresponds to the `meson` executable that was used to configure the - build. (This might be a different path then the first executable - found in `PATH`.) It can be used to query build configuration. Note - that the value may contain many parts, i.e. it may be `python3 - /path/to/meson.py introspect`. The user is responsible for splitting - the string to an array if needed. - - `override_find_program(progname, program)` [*(Added 0.46.0)*](Release-notes-for-0-46-0.html#can-override-find_program) specifies that whenever `find_program` is used to find a program @@ -1954,13 +1956,13 @@ an external dependency with the following methods: - `type_name()` which returns a string describing the type of the dependency, the most common values are `internal` for deps created - with `declare_dependencies` and `pkgconfig` for system dependencies + with `declare_dependency()` and `pkgconfig` for system dependencies obtained with Pkg-config. - `version()` is the version number as a string, for example `1.2.8` - `partial_dependency(compile_args : false, link_args : false, links - : false, includes : false, source : false)` (*added 0.46.0) returns + : false, includes : false, source : false)` (*added 0.46.0*) returns a new dependency object with the same name, version, found status, type name, and methods as the object that called it. This new object will only inherit other attributes from its parent as @@ -2039,8 +2041,16 @@ if called twice with the same `varname`. This object is returned by [`find_library()`](#find_library) and contains an external (i.e. not built as part of this project) -library. This object has only one method, `found`, which returns -whether the library was found. +library. This object has the following methods: + + - `found` which returns whether the library was found. + + - `partial_dependency(compile_args : false, link_args : false, links + : false, includes : false, source : false)` (*added 0.46.0*) returns + a new dependency object with the same name, version, found status, + type name, and methods as the object that called it. This new + object will only inherit other attributes from its parent as + controlled by keyword arguments. ### `generator` object diff --git a/docs/markdown/Reference-tables.md b/docs/markdown/Reference-tables.md index b1a7bf6..6486aa2 100644 --- a/docs/markdown/Reference-tables.md +++ b/docs/markdown/Reference-tables.md @@ -49,9 +49,8 @@ set in the cross file. | aarch64 | 64 bit ARM processor | | mips | 32 bit MIPS processor | | mips64 | 64 bit MIPS processor | -| ppc | 32 bit PPC processors (Big Endian) | -| ppc64 | 64 bit PPC processors (Big Endian) | -| ppc64le | 64 bit PPC processors (Little Endian) | +| ppc | 32 bit PPC processors | +| ppc64 | 64 bit PPC processors | | e2k | MCST Elbrus processor | | parisc | HP PA-RISC processor | | sparc64 | SPARC v9 processor | |