From 8c5838bfea64c47fe2b99008b832636603560865 Mon Sep 17 00:00:00 2001 From: Elliott Sales de Andrade Date: Sat, 22 Oct 2022 16:30:01 -0400 Subject: Add missing since annotations in docs This is based on searching for `@FeatureNew*` decorators. There is also one correction to a version in a decorators; `build_by_default` was added in #1303, which is 0.38.0, not 0.40.0. --- docs/markdown/Dependencies.md | 14 +++++++------- docs/markdown/Python-module.md | 2 ++ docs/markdown/_include_qt_base.md | 4 ++-- docs/yaml/builtins/meson.yaml | 1 + docs/yaml/functions/_build_target_base.yaml | 3 ++- docs/yaml/functions/dependency.yaml | 3 ++- docs/yaml/functions/subdir_done.yaml | 1 + mesonbuild/interpreter/interpreter.py | 2 +- 8 files changed, 18 insertions(+), 12 deletions(-) diff --git a/docs/markdown/Dependencies.md b/docs/markdown/Dependencies.md index 6eab6ab..64cd24f 100644 --- a/docs/markdown/Dependencies.md +++ b/docs/markdown/Dependencies.md @@ -233,15 +233,15 @@ Support for packages which require a specified version for CMake kwarg (*introduced in 0.57.0*). The specified `cmake_package_version` will be passed directly as the second parameter to `find_package`. -It is also possible to reuse existing `Find.cmake` files with -the `cmake_module_path` property. Using this property is equivalent to -setting the `CMAKE_MODULE_PATH` variable in CMake. The path(s) given -to `cmake_module_path` should all be relative to the project source -directory. Absolute paths should only be used if the CMake files are -not stored in the project itself. +It is also possible to reuse existing `Find.cmake` files with the +`cmake_module_path` property (*since 0.50.0*). Using this property is +equivalent to setting the `CMAKE_MODULE_PATH` variable in CMake. The +path(s) given to `cmake_module_path` should all be relative to the +project source directory. Absolute paths should only be used if the +CMake files are not stored in the project itself. Additional CMake parameters can be specified with the `cmake_args` -property. +property (*since 0.50.0*). ## Dub diff --git a/docs/markdown/Python-module.md b/docs/markdown/Python-module.md index bf40ce4..c80f7e9 100644 --- a/docs/markdown/Python-module.md +++ b/docs/markdown/Python-module.md @@ -111,6 +111,8 @@ add `dependencies : py_installation.dependency()`, see [[dependency]]. python_dependency py_installation.dependency(...) ``` +*since 0.53.0* + This method accepts no positional arguments, and the same keyword arguments as the standard [[dependency]] function. It also supports the following keyword argument: diff --git a/docs/markdown/_include_qt_base.md b/docs/markdown/_include_qt_base.md index 0ecd63a..e0d4869 100644 --- a/docs/markdown/_include_qt_base.md +++ b/docs/markdown/_include_qt_base.md @@ -106,6 +106,8 @@ build target. ## has_tools +*since 0.54.0* + This method returns `true` if all tools used by this module are found, `false` otherwise. @@ -124,8 +126,6 @@ This method takes the following keyword arguments: missing Meson will abort. - `method` string: method used to find the Qt dependency (`auto` by default). -*Since: 0.54.0* - ## Dependencies See [Qt dependencies](Dependencies.md#qt4-qt5) diff --git a/docs/yaml/builtins/meson.yaml b/docs/yaml/builtins/meson.yaml index b8b1ad4..8eb3aca 100644 --- a/docs/yaml/builtins/meson.yaml +++ b/docs/yaml/builtins/meson.yaml @@ -403,6 +403,7 @@ methods: - name: project_license returns: list[str] + since: 0.45.0 description: Returns the array of licenses specified in [[project]] function call. - name: project_name diff --git a/docs/yaml/functions/_build_target_base.yaml b/docs/yaml/functions/_build_target_base.yaml index 4e7afad..589e0d2 100644 --- a/docs/yaml/functions/_build_target_base.yaml +++ b/docs/yaml/functions/_build_target_base.yaml @@ -63,6 +63,7 @@ kwargs: build_rpath: type: str + since: 0.42.0 description: | A string to add to target's rpath definition in the build dir, but which will be removed on install @@ -281,7 +282,7 @@ kwargs: rust_crate_type: type: str - since: 0.41.0 + since: 0.42.0 description: | Set the specific type of rust crate to compile (when compiling rust). diff --git a/docs/yaml/functions/dependency.yaml b/docs/yaml/functions/dependency.yaml index 3a4d2e8..d35cd2e 100644 --- a/docs/yaml/functions/dependency.yaml +++ b/docs/yaml/functions/dependency.yaml @@ -79,7 +79,7 @@ varargs: kwargs: default_options: type: list[str] - since: 0.37.0 + since: 0.38.0 description: | An array of default option values that override those set in the subproject's `meson_options.txt` @@ -131,6 +131,7 @@ kwargs: method: type: str + since: 0.40.0 default: "'auto'" description: | Defines the way the dependency is detected, the default is diff --git a/docs/yaml/functions/subdir_done.yaml b/docs/yaml/functions/subdir_done.yaml index ef878cc..1e2a349 100644 --- a/docs/yaml/functions/subdir_done.yaml +++ b/docs/yaml/functions/subdir_done.yaml @@ -1,5 +1,6 @@ name: subdir_done returns: void +since: 0.46.0 description: | Stops further interpretation of the Meson script file from the point of the invocation. All steps executed up to this point are valid and diff --git a/mesonbuild/interpreter/interpreter.py b/mesonbuild/interpreter/interpreter.py index 7f4c182..7ecc49e 100644 --- a/mesonbuild/interpreter/interpreter.py +++ b/mesonbuild/interpreter/interpreter.py @@ -3105,7 +3105,7 @@ Try setting b_lundef to false instead.'''.format(self.coredata.options[OptionKey def build_target(self, node: mparser.BaseNode, args, kwargs, targetclass): @FeatureNewKwargs('build target', '0.42.0', ['rust_crate_type', 'build_rpath', 'implicit_include_directories']) @FeatureNewKwargs('build target', '0.41.0', ['rust_args']) - @FeatureNewKwargs('build target', '0.40.0', ['build_by_default']) + @FeatureNewKwargs('build target', '0.38.0', ['build_by_default']) @FeatureNewKwargs('build target', '0.48.0', ['gnu_symbol_visibility']) def build_target_decorator_caller(self, node, args, kwargs): return True -- cgit v1.1