aboutsummaryrefslogtreecommitdiff
path: root/docs/file_formats.md
diff options
context:
space:
mode:
authorHisham Muhammad <hisham@gobolinux.org>2025-01-05 21:40:39 -0300
committerHisham Muhammad <hisham@gobolinux.org>2025-02-21 11:22:43 -0300
commit7e86fa86b4d08fd6118d6eab46d92b29ffea791e (patch)
tree10fdd12beed4b0eca408533ad11d1f52d7d62e10 /docs/file_formats.md
parent1ada2ea4bbd94ac0c58e3e2cc918194140090a75 (diff)
downloadluarocks-7e86fa86b4d08fd6118d6eab46d92b29ffea791e.tar.gz
luarocks-7e86fa86b4d08fd6118d6eab46d92b29ffea791e.tar.bz2
luarocks-7e86fa86b4d08fd6118d6eab46d92b29ffea791e.zip
docs: import Wiki docs into the main repo
Diffstat (limited to 'docs/file_formats.md')
-rw-r--r--docs/file_formats.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/file_formats.md b/docs/file_formats.md
new file mode 100644
index 00000000..9030cd26
--- /dev/null
+++ b/docs/file_formats.md
@@ -0,0 +1,23 @@
1# File formats
2
3These pages are the reference specification for file formats used by LuaRocks.
4All files are actual Lua files, but they are loaded in a restricted
5environment in which the standard Lua libraries are not available.
6
7* [Rockspec format](rockspec_format.md) - Rockspecs are the files which
8 contain rules explaining how rocks are built and installed as well as their
9 dependencies and other metadata.
10
11* [Config file format](config_file_format.md) - The specification of the
12 LuaRocks configuration file format, as it takes shape.
13
14* [Manifest file format](manifest_file_format.md) - The index file that
15 describes a LuaRocks [repository](rocks_repositories.md), used by both rocks
16 servers and rocks trees.
17
18* [Rock file format](rock_file_format.md) - Reference to the .rock file
19 format: the installable packages produced from
20 [rockspecs](rockspec_format.md).
21
22
23