Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Glossary of EPICS-env terms

This page defines each term the book uses with a specific meaning. The pages use each term only in the meaning given here.

Abbreviations used in this book

AbbreviationMeaning
ACFAccess security configuration file that an input/output controller (IOC) loads with asSetFilename
ASCIIAmerican Standard Code for Information Interchange
CAChannel Access, the EPICS network protocol that caget and caput use
CIContinuous integration: the GitHub Actions workflows under .github/workflows/
DBDDatabase definition file
ELFExecutable and Linkable Format, the Linux binary format that readelf reads
EPICSExperimental Physics and Industrial Control System
GCCGNU Compiler Collection
IOCInput/output controller: a process that serves EPICS records
IPv4Internet Protocol version 4
NTPNetwork Time Protocol
OSOperating system
PRPull request
PVProcess variable: a named record field that clients read and write
PVApvAccess, the EPICS network protocol that pvget and pvxget use
RHELRed Hat Enterprise Linux
RPATHRun-time search path entry in an ELF file; the link option --enable-new-dtags writes a RUNPATH entry instead
RUNPATHRun-time library search path entry in an ELF file, written when the link uses --enable-new-dtags
SHA-256Secure Hash Algorithm 256-bit
TCPTransmission Control Protocol

Build and installation terms

TermMeaning
$ORIGINThe directory of the loaded ELF file; a RUNPATH entry that starts with it is relative to that file
configuration typeThe <module>_CONF_TYPE value of a module: auto for a generated conf.<module> rule, custom for a hand-written one
declared dependenciesThe <module>_DEPS list: the build.<module> targets that build before the module
installed treeThe directory $(INSTALL_LOCATION)/<release>/<os_id>-<os_version>/<base_version>, which make print-INSTALL_LOCATION_EPICS prints
module keyThe upper-case name of a module’s SRC_* variables in configure/RELEASE, such as ASYN
module setThe EPICS modules that configure/RELEASE declares, each with a pin
MODULESGEN.mkThe generated file configure/MODULESGEN.mk that holds each module’s repository URL, install directory, and source directory
null.baseThe empty target that stands for EPICS base as the root of every declared dependency list
pinThe tag or commit, SRC_TAG_<module_key>, that a module source checks out
release tripleThe three variables SRC_NAME_<module_key>, SRC_TAG_<module_key>, and SRC_VER_<module_key> that declare one module
repository overrideA SRC_GITURL_<module_key> line in configure/CONFIG_MODS for a module hosted outside epics-modules
unversioned linkThe link modules/<module> that make symlinks creates to the versioned directory; modules/seq for the sequencer
vendor directoryThe directory vendor/ in the installed tree that holds the uldaq and open62541 libraries
versioned directoryThe install directory modules/<module>-<version> of one module; modules/seq-<version> for the sequencer

Verification gate terms

TermMeaning
gateThe strict form of a check that stops a build or a CI run on a finding
lost runpathA shared library in the installed tree that needs another library of the tree but has no $ORIGIN RUNPATH entry to find it
report formThe form of a check that prints its findings and exits 0
strict formThe form of a check that exits with a failure code on a finding

Patch carry terms

TermMeaning
carry patchA patch under patch/ that carries an upstream fix onto the pinned EPICS base or pvxs source
carry setEvery carry patch whose name starts with the pinned version of its source
fixed module patchA patch under patch/ with a fixed name for one module, applied by its own patch.<name>.apply target
version-anchored nameA carry patch name that starts with the source version, so a version bump drops the whole carry set

Common iocsh fragment terms

TermMeaning
common iocsh fragmentOne of the *.iocsh files that make install copies to modules/commonIocsh/iocsh in the installed tree
enable macroA fragment macro that defaults to #--, which comments out an optional part; an empty value enables that part
evidence directoryThe directory that verify_caputlog.py creates with --output; it must not exist beforehand
IOCSH_TOPThe IOC macro that names the installed modules/commonIocsh directory; an IOC loads a fragment as $(IOCSH_TOP)/iocsh/<fragment>.iocsh
serial configuration fileAn iocsh file that an IOC owns and that calls setSerialParams.iocsh once per serial port
soft IOCA prebuilt IOC program that loads records from a database file, such as softIoc of EPICS base or softIocPVX of the pvxs module