CHANGELOG.md



To find the state of this project's repository at the time of any of these versions, check out the tags.


CHANGELOG
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog,
and this project adheres to Semantic Versioning.

4.0.0


New Features

Block module loading after iocInit has been invoked.
Arguments have been added to iocsh.bash to enable user to pass any debugger options to GDB and Valgrind.
Autocompletion for iocsh.bash has been added
Removed iocsh_gdb.bash and iocsh_nice.bash, both of whose functionality can be called via iocsh.bash -dg and iocsh.bash -n, respectively.
Patch file location has been change from patch/Site/$VERSION-description.p0.patch to patch/Site/$VERSION/description.p0.patch

Require will automatically build .template and .substitutions files into the common build directory instead of into the source Db path
Rudimentary testing has been added:


Tests that the correct version is loaded


Tests that elementary patching/building works as expected


Added consistency check between e3 environment variables and path to iocsh.bash. iocsh.bash will abort if these are not consistent.
Add e3 version infomation to the shell prompt
Add option to allow override of automatic addition of iocInit to generated startup script


Bugfixes


iocsh.bash --help (and variants) no longer loads tries to load env.sh.

make uninstall no longer tries to remove from global siteLibs directory.

make build will fail if any of the target architectures fail, not just the last one.
Fixed issue where git passwords would be displayed in plaintext in metadata file
Fixed issue where LD_LIBRARY_PATH could keep old siteLibs path around
Removed duplicated entries from generated .dep files
Removed dev targets from modules that function in "local source mode"
Fixed issue where .hpp files were not installed correctly with KEEP_HEADER_SUBDIRS

Missing REQUIRED dependencies now cause the build to fail instead of providing a warning
Fixed issue where consecutive builds might not track updated dependencies
Fixed an issue related to buffering of data being written to a shared filesystem which produced garbled .dep files


Other changes

Rename iocsh.bash to iocsh

Removed <module>_TEMPLATES in favour of <module>_DB

Removed unnecessary code from make init.
removed e3.cfg, ess-env.conf and DEFINES_REQUIRE files and associated codes in RULES_REQUIRE, setE3Env.bash and .gitignore.
removed legacy code from setE3Env.bash
Removed usage of env.sh - now there is a check only for seeing if the environment variable $IOCNAME is set
Fix typos in iocsh_functions.bash comments
Rearrange usage to match order of options in code
Add information about realtime option to usage
Cleaned up the output of make vars and make devvars

Merged together configure/E3 and configure/MODULES

Removed siteLibs and siteApps directories
Removed references to EPICS Base v3


3.4.1


Bugfixes

Fixed an issue where iocshRegisterCommon() was called when registering functions for modules as they are loaded. This had
the effect of overwriting any functions that have the same name as a common one with their original one (e.g. dbLoadTemplate
from require)
Fixed the shebang from build_number.sh so that it works in Ubuntu


3.4.0

3.4.0 is also a fairly major release, that fixes many bugs but that also enables use of cellmode, to facilitate work against a shared build.

New Features

Added back promptE3Env.bash, which runs setE3Env.bash and then sets the bash prompt.
Added descriptions for more targets when running make help

Added a new test target for individual modules, available as make test

Added script in tools/test_installed_modules.sh that tests all modules in an installation
Build numbers are now prefixed with a +.
Cell mode: When using make cellinstall, the module is installed in the path
${E3_CELL_PATH}/${EPICS_BASE_VERSION}/${E3_REQUIRE_VERSION}/module_name. This allows
us to distinguish which version of base and require were used for the build.
A new make target, cellbuild has been added. This simply allows you to build (not install)
while still possibly linking with other Cell mode modules.


Bugfixes

Removed loadIocsh function, which was just a cover for runScript.
Removed references to INSTBASE

Fixed issue where make cellinstall would recompile a module.
Fixed permissions on cellinstall.
Fixed issue where make debug would recompile a module.
Fixed issue where make install would fail if you had not run make build first.
Removed all references to sudo. If sudo needs to be used, it should be done manually.
Fixed issue with module name checking which caused modules to fail to build on certain linux distributions
Exact module version is fetched correctly at build-time to ensure that new releases do not affect upstream dependencies
Issue involving priority between some test versions fixed

make patch when there are no patch files will no longer return an error code.


Other changes

Removed require as a submodule and merged it into e3-require.
Add CONFIG_SHELL to define standard shell (bash) used by Make

Removed plotdep target.


3.3.0

3.3.0 is a relatively major release with many bugfixes and a number of features added based on consultation
with developers. One major change is that versions are now parsed as MAJOR.MINOR.PATCH-BUILD (with build
number being optional, assumed to be zero if not present). This has proven to be necessary in the NFS
setting for a number of separate reasons to handle dependencies properly. Note the following behavior:


require module - loads the latest numeric version of a given module.

require module,x.x.x - loads the specific numeric version of a module, with the highest build number

require module,x.x.x-x - loads a specific build number of the specified version of a module

A second major change (mostly via bugfixes) is that the local install command, make cellinstall which installs the module in a local directory now works properly, which allows developers and integrators to simply mount the NFS E3 build and work with that instead of needing to install E3 locally.

New Features

Removed all EPICS 3.* and VxWorks code, as these are not to be supported at ESS.
Consistent with the philosophy of not requiring module version pinning, if one specifies a dependent
module with e.g. REQUIRED += asyn then the latest version of asyn will be used. No version need
to be specified.
Installed modules will be installed together with a metadata file containing information about the
module and wrapper, including the git status of the wrapper/module, the latest tag/commit hash, and
the git url for the wrapper.
Build numbers are now supported properly

iocsh.bash will load env.sh at startup (which can be specified), which allows IOCNAME to be
specified at startup
Added the ability to install header files while preserving directory structure instead of flattening
all header files into a single module/version/includes directory.
Using EPICS_MODULE_TAG to detect if we are using the local source code vs. git submodule. Note that
the old -loc is still supported, but will be deprecated in a future release.
Added a prebuild target that runs before build so module developers can run specific code before the build process.
A module developer can now install dbd files separate from the module dbd file by using DBD_INSTALLS += file.dbd.


Bugfixes

Ensures that lowercase module names are enforced consistently
Vendor libraries are only installed at install time, not at build time
Vendor libraries are uninstalled when make uninstall is run

make debug can now be run before running make build

Patches that involve renaming files can be used
When using the "cellinstall" mode to install modules for local testing, sudo has been removed.
When using "cellinstall", sequencer is loaded correctly
When using "cellinstall", module include files are located correctly

iocsh.bash now supports multiple directories being specified with the -l (local) flag as a source of loading modules
Fixed an error where mounting the NFS E3 in a location other than /epics would result in failed builds
Assorted minor typos in scripts
Re-added functionality to have iocsh.bash automagically source setE3Env.bash.


3.2.0

Require 3.2.0 is the first version of require used during our initial return to the NFS implementation
of E3. It maintains some of the work done there (modules are lowercased for consistency), but mostly
reverts back to a similar version to require 3.1.2. One major difference is that module pinning is not
"required" (pun only semi-intended). That is, a startup script can simply include a statement of the
form require module instead of require module,version as was the case in 3.1.2. An IOC developer can
of course pin a specific module version. If they do not, then the highest numeric version will be chosen.

New Features

Added -dg, -dv options to run gdb and valgrind using iocsh.bash

If IOCNAME is defined, then it is used in the PV names set by require instead of REQMOD:$(hostname)-$(pid).
Reverted changes from conda require to return to NFS
Moved tools files from e3-require to require submodule


Bugfixes

Fixed issue where a second user running iocsh.bash on a machine would be unable to create the temporary
startup script