FriiDump 0.5.3.16: finalize release identity and documentation

[friidump.git] / src / redump_dat.h

diff --git a/src/redump_dat.h b/src/redump_dat.h
index 475f5c28acaad550d35eab0006f3e8767f44cb55..b3b2c833ff9bc3112f8a59eb826f78004695bd54 100644 (file)
--- a/src/redump_dat.h
+++ b/src/redump_dat.h
@@ -54,12 +54,16 @@ const char *redump_verify_match_kind_string(const redump_verify_result *result);
  * Resolve a DAT path predictably.
  *
  * Resolution order:
  * Resolve a DAT path predictably.
  *
  * Resolution order:

- *   1. explicit_dir, when non-empty;
- *   2. executable_dir/redump_dat;
- *   3. current-working-directory redump_dat.
+ *   1. explicit_dir, when non-empty (authoritative);
+ *   2. FRIIDUMP_REDUMP_DAT_DIR, when set (authoritative);
+ *   3. executable_dir/redump_dat (portable and CMake build layout);
+ *   4. executable_dir/../share/friidump/redump_dat (installed Unix layout);
+ *   5. current-working-directory redump_dat.

  *
  *

- * The selected candidate is always written to out_path when arguments are
- * valid. The return value is nonzero only when that candidate exists.
+ * CMake copies the bundled DAT files beside the build executable and installs
+ * them under the platform-appropriate data directory. The selected candidate
+ * is always written to out_path when arguments are valid. The return value is
+ * nonzero only when that candidate exists.

  */
 int redump_resolve_dat_path(
     const char *explicit_dir,
  */
 int redump_resolve_dat_path(
     const char *explicit_dir,