augustin_s/sf_databuffer
0
0
Fork 0
forked from archiver_config/sf_databuffer
Code Pull Requests Activity

Enhance Readme

Browse Source
This commit is contained in:
maerki_f
2016-05-24 11:05:22 +02:00
parent 90a906fc53
commit 8b29ebfeae
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
Readme.md
View File

@@ -1,12 +1,12 @@
# Overview
This repository holds the actual requested configuration of the SwissFEL Data Buffer.
This repository holds the requested bsread data sources of the SwissFEL Data Buffer.
# Configuration Files
Config files are text files holding one IOC/Source a line. If the IOC is not reachable by the "standard" bsread port 9999 the port needs to be appended to the IOC name via `:<port>`.
Config files are text files holding one IOC/source per line. If the IOC is not reachable by the "standard" bsread port 9999 the port needs to be appended to the IOC name via `:<port>`.
The file might contain comments starting with `#` which are not interpreted.
Each group should maintain their own list of IOCs in (a) separate file(s). The filename should start with the groups short name (e.g. rf.config, llrf.config). A group might maintain more than 1 file. In this case all files should start with the groups short name followed by an underscore and then the rest of the name. The suffix should always be `.config` (e.g. llrf.config, llrf_group1.config, ...)
Each group should maintain their own list of IOCs in (a) separate file(s). The filename should start with the groups short name (e.g. rf.sources, llrf.sources). A group might maintain more than 1 file. In this case all files should start with the groups short name followed by an underscore and then the rest of the name. The suffix should always be `.sources` (e.g. llrf.sources, llrf_group1.sources, ...)
Example:
```
@@ -15,7 +15,8 @@ SOME_IOC_01
SOME_IOC_02
# Goup B IOCs
TEST_IOC_01:20000 # Special test IOC reachable on port 20000
# Special test IOC reachable on port 20000
TEST_IOC_01:20000
```
# Configuration Management