Compare revisions

14ab6be9 · 9866e692 · 6e95ffc2 · ceb6eda7 · dd1f8b13 · a03ba3c3
--- a/.clang-format
+++ b/.clang-format
+---
+Language:        Cpp
+# BasedOnStyle:  Google
+AccessModifierOffset: -1
+AlignAfterOpenBracket: Align
+AlignArrayOfStructures: None
+AlignConsecutiveMacros: None
+AlignConsecutiveAssignments: None
+AlignConsecutiveBitFields: None
+AlignConsecutiveDeclarations: None
+AlignEscapedNewlines: Left
+AlignOperands:   Align
+AlignTrailingComments: true
+AllowAllArgumentsOnNextLine: true
+AllowAllConstructorInitializersOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortEnumsOnASingleLine: true
+AllowShortBlocksOnASingleLine: Never
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: All
+AllowShortLambdasOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: WithoutElse
+AllowShortLoopsOnASingleLine: true
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: true
+AlwaysBreakTemplateDeclarations: Yes
+AttributeMacros:
+  - __capability
+BinPackArguments: true
+BinPackParameters: true
+BraceWrapping:
+  AfterCaseLabel:  false
+  AfterClass:      false
+  AfterControlStatement: Never
+  AfterEnum:       false
+  AfterFunction:   false
+  AfterNamespace:  false
+  AfterObjCDeclaration: false
+  AfterStruct:     false
+  AfterUnion:      false
+  AfterExternBlock: false
+  BeforeCatch:     false
+  BeforeElse:      false
+  BeforeLambdaBody: false
+  BeforeWhile:     false
+  IndentBraces:    false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: None
+BreakBeforeConceptDeclarations: true
+BreakBeforeBraces: Attach
+BreakBeforeInheritanceComma: false
+BreakInheritanceList: BeforeColon
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeColon
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+ColumnLimit:     80
+CommentPragmas:  '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DeriveLineEnding: true
+DerivePointerAlignment: true
+DisableFormat:   false
+EmptyLineAfterAccessModifier: Never
+EmptyLineBeforeAccessModifier: LogicalBlock
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IfMacros:
+  - KJ_IF_MAYBE
+IncludeBlocks:   Regroup
+IncludeCategories:
+  - Regex:           '^<ext/.*\.h>'
+    Priority:        2
+    SortPriority:    0
+    CaseSensitive:   false
+  - Regex:           '^<.*\.h>'
+    Priority:        1
+    SortPriority:    0
+    CaseSensitive:   false
+  - Regex:           '^<.*'
+    Priority:        2
+    SortPriority:    0
+    CaseSensitive:   false
+  - Regex:           '.*'
+    Priority:        3
+    SortPriority:    0
+    CaseSensitive:   false
+IncludeIsMainRegex: '([-_](test|unittest))?$'
+IncludeIsMainSourceRegex: ''
+IndentAccessModifiers: false
+IndentCaseLabels: true
+IndentCaseBlocks: false
+IndentGotoLabels: true
+IndentPPDirectives: None
+IndentExternBlock: AfterExternBlock
+IndentRequires:  false
+IndentWidth:     2
+IndentWrappedFunctionNames: false
+InsertTrailingCommas: None
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: false
+LambdaBodyIndentation: Signature
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBinPackProtocolList: Never
+ObjCBlockIndentWidth: 2
+ObjCBreakBeforeNestedBlockParam: true
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 1
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 200
+PenaltyIndentedWhitespace: 0
+PointerAlignment: Left
+PPIndentWidth:   -1
+RawStringFormats:
+  - Language:        Cpp
+    Delimiters:
+      - cc
+      - CC
+      - cpp
+      - Cpp
+      - CPP
+      - 'c++'
+      - 'C++'
+    CanonicalDelimiter: ''
+    BasedOnStyle:    google
+  - Language:        TextProto
+    Delimiters:
+      - pb
+      - PB
+      - proto
+      - PROTO
+    EnclosingFunctions:
+      - EqualsProto
+      - EquivToProto
+      - PARSE_PARTIAL_TEXT_PROTO
+      - PARSE_TEST_PROTO
+      - PARSE_TEXT_PROTO
+      - ParseTextOrDie
+      - ParseTextProtoOrDie
+      - ParseTestProto
+      - ParsePartialTestProto
+    CanonicalDelimiter: pb
+    BasedOnStyle:    google
+ReferenceAlignment: Pointer
+ReflowComments:  true
+ShortNamespaceLines: 1
+SortIncludes:    CaseSensitive
+SortJavaStaticImport: Before
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCaseColon: false
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: ControlStatements
+SpaceAroundPointerQualifiers: Default
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyBlock: false
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 2
+SpacesInAngles:  Never
+SpacesInConditionalStatement: false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInLineCommentPrefix:
+  Minimum:         1
+  Maximum:         -1
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+SpaceBeforeSquareBrackets: false
+BitFieldColonSpacing: Both
+Standard:        Auto
+StatementAttributeLikeMacros:
+  - Q_EMIT
+StatementMacros:
+  - Q_UNUSED
+  - QT_REQUIRE_VERSION
+TabWidth:        8
+UseCRLF:         false
+UseTab:          Never
+WhitespaceSensitiveMacros:
+  - STRINGIZE
+  - PP_STRINGIZE
+  - BOOST_PP_STRINGIZE
+  - NS_SWIFT_NAME
+  - CF_SWIFT_NAME
+...
--- a/.gitattributes
+++ b/.gitattributes
+*.makefile gitlab-language=make
--- a/.gitignore
+++ b/.gitignore
@@ -13,9 +13,15 @@ core.*
 .#*
 \#*
 *.local
-e3.cfg
-tools/ess-env.conf
 .vscode
+cellMods
+*.log
+__pycache__
+.iocsh_history
+.gdb_history
+venv
+
 require-ess/require.Makefile
+require-ess/O.*
 require-ess/Db/*.db
-require-ess/Db/*.d
\ No newline at end of file
+require-ess/Db/*.d
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
 ---
+variables:
+  E3_CI_MODIFIED_BASE_VERSION: "7.0.8.1-68332f4-20240917T140931"  # strip the first part of the tag name - see E3-1529

 stages:
  - check
@@ -8,10 +10,11 @@ stages:
 default:
  tags:
    - docker
-  image: registry.esss.lu.se/ics-docker/centos-e3:$E3_CI_DOCKER_VERSION
+  image: registry.esss.lu.se/ics-docker/centos-e3:latest

-
-### stage: check
+include:
+  - project: "ics-infrastructure/gitlab-ci-yml"
+    file: "PreCommit.gitlab-ci.yml"

 shellcheck:
  image: pipelinecomponents/shellcheck:latest
@@ -34,16 +37,16 @@ shfmt:
  before_script:
    - shfmt -version
  script:
-    - shfmt -i 2 -ci -d .  # 2 spaces indent, indent switch-case statements, show diff (don't apply change)
+    - shfmt -i 2 -ci -d . # 2 spaces indent, indent switch-case statements, show diff (don't apply change)

 build require:
  stage: build
-  when: always
  before_script:
-    - curl -L -o epics.tar.gz https://artifactory.esss.lu.se/artifactory/e3/epics-base-$E3_CI_BASE_VERSION.tar.gz
+    - curl -L -o epics.tar.gz https://artifactory.esss.lu.se/artifactory/e3/epics-base-$E3_CI_MODIFIED_BASE_VERSION.tar.gz
    - tar -zxvf epics.tar.gz
    - export BASE_PATH=$(ls -d $(pwd)/epics/base-*)
    - echo "EPICS_BASE:=${BASE_PATH}" >> configure/RELEASE.local
+    - echo "E3_REQUIRE_VERSION:=${CI_COMMIT_SHORT_SHA}" >> configure/CONFIG_MODULE.local
    - chmod +w "${BASE_PATH}"/configure/CONFIG_SITE
    - echo 'INSTALL_LOCATION:=$(TOP)' >> "${BASE_PATH}"/configure/CONFIG_SITE
    - export LD_LIBRARY_PATH="${LD_LIBRARY_PATH}:${BASE_PATH}/lib/linux-x86_64"
@@ -59,6 +62,10 @@ build require:
 test require:
  stage: test
  before_script:
-    - source $(pwd)/epics/base-*/require/*/bin/setE3Env.bash
+    - source $(pwd)/epics/base-*/require/*/bin/activate
+    # We need to allow file:// protocol for all of the tests to work
+    - git config --global procotol.file.allow always
  script:
-    - make test
\ No newline at end of file
+    - make test
+  needs:
+    - build require
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
+repos:
+  - repo: https://github.com/psf/black
+    rev: 22.8.0
+    hooks:
+      - id: black
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.0.238
+    hooks:
+      - id: ruff
+  - repo: https://github.com/PyCQA/doc8.git
+    rev: v1.0.0 # 1.1.0 drops python3.6 support
+    hooks:
+      - id: doc8
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1 # 4.2.0 drops python3.6 support
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-yaml
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v13.0.0
+    hooks:
+    - id: clang-format
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
 # CHANGELOG
+
 All notable changes to this project will be documented in this file.

 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
@@ -7,10 +8,159 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]

 ### New Features
+
+* Remove `--realtime` option from `iocsh`
+* Add timestamp for `LoadedModules`
+* Deprecate `IOCNAME` environment variable in favour of `--iocname` argument for `iocsh`
+* Add environment variable `E3_STRICT_CC`: if set to `YES` then driver.Makefile will
+  fail if a cross-compiler is missing
+* Support for e3 on Mac OS (both intel and apple silicon)
+
+### Bugfixes
+
+* Decouple `build` and `install` targets
+* Exit `iocsh` if file to run does not exist
+* Add trigger mapping on `LoadedModules` to silence QSRV2 warning
+* Silence warnings on submodule initialisation
+* Automatically use cell path with `test` target (no longer any need to activate an environment as part of the test rule)
+
+## [5.1.1]
+
+### Bugfixes
+
+* Fix memory leaks on IOC exit
+* Fix dirty terminal after IOC exit for some distributions
+* Fix crash when running `make test` without having activated an environment
+* Resolve `E3_CMD_TOP` when a startup script is being run with `iocsh` (previously expanded to just `.`)
+* Fix truncated errorlog messages
+
+## [5.1.0]
+
+### New Features
+
+* Allow for module-specific build rules (see: sequencer) to be installed and used
+  within e3
+* Automatically install LICENSE files with modules
+* `afterInit` can now run commands of arbitrary length. Note: The syntax has changed from
+  ```
+  afterInit foo bar baz
+  ```
+  to
+  ```
+  afterInit 'foo bar baz'
+  ```
+* Add NTTable PV for module and version information as `LoadedModules`
+
+### Bugfixes
+
+* Fixed an issue where .template and .substitutions files with the same name would build incorrectly
+* Fixed an issue where filenames with spaces in them that had been modified
+in the wrapper would cause all of the module `make` commands to fail.
+* Removed a number of memory leaks found by valgrind
+* Fixed issue where failure of one of the patches to apply wouldn't stop the build
+* Fixed memory leak in `afterInit`
+
+### Other changes
+
+* Rewrite `iocsh` converting it from being a shell script to a python (3.6) script
+  * Remove support for file extensions: `.so`, `.dbd`, `.db`, `.substitutions`, `.template`, `.iocsh`
+  * Remove support for `nice`
+  * Remove support for sequencer programs
+  * Remove optional argument passing to `gdb`
+  * Change the IOC shell to use both stdout and stderr (previously only stdout)
+  * Change default prompt
+  * Change fallback IOC-name (used when `IOCNAME` is not set)
+  * Multiple argument changes; e.g.
+    * Shortened argument for printing version and exit changed from `-v` to `-V`
+    * Make running IOC as realtime or with debuggers mutually exclusive
+    * Change how arguments are passed to `gdb` and `valgrind` (see help: `--help`)
+* Removed `tclx` script to expand .dbd in favour of `dbdExpand.pl` from EPICS base
+* Removed `hdrs` target. Note that this has been entirely replaced by the automatic db expansion.
+* Removed ability to pass `args` to require (which have not been used within e3)
+* Removed `require module,ifexists` option
+* Stop require from looking in legacy locations for various files
+* Rewrite internal linked list to have better memory safety
+* Removed enabling of core dump generation and max file size limit to allow developers more flexibility (enable and set limit by calling `ulimit -S -c x` where x is max size in blocks before IOC startup)
+* Remove `ARCH_FILTER` support; from now on, only `EXCLUDE_ARCHS` is used.
+* Remove `setE3Env.bash` alias (for `activate`)
+* Remove custom `dbLoadTemplate` in favour of the one supplied by EPICS base
+  * Note that this amounts to a change where double quotes (`"`) must be used in substitutions files when using macros in patterns
+
+## [5.0.0]
+
+### New Features
+* Recursive dependency for headers at build-time. This is a more major change that involves:
+  * Module dependecies are now fetched from `CONFIG_MODULE` in the sense that `X_DEP_VERSION` is parsed as a
+    dependency on the module `x`
+  * It is no longer necessary to specify `REQUIRED += ...` nor `x_VERSION = $(X_DEP_VERSION)` within the module makefile
+* Check inconsistent versions between dependencies at build time. If an inconsistency is found the build will fail.
+
+### Bugfixes
+* Fixed issue where updated dependencies of substitution files did not retrigger a .db expansion.
+* db expansion happens at build time, not at install time.
+
+### Other changes
+* Remove `IOCNAME:exit` PV. Stop loading `softIocExit.db` and now it's require that exposes the `BaseVersion` PV.
+* Patch system now applies all patches in the `patch/` directory. Versioning for patches should be handled by git,
+  not by require.
+* The loop over `EPICSVERSION` in `driver.makefile` has been removed; various other cleanup has been performed.
+* Improved output during IOC startup
+* e3-sequencer tests added, as well as removing pre-processing of .stt files.
+* Remove Win32 and CYGWIN32 support
+* Remove `/tools` directory, including `test_installed_modules.sh` utility
+* Remove `runScript`
+* Drop file extension from `build_number.sh`
+* Rename `setE3Env.bash` to `activate`
+* Add alias from `setE3Env.bash` to `activate`
+* Updated PV-names to be ESS compliant, and remove VERSIONS PV
+* Changed from `build number` to `revision number`
+* Added revision number parsing for test versions
+* Joined together the variables `REQUIRE_CONFIG` and `E3_REQUIRE_CONFIG`
+* Removed legacy file `DECOUPLE_FLAGS`
+
+## [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]

@@ -82,7 +232,7 @@ A second major change (mostly via bugfixes) is that the local install command, `
  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
@@ -116,7 +266,12 @@ of course pin a specific module version. If they do not, then the highest numeri
  startup script


-[Unreleased]: https://gitlab.esss.lu.se/e3/e3-require/-/compare/3.4.0...master
+[Unreleased]: https://gitlab.esss.lu.se/e3/e3-require/-/compare/5.1.1...master
+[5.1.1]: https://gitlab.esss.lu.se/e3/e3-require/-/compare/5.1.0...5.1.1
+[5.1.0]: https://gitlab.esss.lu.se/e3/e3-require/-/compare/5.0.0...5.1.0
+[5.0.0]: https://gitlab.esss.lu.se/e3/e3-require/-/compare/4.0.0...5.0.0
+[4.0.0]: https://gitlab.esss.lu.se/e3/e3-require/-/compare/3.4.1...4.0.0
+[3.4.1]: https://gitlab.esss.lu.se/e3/e3-require/-/compare/3.4.0...3.4.1
 [3.4.0]: https://gitlab.esss.lu.se/e3/e3-require/-/compare/3.3.0...3.4.0
 [3.3.0]: https://gitlab.esss.lu.se/e3/e3-require/-/compare/3.2.0...3.3.0
 [3.2.0]: https://gitlab.esss.lu.se/e3/e3-require/-/tree/3.2.0
--- a/COPYRIGHT
+++ b/COPYRIGHT
+Copyright (C) 2024 European Spallation Source ERIC
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
--- a/LICENSE
+++ b/LICENSE
--- a/Makefile
+++ b/Makefile
@@ -30,4 +30,3 @@ TOP:=$(CURDIR)
 include $(TOP)/configure/CONFIG

 include $(TOP)/configure/RULES
-
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ any longer.
 At its heart, `require` performs:
 * Dynamic loading of EPICS modules and rudimentary dependency resolution
 * Loading of IOCs using a custom startup script calling `softIocPVA`
-* Building of EPICS modules into standardized packages
+* Building of EPICS modules into standardized e3 packages

 For more documentation on this, please see [e3.pages](http://e3.pages.esss.lu.se/design/2_require.html).

@@ -26,7 +26,7 @@ The main parts that we have taken from PSI `require` are `require.c` and `driver
 load modules dynamically at run-time, and which run the custom build process. However, both of these have been
 modified significantly for the purposes of e3.

-Furthermore, we have added the custom startup script `iocsh.bash` which sets up the IOC's environment before
+Furthermore, we have added the custom startup script `iocsh` which sets up the IOC's environment before
 running `softIocPVA` from EPICS base.

 ## Building `require`
@@ -40,8 +40,8 @@ $ make install

 To test your build, run
 ```bash
-$ source ${EPICS_BASE}/require/${E3_REQUIRE_VERSION}/bin/setE3Env.bash
-$ iocsh.bash
+$ source ${EPICS_BASE}/require/${E3_REQUIRE_VERSION}/bin/activate
+$ iocsh
 ```

 which should start up an IOC and load require.
--- a/SPECIAL_MODE.md
+++ b/SPECIAL_MODE.md
-Special Modes for ESS EPICS Environment (e3)
-===
-
-The Special modes are optional. However it will give users to explore more posssibilities while running IOC in any circumstances. 
-
-## Cell Mode
-
-When a user faces the difficulty to work within entire work-flow in terms of the tighted-controlled deployment or within limited RW permissions. Sometimes, it is very difficult to compile and run any IOC appplication within the ESS EPICS environment. Thus, the Cell Mode is introduced. 
-
-One should define `E3_CELL_PATH`, where one can has the RW permission. The default is `$(TOP)/cellMods` because the e3 has the assumption that one can download the e3-modules or e3-application within a writable path. This variable can be overried with `CONFIG_CELL.local` or `configure/CONFIG_CELL.local` as the same as other `CONFIG_MODULE` or `RELEASE` files. The different commands are shown in 
-```
-make cellinstall
-make celluninstall
-make cellvars
-```
-Once one install an application with the cell mode, one can run an IOC via
-```
-iocsh.bash -l ${E3_CELL_PATH}
-```
-
-
-
-
-## Real-Time Mode
-
-The e3 will handle all modules and applications as a dynamic libraries, which we have to consider when all symbols are resolved. We put this time at startup moment. Although it can slow down any IOC initialization, it is only way to avoid non-deterministic latencies during IOC execution [1].
-
-Here we set the `LD_BIND_NOW=1` before we are going into actually IOC application, and run a IOC application with a scheduler policy of FIFO and a prority of 1. One needs the proper permission to execute it `chrt`, mostly `realtime` group should be created and a user should be in that group. 
-
-* Command
-```
-iocsh.bash -rt 
-```
-
-## ESS Site System Application Mode
-ESS is planing to deploy its through site-wide NFS shared directories. Due to long-term maintenance issues and minimal footprints on e3 application, we also introduce the SAMode (System Application Mode). It only is valid for the site-wide deployment system, not for any local installation. 
-
-Technically, e3 uses `E3_SITEAPPS_PATH` to install any system specific applications. Without any modification, the default path is defined as follows:
-```
-E3_SITEAPPS_PATH= /epics/base-3.15.6/require/3.1.0/siteApps
-```
-
-However, for the system or subsystem deployment procedure, we will replace them system or subsystem specific shared folders, for example, such as
-* ICS : `/siteApps/ics`
-* Accelerator : `/siteApps/acc`
-* Conventional Facility : `/siteApps/cf`
-* Target : `/siteApps/tgt`
-* Experiments : `/siteApps/exp` and  `/siteApps/exp{1..16}`
-
-These parameter is define in each `configure/CONFIG_SITE_SYSTEMAPPS` as `E3_MODULES_PATH:=` and can be overridden via `configure/CONFIG_SITE_SYSTEMAPPS.local` also during the static (configure,  build, and install) procedure. 
-
-When an IOC is running, each IOC should know where they are belong into through `IOCID`, and will set `SITE_SYSTEMAPPS_PATH` before doing `source setE3Env.bash` and `iocsh.bash` or run `iocsh.bash` directly.
-
-* Static
-```
-$ e3-myexample (master)$ echo "E3_MODULES_PATH=/siteApps/icsApps" > configure/CONFIG_SITE_SYSTEMAPPS.local
-$ e3-myexample (master)$ make init
-$ e3-myexample (master)$ make build
-$ e3-myexample (master)$ sudo make install
-$ e3-myexample (master)$ make existent
-/siteApps/icsApps/myexample
-└── master
-    ├── db
-    ├── dbd
-    ├── include
-    └── lib
-```
-* Running
-```
-export SITE_SYSTEMAPPS_PATH=/siteApps/icsApps/
-source setE3Env.bash
-echo $EPICS_DRIVER_PATH
-/home/jhlee/e3-test/base-3.15.6/require/3.1.0/siteMods:/home/jhlee/e3-test/base-3.15.6/require/3.1.0/siteApps:/siteApps/icsApps/
-iocsh.bash -r myexample,master
-....
-require myexample,master
-Module myexample version master found in /siteApps/icsApps//myexample/master/
-Module myexample depends on sequencer 2.2.6
-Module sequencer version 2.2.6 found in /home/jhlee/e3-test/base-3.15.6/require/3.1.0/siteMods/sequencer/2.2.6/
-Loading library /home/jhlee/e3-test/base-3.15.6/require/3.1.0/siteMods/sequencer/2.2.6/lib/linux-x86_64/libsequencer.so
-Loaded sequencer version 2.2.6
-sequencer has no dbd file
-Loading module info records for sequencer
-Loading library /siteApps/icsApps//myexample/master/lib/linux-x86_64/libmyexample.so
-Loaded myexample version master
-Loading dbd file /siteApps/icsApps//myexample/master/dbd/myexample.dbd
-Calling function myexample_registerRecordDeviceDriver
-Loading module info records for myexample
-# Set the IOC Prompt String One 
-epicsEnvSet IOCSH_PS1 "c72f6a5.kaffee.31345 > "
-
-```
-
-For the deployment system, we have to define each `E3_MODULES_PATH` differently within system specific application, it will be done with the global `CONFIG_SITE_SYSTEMAPPS.local`. And each ioc should know `SITE_SYSTEMAPPS_PATH` in order to match `E3_MODULES_PATH` before it starts. 
-
-* `IOCID` defines a system group 
-* Before the systemd service, the additional systemd service check "mountable" path, which will be used in `SITE_SYSTEMAPPS_PATH`, and do `export $SITE_SYSTEMAPPS_PATH` globally. 
-
-
-
-## References
-[1] Original paragraph from Red Hat Enterprise Linux for Real Time 7 Tuning Guide. 2018-04-30 / CC BY-SA 3.0 https://creativecommons.org/licenses/by-sa/3.0/ 
--- a/cmds/runScript_test.cmd
+++ b/cmds/runScript_test.cmd
-require iocStats,617a4fd
-
-var runScriptDebug 1
-
--- a/cmds/test.cmd
+++ b/cmds/test.cmd
-
-var requireDebug 1
-require iocStats,617a4fd
-
-
-
-loadIocsh("iocStats.iocsh", "IOCNAME=TEST1:")
-
-iocInit()
-
--- a/configure/CONFIG
+++ b/configure/CONFIG
@@ -18,17 +18,23 @@ include $(TOP)/configure/CONFIG_MODULE
 endif


+E3_MODULES_PATH:=$(EPICS_BASE)
+E3_REQUIRE_CONFIG:=$(TOP)/configure/E3

 include $(EPICS_BASE)/configure/CONFIG_BASE_VERSION
-include $(TOP)/configure/E3/CONFIG_REQUIRE
-include $(TOP)/configure/E3/CONFIG_SHELL
-include $(TOP)/configure/E3/CONFIG_E3_PATH
-include $(TOP)/configure/E3/CONFIG_E3_MAKEFILE
-include $(TOP)/configure/E3/CONFIG_EPICS
-include $(TOP)/configure/E3/CONFIG_EXPORT
-include $(TOP)/configure/E3/CONFIG_TEST
-
-
+include $(E3_REQUIRE_CONFIG)/CONFIG_REQUIRE
+include $(E3_REQUIRE_CONFIG)/CONFIG_SHELL
+include $(E3_REQUIRE_CONFIG)/CONFIG_E3_PATH
+include $(E3_REQUIRE_CONFIG)/CONFIG_E3_MAKEFILE
+include $(E3_REQUIRE_CONFIG)/CONFIG_E3_META
+include $(E3_REQUIRE_CONFIG)/CONFIG_TEST
+include $(E3_REQUIRE_CONFIG)/CONFIG_EXPORT
+
+# Exclude generated EPICS base variables from make vars report.
+VARS_EXCLUDES+=BASE_3_14
+VARS_EXCLUDES+=BASE_3_15
+VARS_EXCLUDES+=BASE_3_16
+VARS_EXCLUDES+=BASE_7_0
 VARS_EXCLUDES+=EPICS_VERSION
 VARS_EXCLUDES+=EPICS_REVISION
 VARS_EXCLUDES+=EPICS_MODIFICATION
@@ -37,4 +43,3 @@ VARS_EXCLUDES+=EPICS_DEV_SNAPSHOT
 VARS_EXCLUDES+=EPICS_PATCH_VSTRING
 VARS_EXCLUDES+=EPICS_SITE_VSTRING
 VARS_EXCLUDES+=COMMIT_DATE
-
--- a/configure/CONFIG_MODULE
+++ b/configure/CONFIG_MODULE
@@ -19,4 +19,3 @@ E3_MODULE_VERSION=$(E3_REQUIRE_VERSION)
 -include $(TOP)/../../REQUIRE_CONFIG_MODULE.local
 -include $(TOP)/../REQUIRE_CONFIG_MODULE.local
 -include $(TOP)/configure/CONFIG_MODULE.local
-
--- a/configure/CONFIG_MODULE_DEV
+++ b/configure/CONFIG_MODULE_DEV
-EPICS_MODULE_TAG:=master
-#
-EPICS_MODULE_NAME:=${E3_REQUIRE_NAME}
-#
-E3_MODULE_SRC_PATH:=$(EPICS_MODULE_NAME)
-E3_MODULE_MAKEFILE:=$(EPICS_MODULE_NAME).Makefile
-
-E3_MODULE_NAME:=$(EPICS_MODULE_NAME)
-E3_MODULE_VERSION:=3.3.0
-#
-#
-#
-E3_MODULE_DEV_GITURL:="https://github.com/icshwi/require-ess"
-
-
-
-# The definitions shown below can also be placed in an untracked CONFIG_MODULE.local
-include $(TOP)/../../REQUIRE_CONFIG_MODULE_DEV.local
-include $(TOP)/../REQUIRE_CONFIG_MODULE_DEV.local
-include $(TOP)/configure/CONFIG_MODULE_DEV.local
-
--- a/configure/E3/CONFIG
+++ b/configure/E3/CONFIG
+# -*- mode: Makefile;-*-
+
+# Update the module version (for numeric versions) with a revision number of 0 if none is specified
+E3_MODULE_VERSION:=$(E3_MODULE_VERSION)$(shell (echo "$(E3_MODULE_VERSION)" | grep -Eq "^[0-9]+\.[0-9]+\.[0-9]+\$$") && echo +0)
+
+E3_MODULES_PATH?=$(E3_SITEMODS_PATH)
+E3_REQUIRE_CONFIG:=$(E3_REQUIRE_LOCATION)/configure
+
+include $(EPICS_BASE)/configure/CONFIG_BASE_VERSION
+include $(E3_REQUIRE_CONFIG)/CONFIG_REQUIRE
+include $(E3_REQUIRE_CONFIG)/CONFIG_SHELL
+include $(E3_REQUIRE_CONFIG)/CONFIG_CELL
+include $(E3_REQUIRE_CONFIG)/CONFIG_PATCH
+include $(E3_REQUIRE_CONFIG)/CONFIG_TEST
+include $(E3_REQUIRE_CONFIG)/CONFIG_E3_PATH
+include $(E3_REQUIRE_CONFIG)/CONFIG_E3_MAKEFILE
+include $(E3_REQUIRE_CONFIG)/CONFIG_E3_META
+include $(E3_REQUIRE_CONFIG)/CONFIG_DKMS
+include $(E3_REQUIRE_CONFIG)/CONFIG_EXPORT
+
+VARS_EXCLUDES+=BASE_3_14
+VARS_EXCLUDES+=BASE_3_15
+VARS_EXCLUDES+=BASE_3_16
+VARS_EXCLUDES+=BASE_7_0
+VARS_EXCLUDES+=EPICS_VERSION
+VARS_EXCLUDES+=EPICS_REVISION
+VARS_EXCLUDES+=EPICS_MODIFICATION
+VARS_EXCLUDES+=EPICS_PATCH_LEVEL
+VARS_EXCLUDES+=EPICS_DEV_SNAPSHOT
+VARS_EXCLUDES+=EPICS_PATCH_VSTRING
+VARS_EXCLUDES+=EPICS_SITE_VSTRING
+VARS_EXCLUDES+=COMMIT_DATE
--- a/configure/modules/CONFIG_CELL
+++ b/configure/modules/CONFIG_CELL

 # TOP is e3-MODULENAME
 ifneq (,$(findstring cell,$(MAKECMDGOALS)))
+# Check if non cell targets are being called
+NON_CELL_TARGETS=install uninstall build debug rebuild vars
+ifneq (,$(filter $(NON_CELL_TARGETS),$(MAKECMDGOALS)))
+  $(error cell targets cannot be called with non cell targets on the same command line)
+endif
 ## Default is e3-MODULENAME/cellMods
 E3_CELL_PATH=$(TOP)/cellMods
 ##
@@ -9,7 +14,7 @@ E3_CELL_PATH=$(TOP)/cellMods
 ##
 ## Useful if one would like to install many different modules in
 ## a specific directory for massive debugging purpose
-## 
+##
 -include $(TOP)/../CONFIG_CELL.local
 -include $(TOP)/configure/CONFIG_CELL.local
 E3_MODULES_PATH=$(E3_CELL_PATH)/$(notdir $(EPICS_BASE))/require-$(E3_REQUIRE_VERSION)

--- a/configure/modules/CONFIG_DKMS
+++ b/configure/modules/CONFIG_DKMS
--- a/configure/E3/CONFIG_E3_MAKEFILE
+++ b/configure/E3/CONFIG_E3_MAKEFILE
 # Pass necessary driver.makefile variables through makefile options
 #

-# Here, E3_MODULES_PATH is the same as E3_REQUIRE_LOCATION
-E3_MODULES_PATH:=$(EPICS_BASE)
-
 E3_REQUIRE_MAKEFILE_INPUT_OPTIONS := -C $(E3_MODULE_SRC_PATH)
-E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += -f $(E3_MODULE_MAKEFILE)
+E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += -f ../$(E3_MODULE_MAKEFILE)
 E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += LIBVERSION="$(E3_MODULE_VERSION)"
 E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += PROJECT="$(E3_MODULE_NAME)"
 E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += EPICS_MODULES="$(E3_MODULES_PATH)"
 E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += EPICS_LOCATION="$(EPICS_BASE)"
-E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += BUILDCLASSES="Linux"
 E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += E3_SITEMODS_PATH="$(E3_SITEMODS_PATH)"
-E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += E3_SITEAPPS_PATH="$(E3_SITEAPPS_PATH)"
-E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += E3_SITELIBS_PATH="$(E3_SITELIBS_PATH)"

 ifeq ($(shell git status > /dev/null 2>&1; echo $$?),0)
 GIT_REMOTE_NAME := $(shell git remote | head -n 1)

-E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += $(E3_MODULE_NAME)_E3_GIT_DESC="$(shell git describe --tags 2> /dev/null || git rev-parse HEAD 2> /dev/null || echo 'Not a git repository')"
-E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += $(E3_MODULE_NAME)_E3_GIT_STATUS="[ $(shell git status --porcelain | sed 's/^/\\\\\\\"/' | sed 's/$$/\\\\\\\", /')]"
-E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += $(E3_MODULE_NAME)_E3_GIT_URL="$(shell git config --get remote.$(GIT_REMOTE_NAME).url 2> /dev/null | sed 's%^https://[^@]*@%https://%')"
+$(E3_MODULE_NAME)_E3_GIT_DESC="$(shell git rev-parse HEAD 2> /dev/null || echo 'Not a git repository')"
+$(E3_MODULE_NAME)_E3_GIT_URL="$(shell git config --get remote.$(GIT_REMOTE_NAME).url 2> /dev/null | sed 's%^https://[^@]*@%https://%')"
 else
-E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += $(E3_MODULE_NAME)_E3_GIT_DESC=
-E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += $(E3_MODULE_NAME)_E3_GIT_STATUS=
-E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += $(E3_MODULE_NAME)_E3_GIT_URL=
+$(E3_MODULE_NAME)_E3_GIT_DESC=
+$(E3_MODULE_NAME)_E3_GIT_URL=
 endif

+E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += $(E3_MODULE_NAME)_E3_GIT_DESC=$($(E3_MODULE_NAME)_E3_GIT_DESC)
+E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += $(E3_MODULE_NAME)_E3_GIT_URL=$($(E3_MODULE_NAME)_E3_GIT_URL)

 E3_MODULE_MAKE_CMDS:=make $(E3_REQUIRE_MAKEFILE_INPUT_OPTIONS)

@@ -34,4 +28,6 @@ E3_MODULE_MAKE_CMDS:=make $(E3_REQUIRE_MAKEFILE_INPUT_OPTIONS)
 ## the following variables to display

 VARS_EXCLUDES+=E3_REQUIRE_MAKEFILE_INPUT_OPTIONS
-
+VARS_EXCLUDES+=GIT_REMOTE_NAME
+VARS_EXCLUDES+=$(E3_MODULE_NAME)_E3_GIT_URL
+VARS_EXCLUDES+=$(E3_MODULE_NAME)_E3_GIT_DESC
No results found