meson.build: Take win_bison as a possible variant for Bison
[platform/upstream/libxkbcommon.git] / PACKAGING
1 libxkbcommon consists of two shared libraries, libxkbcommon (the main
2 library) and libxkbcommon-x11 (an addon library for XCB clients).
3
4 The files for libxkbcommon-x11 are:
5     libxkbcommon-x11.a libxkbcommon-x11.so* xkbcommon/xkbcommon-x11.h
6     xkbcommon-x11.map xkbcommon-x11.pc
7
8 libxkbcommon-x11 can be disabled with -Denable-x11=false (see
9 `meson configure build` for other options/variables).
10
11 Dependencies for libxkbcommon:
12 - C compiler, meson, pkg-config, libc, bash, grep, sed.
13
14 - (build) bison (preferred), win_bison or byacc>=20141006.
15   byacc must be configured with --enable-btyacc.
16
17 - (build optional, runtime) xkeyboard-config.
18   During build, for automatically detecting the value of
19   -Dxkb-config-root instead of guessing (/usr/share/X11/xkb).
20   During runtime, not strictly needed, but most users of the library
21   would need it.
22
23 - (runtime) libX11.
24   Contains the dataset for Compose support (/usr/share/X11/locale).
25   Please don't depend on it explicitly.
26
27 - (build optional) doxygen.
28   For generating the HTML documentation.
29   To disable, use -Denable-docs=false.
30
31 - (build optional) gperf.
32   Output included in git and tarball. To regenerate, use
33   `./scripts/update-keywords`.
34
35 Dependencies for libxkbcommon-x11:
36 - libxkbcommon.
37
38 - libxcb>=1.10 with libxcb-xkb.
39
40 Dependencies for libxkbcommon-x11 tests:
41 - xkbcomp, Xvfb.
42   If they are not available, the relevant tests are skipped.
43
44 Dependencies for Wayland tests:
45 - wayland-client>=1.2.0, wayland-scanner, wayland-protocols>=1.0.
46   To disable, use -Denable-wayland=false.
47
48 Unless libxcb is always available as part of the system, it is preferred
49 that libxkbcommon and libxkbcommon-x11 be split into separate packages,
50 such that the main library does not depend on libxcb. This avoids a
51 transitive dependency of Wayland clients on X libraries.