Merge pull request #2720 from ControlSystemStudio/CSSTUDIO-1964

CSSTUDIO-1964 Add the option "org.csstudio.display.builder.model/enable_saved_on_comments"

Author: abrahamwolk

app/display/model/src/main/java/org/csstudio/display/builder/model/Preferences.java

@@ -35,6 +35,8 @@ public class Preferences
     @Preference public static boolean skip_defaults;
     /** Preference setting */
     @Preference(name="macros") private static String macro_spec;
+    /** Preference setting */
+    @Preference public static boolean enable_saved_on_comments;
     private static Macros macros;
 
     static

app/display/model/src/main/java/org/csstudio/display/builder/model/persist/ModelWriter.java

@@ -43,6 +43,7 @@ public class ModelWriter implements Closeable
 {
     /** Add comments to the XML output? */
     public static boolean with_comments = Preferences.with_comments;
+    public static boolean enable_saved_on_comment = Preferences.enable_saved_on_comments;
 
     /** Default values are usually not written,
      *  but for tests they can be included in the XML output.
@@ -83,7 +84,9 @@ public ModelWriter(final OutputStream stream) throws Exception
         writer = new IndentingXMLStreamWriter(base);
 
         writer.writeStartDocument(XMLUtil.ENCODING, "1.0");
-        writer.writeComment("Saved on " + TimestampFormats.SECONDS_FORMAT.format(Instant.now()) + " by " + System.getProperty("user.name"));
+        if (enable_saved_on_comment) {
+            writer.writeComment("Saved on " + TimestampFormats.SECONDS_FORMAT.format(Instant.now()) + " by " + System.getProperty("user.name"));
+        }
         writer.writeStartElement(XMLTags.DISPLAY);
         writer.writeAttribute(XMLTags.VERSION, DisplayModel.VERSION.toString());
     }

app/display/model/src/main/resources/display_model_preferences.properties

@@ -85,3 +85,6 @@ with_comments=false
 
 # When writing a display file, skip properties that are still at default values?
 skip_defaults=true
+
+# Add a comment containing the date, time, and username when saving an OPI in the Display Editor.
+enable_saved_on_comments=true

app/display/model/src/test/java/org/csstudio/display/builder/model/AllWidgetsAllProperties.java

@@ -56,6 +56,7 @@ public static void main(String[] args) throws Exception
         }
         ModelWriter.with_comments = true;
         ModelWriter.skip_defaults = false;
+        ModelWriter.enable_saved_on_comment = true;
         try
         {
             final ModelWriter writer = new ModelWriter(new FileOutputStream(filename));

docs/source/preference_properties.rst

@@ -623,6 +623,9 @@ File ../../app/display/model/src/main/resources/display_model_preferences.proper
    # When writing a display file, skip properties that are still at default values?
    skip_defaults=true
 
+   # Add a comment containing the date, time, and username when saving an OPI in the Display Editor.
+   enable_saved_on_comments=true
+
 
 display.builder.representation
 ------------------------------