notes: improve, make commodid map in common file

[ypp-sc-tools.main.git] / yarrg / notes

diff --git a/yarrg/notes b/yarrg/notes
index e1e9a14abba4aac942e84b7e1a689cd05f479ba7..b8e56352a1314051c6ef8cb79aa2cdb8ef3f3a9b 100644 (file)
--- a/yarrg/notes
+++ b/yarrg/notes
@@ -52,26 +52,30 @@ very few price changes, mostly qty changes
 ====================
 
 files
-  ARCHIVE-%{ocean}s-lock.par
+  ARCHIVE-lock
        never removed
 
-  ARCHIVE-%{ocean}s-main.par
+  ARCHIVE-common.yarga
        updated using rename
-       contains: magic, main, commod*, diff*
+       contains: magic, commod*
 
-  ARCHIVE-%{ocean}s-auxil.par
+  ARCHIVE-<ocean>-main.yarga
+       updated using rename
+       contains: magic, main, diff*
+
+  ARCHIVE-<ocean>-auxil.yarga
        appended or renamed; length is recorded in main
        contains: magic, auxil*, garbage (after recorded len)
 
-  ARCHIVE-%{ocean}s-log-%{islandid}s.par
+  ARCHIVE-<ocean>-log-<islandid>.yarga
        appended or renamed; length is recorded in main
-       refers to commods and auxils from main and auxil
+       refers to commods and auxils from common, main and auxil
        contains: magic, (diff, difflen)*, garbage (after recorded len)
 
-  ARCHIVE-%{ocean}s-arc-%{islandid}s-%4d.par.gz
+  ARCHIVE-<ocean>-chron-<islandid>-<%4d>.yarga.gz
        created in place; valid only if main mentions it
        refers to commods and auxils in this file only
-       however commods must be the same as those in main
+       however commods must be the same as those in common
        contains gzipped data for:
                magic, commod*, auxil*, diff*
 
@@ -82,9 +86,11 @@ format of each file except lock is a series of lines
 
  magic !yarrg-archive [...]                            magic, 1st line
 
- main  !island <islandid> <islandloglenbytes> <islandarcfiles> \
-               [...] "<islandname>
+ main  !island <islandid> <islandloglenbytes> [...] "<islandname>
+               !island lines are ordered by increasing islandid
  main  !auxil <auxillenbytes> [...]
+ main  !chron <islandid> <%4d> <firsttimestamp> <lasttimestamp> [...]
+               !chron lines are ordered, most recent first
 
  commod        <commodid>= <commodname>
 
@@ -109,9 +115,9 @@ format of each file except lock is a series of lines
                        applies to previous data
                        includes 6-byte len of one ^... line
 
-all numbers (including ids, byte counts, numbers of files) (but not
-including the arc file number %d in the arc file name) are in base64
-MS digit first using the following digits:
+all numbers (including ids, byte counts, numbers of files and
+timestamps) (but not including the chron file number %4d in the chron
+file name) are in base64 MS digit first using the following digits:
  0 1 2 3 4 5 6 7 8 9
  a b c d e f g h i j k l m n o p q r s t u v w x y z
  A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
@@ -124,9 +130,9 @@ log file is a series of diffs most recent last; each diff is
  for a log file, there may be some trailing garbage
  not referred to in main file (see "length of log file")
 
- for an arc file, the file length is definitive and the last
+ for a chron file, the file length is definitive and the last
  entry is always valid if the file is referred to in the main
- file, but any arc file not mentioned in the main file is
+ file, but any chron file not mentioned in the main file is
  garbage
 
 semantics of a diff