diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/markdown/snippets/buildtyperemains.md | 8 | ||||
| -rw-r--r-- | docs/markdown/snippets/cmake_package_version.md | 4 | ||||
| -rw-r--r-- | docs/markdown/snippets/customtarget_env.md | 4 | ||||
| -rw-r--r-- | docs/markdown/snippets/destdir.md | 8 | ||||
| -rw-r--r-- | docs/markdown/snippets/dist_subproject.md | 2 | ||||
| -rw-r--r-- | docs/markdown/snippets/external_project.md | 10 | ||||
| -rw-r--r-- | docs/markdown/snippets/meson_test_depends.md | 5 | ||||
| -rw-r--r-- | docs/markdown/snippets/meson_test_logs.md | 12 | ||||
| -rw-r--r-- | docs/markdown/snippets/pass_file_to_add_script.md | 2 | ||||
| -rw-r--r-- | docs/markdown/snippets/rewrite_allow_double_slash_project_id.md | 6 | ||||
| -rw-r--r-- | docs/markdown/snippets/rust_std_option.md | 8 | ||||
| -rw-r--r-- | docs/markdown/snippets/rust_test_format_support.md | 4 | ||||
| -rw-r--r-- | docs/markdown/snippets/summary_alignment.md | 6 | ||||
| -rw-r--r-- | docs/markdown/snippets/unstable-rust-module.md | 4 | ||||
| -rw-r--r-- | docs/markdown/snippets/versionfile.md | 6 |
15 files changed, 46 insertions, 43 deletions
diff --git a/docs/markdown/snippets/buildtyperemains.md b/docs/markdown/snippets/buildtyperemains.md index 4eb6243..4b27187 100644 --- a/docs/markdown/snippets/buildtyperemains.md +++ b/docs/markdown/snippets/buildtyperemains.md @@ -5,6 +5,8 @@ Setting the `buildtype' option to a value sets the `debug` and options to other values would then change the buildtype to `custom`. This is confusing and means that you can't use, for example, debug level `g` in `debug` buildtype even though it would make sense under -many circumstances. Starting with the buildtype is only changed when -the user explicitly sets it. Setting the build type sets the other -options to their default values as before.
\ No newline at end of file +many circumstances. + +Starting with this release, the buildtype is only changed when the user +explicitly sets it; setting the build type modifies the `debug` and +`optimization` options as before. diff --git a/docs/markdown/snippets/cmake_package_version.md b/docs/markdown/snippets/cmake_package_version.md index 58f0004..72446dd 100644 --- a/docs/markdown/snippets/cmake_package_version.md +++ b/docs/markdown/snippets/cmake_package_version.md @@ -1,5 +1,5 @@ -## CMake find_package version support +## CMake `find_package` version support -It is now possible to specify a requested package version to the CMake +It is now possible to specify a requested package version for the CMake dependency backend via the new `cmake_package_version` kwarg in the `dependency` function. diff --git a/docs/markdown/snippets/customtarget_env.md b/docs/markdown/snippets/customtarget_env.md index 93687ab..69bfc0d 100644 --- a/docs/markdown/snippets/customtarget_env.md +++ b/docs/markdown/snippets/customtarget_env.md @@ -1,6 +1,6 @@ -## custom_target() now accepts `env` keyword argument +## `custom_target()` now accepts an `env` keyword argument -Environment variables can now be passed to `custom_target()` command. +Environment variables can now be passed to the `custom_target()` command. ```meson env = environment() diff --git a/docs/markdown/snippets/destdir.md b/docs/markdown/snippets/destdir.md index d8cf55d..c698c99 100644 --- a/docs/markdown/snippets/destdir.md +++ b/docs/markdown/snippets/destdir.md @@ -1,11 +1,11 @@ ## Specify DESTDIR on command line -`meson install` command now has `--destdir` argument that overrides DESTDIR +`meson install` command now has a `--destdir` argument that overrides `DESTDIR` from environment. ## Skip install scripts if DESTDIR is set `meson.add_install_script()` now has `skip_if_destdir` keyword argument. If set -to `true` the script won't be run if DESTDIR is set during installation. This is -useful in the case the script updates system wide cache that is only needed when -copying files into final destination. +to `true` the script won't be run if `DESTDIR` is set during installation. This is +useful in the case the script updates system wide caches, or performs other tasks +that are only needed when copying files into final destination. diff --git a/docs/markdown/snippets/dist_subproject.md b/docs/markdown/snippets/dist_subproject.md index 2520ccd..a3127dd 100644 --- a/docs/markdown/snippets/dist_subproject.md +++ b/docs/markdown/snippets/dist_subproject.md @@ -1,4 +1,4 @@ -## Package a subproject +## Packaging a subproject The `meson dist` command can now create a distribution tarball for a subproject in the same git repository as the main project. This can be useful if parts of diff --git a/docs/markdown/snippets/external_project.md b/docs/markdown/snippets/external_project.md index b48dc35..1608d49 100644 --- a/docs/markdown/snippets/external_project.md +++ b/docs/markdown/snippets/external_project.md @@ -4,8 +4,10 @@ in `configure_options`: `'--prefix=@PREFIX@'`, `'--libdir=@PREFIX@/@LIBDIR@'`, and `'--includedir=@PREFIX@/@INCLUDEDIR@'`. It was previously considered a fatal error to not specify them. -- When `verbose` keyword argument is not specified, or is false, command outputs + +- When the `verbose` keyword argument is not specified, or is false, command outputs are written on file in `<builddir>/meson-logs/`. -- `LD` environment variable is not passed any more when running the configure - script. It caused issues because Meson uses CC as linker wrapper but autotools - expects to real linker (e.g. `/usr/bin/ld`). + +- The `LD` environment variable is not passed any more when running the configure + script. It caused issues because Meson sets `LD` to the `CC` linker wrapper but + autotools expects it to be a real linker (e.g. `/usr/bin/ld`). diff --git a/docs/markdown/snippets/meson_test_depends.md b/docs/markdown/snippets/meson_test_depends.md index 09d78f1..905c59f 100644 --- a/docs/markdown/snippets/meson_test_depends.md +++ b/docs/markdown/snippets/meson_test_depends.md @@ -12,6 +12,5 @@ using commands like the following: This would find the broken commit automatically while at each step rebuilding only those pieces of code needed to run the test. -However, this change could cause failures if dependencies are not -specified correctly in `meson.build`. - +However, this change could cause failures when upgrading to 0.57, ifthe +dependencies are not specified correctly in `meson.build`. diff --git a/docs/markdown/snippets/meson_test_logs.md b/docs/markdown/snippets/meson_test_logs.md index b3f5a16..965ba6c 100644 --- a/docs/markdown/snippets/meson_test_logs.md +++ b/docs/markdown/snippets/meson_test_logs.md @@ -5,19 +5,19 @@ The major changes are: * if stdout is a tty, `meson` includes a progress report. -* if `--print-errorlogs` is specified, the logs are printed as test runs +* if `--print-errorlogs` is specified, the logs are printed as tests run rather than afterwards. All the error logs are printed rather than only the first ten. * if `--verbose` is specified and `--num-processes` specifies more than one concurrent test, test output is buffered and printed after the -test finishes +test finishes. * the console logs include a reproducer command. If `--verbose` is -specified, the command is printed for all tests at the time they starts; -otherwise, it is printed for failing tests at the time the test finishes +specified, the command is printed for all tests at the time they start; +otherwise, it is printed for failing tests at the time the test finishes. -* for TAP tests, Meson is able to report individual subtests. If +* for TAP and Rust tests, Meson is able to report individual subtests. If `--verbose` is specified, all tests are reported. If `--print-errorlogs` is specified, only failures are. @@ -25,5 +25,5 @@ In addition, if `--verbose` was specified, Meson used not to generate logs. This limitation has now been removed. These changes make the default `ninja test` output more readable, while -`--verbose` output is provides detailed but human-readable logs that +`--verbose` output provides detailed, human-readable logs that are well suited to CI environments. diff --git a/docs/markdown/snippets/pass_file_to_add_script.md b/docs/markdown/snippets/pass_file_to_add_script.md index 10d08e0..96a4aa2 100644 --- a/docs/markdown/snippets/pass_file_to_add_script.md +++ b/docs/markdown/snippets/pass_file_to_add_script.md @@ -1,7 +1,7 @@ ## The `add_*_script` methods now accept a File as the first argument Meson now accepts `file` objects, including those produced by -`configure_file` as the `prog` (first) parameter of the various +`configure_file`, as the first parameter of the various `add_*_script` methods ```meson diff --git a/docs/markdown/snippets/rewrite_allow_double_slash_project_id.md b/docs/markdown/snippets/rewrite_allow_double_slash_project_id.md index 9448ce6..1fa32f7 100644 --- a/docs/markdown/snippets/rewrite_allow_double_slash_project_id.md +++ b/docs/markdown/snippets/rewrite_allow_double_slash_project_id.md @@ -2,6 +2,6 @@ msys bash may expand `/` to a path, breaking `meson rewrite kwargs set project / ...`. Passing `//` will be converted to -`/` by msys bash but in order to keep usage shell-agnostic, also allow `//` -as the id such that `meson rewrite kwargs set project // ...` will work in -both msys bash and other shells. +`/` by msys bash but in order to keep usage shell-agnostic, this release +also allows `//` as the id. This way, `meson rewrite kwargs set project +// ...` will work in both msys bash and other shells. diff --git a/docs/markdown/snippets/rust_std_option.md b/docs/markdown/snippets/rust_std_option.md index f2efdb9..5b1ba3d 100644 --- a/docs/markdown/snippets/rust_std_option.md +++ b/docs/markdown/snippets/rust_std_option.md @@ -1,5 +1,5 @@ -## Rust now has a a standard option +## Rust now has an `std` option -Rust calls these `editions`, however, meson generally refers to such language -versions as "standards", or "std" for short. Rust uses "std" to keep normalize -it with other languages. +Rust calls these `editions`, however, Meson generally refers to such language +versions as "standards", or `std` for short. Therefore, Meson's Rust support +uses `std` for consistency with other languages. diff --git a/docs/markdown/snippets/rust_test_format_support.md b/docs/markdown/snippets/rust_test_format_support.md index 69e9aa1..969eb57 100644 --- a/docs/markdown/snippets/rust_test_format_support.md +++ b/docs/markdown/snippets/rust_test_format_support.md @@ -1,4 +1,4 @@ ## Meson test() now accepts `protocol : 'rust'` -This allows native rust tests to be run and parsed by meson, simply set the -protocol to `rust` and meson takes care of the rest. +This allows native Rust tests to be run and parsed by Meson; simply set the +protocol to `rust` and Meson takes care of the rest. diff --git a/docs/markdown/snippets/summary_alignment.md b/docs/markdown/snippets/summary_alignment.md index 78a7541..49e8748 100644 --- a/docs/markdown/snippets/summary_alignment.md +++ b/docs/markdown/snippets/summary_alignment.md @@ -1,4 +1,4 @@ -## summary() now uses left alignment for all values +## `summary()` now uses left alignment for both keys and values -Previously it aligned toward the center, but this was deemed harder to read -than all left aligned. +Previously it aligned keys toward the center, but this was deemed harder +to read than having everything left aligned. diff --git a/docs/markdown/snippets/unstable-rust-module.md b/docs/markdown/snippets/unstable-rust-module.md index 15a7ecb..9870298 100644 --- a/docs/markdown/snippets/unstable-rust-module.md +++ b/docs/markdown/snippets/unstable-rust-module.md @@ -1,4 +1,4 @@ ## Untable Rust module -A new unstable module has been added to make using rust with meson easier. -Currently it adds a single function to ease defining rust tests. +A new unstable module has been added to make using Rust with meson easier. +Currently it adds a single function to ease defining Rust tests. diff --git a/docs/markdown/snippets/versionfile.md b/docs/markdown/snippets/versionfile.md index 6071f2c..a18803e 100644 --- a/docs/markdown/snippets/versionfile.md +++ b/docs/markdown/snippets/versionfile.md @@ -1,12 +1,12 @@ ## Project version can be specified with a file -Meson can be instructed to load project's version string from an +Meson can be instructed to load a project's version string from an external file like this: ```meson project('foo', 'c' version: files('VERSION')) ``` -The version file must contain exactly one line of text and that will -be set as the project's version. If the line ends in a newline +The version file must contain exactly one line of text which will +be used as the project's version. If the line ends in a newline character, it is removed. |