Commit 413954aa44e7fc103f27fdc7cd962ae8532d96be
2014-10-18T15:51:41
Add PACKAGING file Signed-off-by: Ran Benita <ran234@gmail.com>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
diff --git a/Makefile.am b/Makefile.am
index dfb3572..8e45ccb 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -14,7 +14,8 @@ EXTRA_DIST = \
doc/rules-format.txt \
doc/doxygen-extra.css \
xkbcommon.map \
- xkbcommon-x11.map
+ xkbcommon-x11.map \
+ PACKAGING
AM_CPPFLAGS = \
-DDFLT_XKB_CONFIG_ROOT='"$(XKBCONFIGROOT)"' \
diff --git a/PACKAGING b/PACKAGING
new file mode 100644
index 0000000..738ccc4
--- /dev/null
+++ b/PACKAGING
@@ -0,0 +1,50 @@
+libxkbcommon consists of two shared libraries, libxkbcommon (the main
+library) and libxkbcommon-x11 (an addon library for XCB clients).
+
+The files for libxkbcommon-x11 are:
+ libxkbcommon-x11.a libxkbcommon.so* xkbcommon/xkbcommon-x11.h
+ xkbcommon-x11.map xkbcommon-x11.pc
+
+libxkbcommon-x11 can be disabled with --disable-x11 (see
+`./configure --help` for other options/variables).
+
+Dependencies for libxkbcommon:
+- C compiler, autoconf, automake, pkg-config, libc, etc.
+
+- (build optional) xorg-util-macros.
+ Output included in tarball.
+
+- (build optional) bison (preferred) or byacc>=20141006.
+ Output included in tarball.
+ byacc must be configured with --enable-btyacc.
+
+- (build optional, runtime) xkeyboard-config.
+ During build, for automatically detecting the value of
+ --with-xkb-config-root instead of guessing (/usr/share/X11/xkb).
+ During runtime, not strictly needed, but most users of the library
+ would need it.
+
+- (runtime) libX11.
+ Contains the dataset for Compose support (/usr/share/X11/locale).
+ Please don't depend on it explicitly.
+
+- (build optional) doxygen.
+ For generating the HTML documentation.
+
+- (build optional) gperf.
+ Output included in git and tarball. To regenerate, use
+ `make update-keywords`.
+
+Dependencies for libxkbcommon-x11:
+- libxkbcommon.
+
+- libxcb>=1.10 with libxcb-xkb.
+
+Dependencies for libxkbcommon-x11 tests:
+- xkbcomp, Xvfb.
+ If they are not available, the relevant tests are skipped.
+
+Unless libxcb is always available as part of the system, it is preferred
+that libxkbcommon and libxkbcommon-x11 be split into separate packages,
+such that the main library does not depend on libxcb. This avoids a
+transitive dependency of Wayland clients on X libraries.