Merge pull request #236 from daira/2725.timezone-test.0

[tahoe-lafs/tahoe-lafs.git] / docs / backupdb.rst

diff --git a/docs/backupdb.rst b/docs/backupdb.rst
index 15aaaee9793aea10e0de19146f97ca2c865eba5d..659c2fd7b5cf4de4a56dd8bb052fdcd2514abc6d 100644 (file)
--- a/docs/backupdb.rst
+++ b/docs/backupdb.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ==================
 The Tahoe BackupDB
 ==================
@@ -52,7 +54,7 @@ The database contains the following tables::
   
   CREATE TABLE local_files
   (
-   path  varchar(1024),  PRIMARY KEY -- index, this is os.path.abspath(fn)
+   path  varchar(1024),  PRIMARY KEY -- index, this is an absolute UTF-8-encoded local filename
    size  integer,         -- os.stat(fn)[stat.ST_SIZE]
    mtime number,          -- os.stat(fn)[stat.ST_MTIME]
    ctime number,          -- os.stat(fn)[stat.ST_CTIME]
@@ -91,7 +93,8 @@ The first step is to convert the path to an absolute form
 is not present in this table, the file must be uploaded. The upload process
 is:
 
-1. record the file's size, creation time, and modification time
+1. record the file's size, ctime (which is the directory-entry change time or
+   file creation time depending on OS) and modification time
 
 2. upload the file into the grid, obtaining an immutable file read-cap