From d0a9a6f151d30361c27c84c962c0908389770bc3 Mon Sep 17 00:00:00 2001 From: Jan Michel Date: Fri, 19 Aug 2022 16:37:01 +0200 Subject: [PATCH] add directory for settings and scripts --- scripts/README.md | 5 +++++ settings/.gitignore | 2 ++ settings/README.md | 15 +++++++++++++++ 3 files changed, 22 insertions(+) create mode 100644 scripts/README.md create mode 100644 settings/.gitignore create mode 100644 settings/README.md diff --git a/scripts/README.md b/scripts/README.md new file mode 100644 index 0000000..f809f16 --- /dev/null +++ b/scripts/README.md @@ -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 index 0000000..ee72d94 --- /dev/null +++ b/settings/.gitignore @@ -0,0 +1,2 @@ +*baseline.trbcmd +*auto.trbcmd diff --git a/settings/README.md b/settings/README.md new file mode 100644 index 0000000..5bfb4b9 --- /dev/null +++ b/settings/README.md @@ -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. + -- 2.43.0