From 8c5931bca4b85c8779bf69aeb04bad5ed4191b79 Mon Sep 17 00:00:00 2001
From: Johannes Schickel
Date: Thu, 25 Feb 2016 17:16:25 +0100
Subject: COMMON: Add documentation about savefile names.

---
 common/savefile.h | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'common/savefile.h')

diff --git a/common/savefile.h b/common/savefile.h
index f2205e2f4f..9fca07f9d5 100644
--- a/common/savefile.h
+++ b/common/savefile.h
@@ -56,6 +56,12 @@ typedef WriteStream OutSaveFile;
  * i.e. typically save states, but also configuration files and similar
  * things.
  *
+ * Savefile names represent SaveFiles. These names are case insensitive, that
+ * means a name of "Kq1.000" represents the same savefile as "kq1.000". In
+ * addition, SaveFileManager does not allow for names which contain path
+ * separators like '/' or '\'. This is because we do not support directories
+ * in SaveFileManager.
+ *
  * While not declared as a singleton, it is effectively used as such,
  * with OSystem::getSavefileManager returning a pointer to the single
  * SaveFileManager instances to be used.
-- 
cgit v1.2.3