Skip to content

WrapDB docs updates #15351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bgilbert wants to merge 3 commits into
base: master
Choose a base branch
from
Open

WrapDB docs updates #15351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8055a2b
docs: drop version gate for meson.override_dependency in WrapDB
bgilbert Dec 6, 2025
e25a456
docs: don't recommend meson.options in WrapDB
bgilbert Dec 6, 2025
f3dcccc
docs: various WrapDB improvements
bgilbert Dec 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 8 additions & 15 deletions docs/markdown/Adding-new-projects-to-wrapdb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,17 +70,6 @@ meson.override_dependency('arrow', arrow_dep)
arrow_compute_dep = declare_dependency(...)
meson.override_dependency('arrow-compute', arrow_compute_dep)
```
Note that `meson.override_dependency` was introduced in Meson version
0.54.0. If your project supports older versions of Meson, you should
add a condition to only call that function in versions where it is
available:

```meson
if meson.version().version_compare('>=0.54.0')
meson.override_dependency('arrow', arrow_dep)
meson.override_dependency('arrow-compute', arrow_compute_dep)
endif
```

## How to contribute a new wrap

Expand Down Expand Up @@ -156,7 +145,7 @@ Remember that all files go in the directory
`subprojects/packagefiles/<project-name>`.

```
${EDITOR} meson.build meson.options
${EDITOR} meson.build meson_options.txt
```

In order to apply the locally added build files to the upstream
Expand Down Expand Up @@ -214,11 +203,15 @@ any issues faster.
You can test the wrap itself with the following commands:

meson subprojects purge --confirm
meson setup builddir/ -Dwraps=<project-name>
tools/sanity_checks.py

The first command is to ensure the wrap is correctly fetched from the
latest packagefiles. The second command configures meson and selects a
set of subprojects to enable.
latest packagefiles. The second command builds the project and runs tests.

If you want to manually build the project without running the full test
suite, you can:

meson setup builddir/ -Dwraps=<project-name>

The GitHub project contains automatic CI on pushing to run the project
and check the metadata for obvious mistakes. This can be checked from
Expand Down
11 changes: 8 additions & 3 deletions docs/markdown/Using-the-WrapDB.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,12 @@ Wrap manual](Wrap-dependency-system-manual.md).
patch_hash = 2327a42c8f73a4289ee8c9cd4abc43b324d0decc28d6e609e927f0a50321af4a

Add this file to your project with the name `subprojects/zlib.wrap`.
Then you can use it in your `meson.build` file with this directive:
Or, as a shortcut, you can add the latest wrap file for `zlib` to your
project with this command:

meson wrap install zlib

Now you can use it in your `meson.build` file with this directive:

zproj = subproject('zlib')

Expand All @@ -41,7 +46,7 @@ patch the source files.

## Contributing build definitions

The contents of the Wrap database are tracked in git repos of the
[Mesonbuild project](https://github.com/mesonbuild). The actual
The contents of the Wrap database are tracked
[on GitHub](https://github.com/mesonbuild/wrapdb). The actual
process is simple and described in [submission
documentation](Adding-new-projects-to-wrapdb.md).