]> jspc29.x-matter.uni-frankfurt.de Git - hades_mdc_settings.git/commitdiff
add directory for settings and scripts
authorJan Michel <j.michel@gsi.de>
Fri, 19 Aug 2022 14:37:01 +0000 (16:37 +0200)
committerJan Michel <j.michel@gsi.de>
Fri, 19 Aug 2022 14:37:01 +0000 (16:37 +0200)
scripts/README.md [new file with mode: 0644]
settings/.gitignore [new file with mode: 0644]
settings/README.md [new file with mode: 0644]

diff --git a/scripts/README.md b/scripts/README.md
new file mode 100644 (file)
index 0000000..f809f16
--- /dev/null
@@ -0,0 +1,5 @@
+##Scripts
+
+* `XYZ` generates trbcmd files from the common baseline database
+* `ABC` generates and loads settings from the 'settings' directory to the FPGAs flashes
+* `DEF` loads all settings from the 'settings' directory to the FPGA directly
diff --git a/settings/.gitignore b/settings/.gitignore
new file mode 100644 (file)
index 0000000..ee72d94
--- /dev/null
@@ -0,0 +1,2 @@
+*baseline.trbcmd
+*auto.trbcmd
diff --git a/settings/README.md b/settings/README.md
new file mode 100644 (file)
index 0000000..5bfb4b9
--- /dev/null
@@ -0,0 +1,15 @@
+##Temporary Files to be loaded to Flash
+
+* All settings that should be stored in Flash need to be present in this directory.
+* All files should be valid trbcmd files that can be loaded directly with `trbcmd -f`
+
+* Filenames need to start with the four digits (lower case) of the board address they should be loaded to.
+* Extension of all files should be .trbcmd.
+* Multiple files for the same target can exist with arbitrary additional characters in the file name.
+* Automatically generated files should have a filename ending in 'baseline' or 'auto' to be ignored by git.
+
+* Files that start with "common" are loaded to all boards. 
+* Common files are loaded first, so that settings can be overwritten with addressed files
+
+* Manually created files should be added to the git repository. Automatically generated files (e.g. baselines) should not be added.
+