# HG changeset patch
# User David Demelier <markand@malikania.fr>
# Date 1553254750 -3600
# Node ID de03aa2d54f5f9c6178af9287187d0bf7e6bc70d
# Parent  5d640aec8c4b7952929bc45e4d476c7d30c16fdd
vanilla: add more options in README

diff -r 5d640aec8c4b -r de03aa2d54f5 README.options.md
--- a/README.options.md	Fri Mar 22 20:26:00 2019 +0100
+++ b/README.options.md	Fri Mar 22 12:39:10 2019 +0100
@@ -3,17 +3,68 @@
 
 Packages may be configured using environment variables prior to building.
 
+# General options
+
 Use the following predefined options before creating your own.
 
-- BLUETOOTH: control bluetooth support
-- DBUS: control D-Bus support
-- DEBUG: build with debug symbols
-- GTK3: control Gtk 3 toolkit support
-- NLS: control native language support
-- PAM: support for PAM
-- PULSEAUDIO: control PulseAudio support
-- QT5: control Qt 5 toolkit support
-- SSL: use SSL/TLS, some packages offer several choices (e.g. openssl, gnutls)
+- ACL: enable access control list support
+- BLUETOOTH: enable bluetooth support
+- BZIP2: enable bzip2 compression support
+- DBUS: enable D-Bus support
+- DOXYGEN: enable doxygen documentation support
+- DRM: enable direct rendering manager support
+- DTD: enable XML validation support
+- EGL: enable EGL support
+- FONTCONFIG: enable fontconfig support
+- FREETYPE: enable freetype support
+- GALLIUM: enable LLVM gallium support
+- GDBM: enable GNU database support
+- GLAMOR: enable 2D graphics support
+- GLES2: enable GLES2 support
+- GLES3: enable GLES3 support
+- GMP: enable GNU multiple precision library
+- GTK2: enable Gtk 2 toolkit support
+- GTK3: enable Gtk 3 toolkit support
+- GTK4: enable Gtk 4 toolkit support
+- GUILE: enable GNU guile support
+- IDN2: enable libidn2 support
+- KMS: enable kernel mode settings support
+- LLVM: enable LLVM support
+- LZ4: enable lz4 compression support
+- LZMA: enable lzma compression support
+- MNL: enable netlink minimalistic library support
+- NLS: enable native language support
+- PAM: enable PAM support
+- PCRE: enable perl-like regular expression support
+- PULSEAUDIO: enable PulseAudio support
+- PYTHON: enable Python 3 bindings or support
+- QT5: enable Qt 5 toolkit support
+- SPHINX: enable sphinx documentation support
+- SSH: enable SSH support
+- SSL: enable SSL/TLS, some packages offer several choices (e.g. openssl, gnutls)
+- UDEV: enable eudev support
+- UUID: enable UUID support
+- WACOM: enable wacom support
+- WAYLAND: enable wayland support
+- X: enable X.Org support
+- XML: enable XML support
+- XZ: enable XZ support
+- ZLIB: enable zlib compression support
+- ZSTD: enable zstd compression support
+
+Always try to make an option easy to understand and not package specific. For
+example BLUETOOTH is preferred over BLUEZ because a user knows what bluetooth is
+but may not know that bluez is the current reference implementation. Also, it is
+preferred to make an option generic to allow multiple values in case the
+package offers it.
+
+Example, if a package offers different implementations for SSL, consider the
+option with a value (e.g. SSL=openssl, SSL=gnutls, and such).
+
+Also, if a package offers different implementations that can be enabled all
+together, use a list separated by space (e.g. XML="libxml2 expat").
+
+# Toolchain options
 
 Those options should only change the package behaviour, for example: manual
 pages or any other resource files that are not strictly required; they must be