diff options
| author | Xavier Claessens <xavier.claessens@collabora.com> | 2023-10-21 09:47:39 -0400 |
|---|---|---|
| committer | Jussi Pakkanen <jpakkane@gmail.com> | 2023-11-24 22:15:14 +0200 |
| commit | 85e4ee5b54c334d4104e6c3b2f3fda11cd9b2dd6 (patch) | |
| tree | 556dfe82f07a9738c003ff18ff6ef2f78c679a6c /docs/yaml | |
| parent | 7f5f432ec98c1961b0b9712f36cec3ae3c5cd9f9 (diff) | |
| download | meson-85e4ee5b54c334d4104e6c3b2f3fda11cd9b2dd6.tar.gz | |
File: Add full_path() method
This is needed now that str.format() is not allowing it any more. It is
also more consistent with other objects that have that method as well,
such as build targets.
Fixes: #12406
Diffstat (limited to 'docs/yaml')
| -rw-r--r-- | docs/yaml/objects/file.yaml | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/yaml/objects/file.yaml b/docs/yaml/objects/file.yaml index 6aa0b85ce..5d2ad3053 100644 --- a/docs/yaml/objects/file.yaml +++ b/docs/yaml/objects/file.yaml @@ -1,3 +1,13 @@ name: file long_name: File -description: Opaque object that stores the path to an existing file +description: Object that stores the path to an existing file + +methods: +- name: full_path + returns: str + since: 1.4.0 + description: | + Returns a full path pointing to the file. This is useful for printing the + path with e.g [[message]] function for debugging purpose. + **NOTE:** In most cases using the object itself will do the same job + as this and will also allow Meson to setup dependencies correctly. |