From e27732421e01d8269261235315fdf0e7f9c7dab7 Mon Sep 17 00:00:00 2001
From: Alexei Kotov <alexdobrohotov@yandex.ru>
Date: Wed, 30 Oct 2024 20:18:04 +0300
Subject: [PATCH] Adjust intro comment for user openmw-cs.cfg (#5859)

---
 CHANGELOG.md                   |  1 +
 components/settings/parser.cpp | 23 +++++++++++++++++------
 2 files changed, 18 insertions(+), 6 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index baf6b8062b..a6ab3823b0 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -274,6 +274,7 @@
     Feature #8078: OpenMW-CS Terrain Equalize Tool
     Feature #8087: Creature movement flags are not exposed
     Feature #8145: Starter spell flag is not exposed
+    Task #5859: User openmw-cs.cfg has comment talking about settings.cfg
     Task #5896: Do not use deprecated MyGUI properties
     Task #6085: Replace boost::filesystem with std::filesystem
     Task #6149: Dehardcode Lua API_REVISION
diff --git a/components/settings/parser.cpp b/components/settings/parser.cpp
index ff6bc5ca48..4f42e109b6 100644
--- a/components/settings/parser.cpp
+++ b/components/settings/parser.cpp
@@ -287,13 +287,24 @@ void Settings::SettingsFileParser::saveSettingsFile(
     // exist), start the newly created file with a helpful comment.
     if (!existing)
     {
-        ostream << "# This is the OpenMW user 'settings.cfg' file.  This file only contains" << std::endl;
+        const std::string filename = Files::pathToUnicodeString(file.filename());
+        ostream << "# This is the OpenMW user '" << filename << "' file.  This file only contains" << std::endl;
         ostream << "# explicitly changed settings.  If you would like to revert a setting" << std::endl;
-        ostream << "# to its default, simply remove it from this file.  For available" << std::endl;
-        ostream << "# settings, see the file 'files/settings-default.cfg' in our source repo or the documentation at:"
-                << std::endl;
-        ostream << "#" << std::endl;
-        ostream << "#   https://openmw.readthedocs.io/en/master/reference/modding/settings/index.html" << std::endl;
+        ostream << "# to its default, simply remove it from this file." << std::endl;
+
+        if (filename == "settings.cfg")
+        {
+            ostream << "# For available settings, see the file 'files/settings-default.cfg' in our source repo or the "
+                       "documentation at:"
+                    << std::endl;
+            ostream << "#" << std::endl;
+            ostream << "#   https://openmw.readthedocs.io/en/master/reference/modding/settings/index.html" << std::endl;
+        }
+        else if (filename == "openmw-cs.cfg")
+        {
+            ostream << "# For available settings, see the file 'apps/opencs/model/prefs/values.hpp' in our source repo."
+                    << std::endl;
+        }
     }
 
     // We still have one more thing to do before we're completely done writing the file.