From 63c00899b016690a12d3467154d6b631bf907c77 Mon Sep 17 00:00:00 2001 From: Dirk Zimoch Date: Fri, 25 Feb 2022 11:32:54 +0100 Subject: [PATCH] Add IGNORE_MODULES to documentation --- Readme.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/Readme.md b/Readme.md index 0858fcb..ce14d4b 100644 --- a/Readme.md +++ b/Readme.md @@ -646,7 +646,7 @@ dependent files can be listed in variables like `DBD_3.13` or `DBD_3.14.12`. :exclamation: There is no support for architecture dependent DBD files. -### Header Files and Dependencies, `HEADERS`, `*_VERSION` and `REQUIRED` Variables +### Header Files and Dependencies, `HEADERS`, `*_VERSION`, `REQUIRED` and `IGNORE_MODULES` Variables If a module provides features (in particular functions) to be used by other modules, it contains one or more C/C++ header files which can be included @@ -671,9 +671,9 @@ defining a variable `_VERSION`. asyn_VERSION = 4.8.1 ``` -:bulb: As *all* other modules are searched for header files, it makes sense -to avoid too generic header file names, such as `version.h`. At least to not -install them. +:bulb: As *all* other modules are searched for header files (in unspecified +order), it makes sense to avoid too generic header file names, such as +`version.h`. At least to not install them. :bulb: OS class dependent header files which are located in an appropriate subdirectory like `os/Linux/` keep their location in such a subdirectory @@ -703,6 +703,21 @@ without incrementing the major version number. In such cases, define either higher minor versions (or even patch levels) are backward compatible when a dependency on that module is found. +Problematic header files installed by another module may be ignored, e.g. +in case of file name clashes. Set the variable `IGNORE_MODULES` to a list +of modules whose header files should not be found automatically. + +**Example:** +``` +IGNORE_MODULES = motorBase asynMotor +``` + +:exclamation: Do not install different versions a module with headers under +different names (for the same EPICS version). +This will inevitably create file name clashes which cause problems to all +other modules that use this module. + + ### Template Files and `TEMPLATES` Variable Modules can also provide db EPICS template files. This is useful if a driver