diff options
Diffstat (limited to 'docs/rock_manifest_file_format.md')
-rw-r--r-- | docs/rock_manifest_file_format.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/rock_manifest_file_format.md b/docs/rock_manifest_file_format.md new file mode 100644 index 00000000..e7838d11 --- /dev/null +++ b/docs/rock_manifest_file_format.md | |||
@@ -0,0 +1,19 @@ | |||
1 | # Rock manifest file format | ||
2 | |||
3 | The `rock_manifest` file lists the files contained in a binary rock, with the | ||
4 | MD5 checksum for each file. | ||
5 | |||
6 | It is a Lua file containing a single global variable definition, that defines | ||
7 | the variable **rock_manifest**, assigning to it a _table of file checksums_ of | ||
8 | the [archive file's root directory](Rock file format) (except for the | ||
9 | `rock_manifest` file itself). | ||
10 | |||
11 | A table of file checksums is defined as a table describing a directory, where | ||
12 | for each entry in the directory, there is a string key with its filename (only | ||
13 | the basename). | ||
14 | |||
15 | If the filename is a non-directory, the value of its key is a string with the | ||
16 | MD5 checksum of the file. | ||
17 | |||
18 | If the filename is a directory, the value of its key is itself a table of file | ||
19 | checksums of that directory. | ||