From 1f72df29363328151af66f1bd3e6cb398f242612 Mon Sep 17 00:00:00 2001 From: Gwenhael Goavec-Merou Date: Tue, 17 Feb 2026 10:34:52 +0100 Subject: [PATCH] doc/guide/install.rst: added common's subsection about enabling/disabling cables/vendors drivers --- doc/guide/install.rst | 84 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) diff --git a/doc/guide/install.rst b/doc/guide/install.rst index 511697f..27fa0de 100644 --- a/doc/guide/install.rst +++ b/doc/guide/install.rst @@ -269,3 +269,87 @@ Bitstreams for *XC2C (coolrunner-II)* needs to be remapped using ``.map`` shippe -DISE_PATH=/somewhere/Xilinx/ISE_VERS/ default: ``/opt/Xilinx/14.7``. + +Disabling/Enabling Cable or Vendor Drivers +------------------------------------------ + +With the default ``cmake ..`` configuration, openFPGALoader enables +``ENABLE_CABLE_ALL=ON`` and ``ENABLE_VENDORS_ALL=ON``. This means all cable +and vendor drivers are enabled by default, then filtered only by OS +capabilities and available dependencies. + +To reduce binary size, speed up the build, or keep support limited to selected +cables/vendors, you can explicitly enable or disable options. + +These commands are equivalent: + +.. code-block:: bash + + cmake -DENABLE_CABLE_ALL=ON -DENABLE_VENDORS_ALL=ON .. + # and + cmake .. # Implicit default values + +To disable all cable and vendor support: + +.. code-block:: bash + + cmake -DENABLE_CABLE_ALL=OFF -DENABLE_VENDORS_ALL=OFF .. + +This produces an **openFPGALoader** binary with no cable/vendor support. +Then re-enable only what you need by adding one or more options below. + +Each item in the following lists is a CMake option name. Use them with +``-D