From a3098fbfa32ae4ff654f0da45bcfcd9aa7893b5f Mon Sep 17 00:00:00 2001 From: Eli Schwartz Date: Wed, 15 Feb 2023 21:40:48 -0500 Subject: docs: add description of license_files kwarg Added in commit 2fa074917597fea0cf3332c6620d3414034825e4 but I forgot to document it. --- docs/yaml/functions/project.yaml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/yaml/functions/project.yaml b/docs/yaml/functions/project.yaml index 7c9c69d..fe665aa 100644 --- a/docs/yaml/functions/project.yaml +++ b/docs/yaml/functions/project.yaml @@ -86,6 +86,22 @@ kwargs: for verifying that you abide by all licensing terms. You can access the value in your Meson build files with `meson.project_license()`. + license_files: + type: str | list[str] + since: 1.1.0 + description: | + Takes a string or array of strings with the paths to the license file(s) + the code is under. + + This enhances the value of the `license` kwarg by allowing to specify both + the short license name and the full license text. Usually this would be + something like `license_files: ['COPYING']`. + + Note that the files are informal and are only installed with the dependency + manifest. Meson does not do any license validation, you are responsible + for verifying that you abide by all licensing terms. You can access the + value in your Meson build files with [[meson.project_license_files]]. + subproject_dir: type: str default: "'subprojects'" -- cgit v1.1