Add file header note for autogeneration and add comments

Author: OCopping

src/techui_builder/builder.py

@@ -111,9 +111,23 @@ def _create_devsta_pv(self, prefix: str, inputs: list[str]):
 
     def write_devsta_pvs(self):
         conf_dir = self._write_directory.parent.joinpath("config")
+
+        # Create the config/ dir if it doesn't exist
         if not conf_dir.exists():
             os.mkdir(conf_dir)
+
         with open(conf_dir.joinpath("ioc.db"), "w") as f:
+            # Add a header explaining the file is autogenerated
+            f.write("#" * 51 + "\n")
+            f.write(
+                "#" * 2
+                + " THIS FILE HAS BEEN AUTOGENERATED; DO NOT EDIT "
+                + "#" * 2
+                + "\n"
+            )
+            f.write("#" * 51 + "\n")
+
+            # Write the devsta PVs
             for dpv in self.devsta_pvs.values():
                 dpv.Print(f)