From dbdecfe94b814a85a16aac0760d7dce6789c29cc Mon Sep 17 00:00:00 2001
From: AnyOldName3 <krizdjali@gmail.com>
Date: Tue, 27 Feb 2024 01:41:12 +0000
Subject: [PATCH] Use approved safety comment for path escaping explanation

I thought I'd got this one already
---
 components/config/gamesettings.cpp | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/components/config/gamesettings.cpp b/components/config/gamesettings.cpp
index 339acd01fe..cf0f7e382d 100644
--- a/components/config/gamesettings.cpp
+++ b/components/config/gamesettings.cpp
@@ -147,8 +147,11 @@ bool Config::GameSettings::readFile(QTextStream& stream, QMultiMap<QString, QStr
                 || key == QLatin1String("load-savegame"))
             {
                 // Path line (e.g. 'data=...'), so needs processing to deal with ampersands and quotes
-                // The following is based on boost::io::detail::quoted_manip.hpp, but calling those functions did not
-                // work as there are too may QStrings involved
+                // The following is based on boost::io::detail::quoted_manip.hpp, but we don't actually use
+                // boost::filesystem::path anymore, and use a custom class MaybeQuotedPath which uses Boost-like quoting
+                // rules but internally stores as a std::filesystem::path.
+                // Caution: This is intentional behaviour to duplicate how Boost and what we replaced it with worked,
+                // and we rely on that.
                 QChar delim = '\"';
                 QChar escape = '&';