Continued:
[core.git] / contrib / file_stack / format.txt
index 9d88c78..058b5b8 100644 (file)
@@ -1,15 +1,16 @@
 A file-based stack:
 ===================
 
-This is the format for a file-based stack which works as any Stackable class.
+This is the format for a file-based stack which works as any other Stackable
+class.
 
 General made up:
 
-Purpose: | "magic"   | separator | count    | position | separator |
----------+-----------+-----------+----------+----------+-----------+
-Bytes:   | 9         | 1         | 20 (hex) | 20 (hex) | 1         |
----------+-----------+-----------+----------+----------+-----------+
-Example: | STACKv1.0 | 00        | 00...ff  | 00...ff  | ff        |
+Purpose: | "magic"   | separator | count    | separator | position | separator |
+---------+-----------+-----------+----------+-----------+------0---+-----------+
+Bytes:   | 9         | 1         | 20 (hex) | 1         | 20 (hex) | 1         |
+---------+-----------+-----------+----------+-----------+----------+-----------+
+Example: | STACKv1.0 | 01        | 00...ff  | 01        | 00...ff  | 02        |
 
 Continued:
 
@@ -17,7 +18,7 @@ Purpose: | hash 0 | separator | name 0 | entry 0    | hash n | separator | name
 ---------+--------+-----------+--------+------------+--------+-----------+--------+------------+-----+
 Bytes:   |  64    | 1         | 10     | 1-n (pack) |  64    | 1         | 10     | 1-n (pack) | 1   |
 ---------+--------+-----------+--------+------------+--------+-----------+--------+------------+-----+
-Example: | abc    |    ???    | foo    |    ...     | abc    |    ???    | bar    |     ...    | EOF |
+Example: | abc    |    03     | foo    |    ...     | abc    |    03     | bar    |     ...    | EOF |
 
 Explanations:
 -------------
@@ -29,4 +30,5 @@ Explanations:
  name X       - Name of stack the entries belongs in
  entry X      - The actual data, compressed with pack()
  EOF          - End-of-file character
+ ...          - Data
  ???          - Must be still found out which character/hashing algorthym fits best