Updated docs on PHYSFS_setSaneConfig().
authorRyan C. Gordon <icculus@icculus.org>
Sat, 24 Mar 2012 15:02:18 -0400
changeset 1274 db0abc54e263
parent 1273 6bf67c4100f9
child 1275 98f9a2a0000b
Updated docs on PHYSFS_setSaneConfig().
src/physfs.h
--- a/src/physfs.h	Sat Mar 24 14:57:30 2012 -0400
+++ b/src/physfs.h	Sat Mar 24 15:02:18 2012 -0400
@@ -915,12 +915,12 @@
  *
  * Helper function.
  *
- * The write dir will be set to "userdir/.organization/appName", which is
+ * The write dir will be set to the pref dir returned by
+ *  \code PHYSFS_getPrefDir(organization, appName) \endcode, which is
  *  created if it doesn't exist.
  *
  * The above is sufficient to make sure your program's configuration directory
- *  is separated from other clutter, and platform-independent. The period
- *  before "mygame" even hides the directory on Unix systems.
+ *  is separated from other clutter, and platform-independent.
  *
  *  The search path will be:
  *
@@ -933,7 +933,8 @@
  *  be added to the search path. If you specified "PKG" for (archiveExt), and
  *  there's a file named data.PKG in the base dir, it'll be checked. Archives
  *  can either be appended or prepended to the search path in alphabetical
- *  order, regardless of which directories they were found in.
+ *  order, regardless of which directories they were found in. All archives
+ *  are mounted in the root of the virtual file system ("/").
  *
  * All of this can be accomplished from the application, but this just does it
  *  all for you. Feel free to add more to the search path manually, too.