aboutsummaryrefslogtreecommitdiff
path: root/docs/rock_manifest_file_format.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/rock_manifest_file_format.md')
-rw-r--r--docs/rock_manifest_file_format.md19
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
3The `rock_manifest` file lists the files contained in a binary rock, with the
4MD5 checksum for each file.
5
6It is a Lua file containing a single global variable definition, that defines
7the variable **rock_manifest**, assigning to it a _table of file checksums_ of
8the [archive file's root directory](Rock file format) (except for the
9`rock_manifest` file itself).
10
11A table of file checksums is defined as a table describing a directory, where
12for each entry in the directory, there is a string key with its filename (only
13the basename).
14
15If the filename is a non-directory, the value of its key is a string with the
16MD5 checksum of the file.
17
18If the filename is a directory, the value of its key is itself a table of file
19checksums of that directory.