Documentation update

CHANGELOG.md

@@ -10,13 +10,22 @@
 
 ### Detailed list of changes
 
+* Added secondary sorting by fullname when sorting systems
+* The Orphaned data cleanup utility will now skip any system where a flatten.txt file is present
+* Changed a number of error messages in the Orphaned data cleanup utility from uppercase to lowercase
+* (modern-es-de) Added system carousel fastScrolling
+* The application release number is now tracked on startup instead of the application version
 * Changed the systems sorting platform from "Peripheral" to "Console" for the fds, megacd, megacdjp, n64dd, pcenginecd and satellaview systems
 * Changed the systems sorting platform from "Peripheral" to "Console" for the sega32x, sega32xjp, sega32xna, segacd, sgb, sufami and tg-cd systems
+* Updated SDL to 2.28.5 on Windows, macOS and the Linux AppImage builds
+* Updated libgit2 to 1.7.1 on Windows and macOS
 
 ### Bug fixes
 
-* The year was incorrect in the systems sorting files for the amiga1200, amiga600, astrocde, kodi, solarus and stv systems
+* The Orphaned data cleanup utility removed media files that had the wrong letter case on Windows and macOS (i.e. case-insensitive filesystems)
-* The fmtowns system was incorrectly classified as a console and with the wrong release year in the systems sortings files
+* Horizontally scrolling text containers sometimes had an incorrect vertical offset
+* The year was incorrect in the systems sorting files for the amiga1200, amiga600, astrocde, coco, kodi, solarus, stv and trs-80 systems
+* The fmtowns system was incorrectly classified as a console and with the wrong release year in the systems sorting files
 
 ## Version 2.2.0
 

INSTALL-DEV.md

@@ -1494,7 +1494,7 @@ Here's an example where three systems have been sorted by release year instead o
 
 You only need to include systems that you want to customize sorting for, and if there's also a systemsortname tag present in the es_systems.xml file for any system, then the es_systems_sorting.xml entry will take precedence.
 
-Note that the `<systemsortname>` tags are sorted in [lexicographic order](https://en.wikipedia.org/wiki/Lexicographic_order) so 11 will be sorted above 2 but 002 will be sorted above 011.
+Note that the `<systemsortname>` tags are sorted in [lexicographic order](https://en.wikipedia.org/wiki/Lexicographic_order) so 11 will be sorted above 2 but 002 will be sorted above 011. Secondary sorting will always be done by the fullname tag in es_systems.xml.
 
 There are also four complete sorting files bundled with ES-DE, you can find them in the resources/sorting/ directory, or you can access them [here](https://gitlab.com/es-de/emulationstation-de/-/tree/master/resources/sorting).
 

USERGUIDE-DEV.md

@@ -359,6 +359,8 @@ In order to remove such unnecessary media files and configuration file entries,
 
 It's recommended to run this utility with the _Show hidden games_ setting enabled as orphaned gamelist.xml folder entries may otherwise not get purged.
 
+If a system has a flatten.txt file present in the root of its directory, then the system will be completely skipped and an error will be logged (using folder flattening is strongly discouraged in general).
+
 Note that there are no guarantees that any processed gamelist.xml files will be usable in any other applications than ES-DE. An attempt is made to retain the file structure but data unknown to ES-DE may get purged during cleanup.
 
 If the utility finds any data to be removed, a backup of the old files will be made. This will end up in a `CLEANUP` directory and will contain a date and time stamp. For example:
@@ -1023,6 +1025,7 @@ However, some users have a setup where they have separated games inside their sy
 * Any identically named files will be added only once in a semi-random fashion, meaning you could miss some games
 * If there is metadata available for multiple games with the same filename (which could happen if scraping was done prior to flattening the folders) then the behavior is undefined and metadata from the wrong game may get used
 * Some systems like MS-DOS and ScummVM may be completely broken
+* The Orphaned data cleanup utility will not process the system
 * The setup may cause confusion when reorganizing your collection and similar because what you'll see inside ES-DE will not reflect what you see when navigating the ROM directory in your operating system's file manager
 
 Only enable this functionality if you know exactly what you're doing and understand the adverse side effects mentioned above. If you have any name collisions in your directory structure then make sure to rename each file to have a unique name. Also delete your gamelist.xml file and rescrape the entire system after fixing any collisions as it's otherwise random which metadata will be used for those games.