aboutsummaryrefslogtreecommitdiff
path: root/docs/rockspec_format.md
diff options
context:
space:
mode:
authorRichard Beckmann <r.beckmann@protonmail.com>2025-03-16 09:19:45 +0000
committerHisham Muhammad <hisham@gobolinux.org>2025-03-17 17:33:33 +0000
commit9c777a4a681579bb5104ae8acaa9a160adf7bf97 (patch)
treeca9b9f9e6d6e9258d931a099044277f663f137a2 /docs/rockspec_format.md
parent535ce8fb743054fd5cb9ef2c243e9f9b8974391d (diff)
downloadluarocks-main.tar.gz
luarocks-main.tar.bz2
luarocks-main.zip
rockspec format: improve message for handling GitHub URLmain
Co-authored-by: Caleb Maclennan <caleb@alerque.com>
Diffstat (limited to '')
-rw-r--r--docs/rockspec_format.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/rockspec_format.md b/docs/rockspec_format.md
index a5fe1db9..3a7dfd3d 100644
--- a/docs/rockspec_format.md
+++ b/docs/rockspec_format.md
@@ -46,7 +46,7 @@ Dependencies are represented in LuaRocks through strings with a package name fol
46 * `https://` - for HTTPS URLs to archive file 46 * `https://` - for HTTPS URLs to archive file
47 * `sscm://` - for the SurroundSCM source control manager 47 * `sscm://` - for the SurroundSCM source control manager
48 * `svn://` - for the Subversion source control manager 48 * `svn://` - for the Subversion source control manager
49 * **Important:** A source control manager URL cannot start with `http://` `https://`, `ftp://` or `file://`. For example, `https://github.com/keplerproject/wsapi.git` is incorrect, even though it works perfectly fine with `git clone`. The correct one is `git://github.com/keplerproject/wsapi.git`. Also note that only for GitHub URLs `git://` is being treated the same as `git+https://`. This is due to [GitHub's increased security](https://github.blog/security/application-security/improving-git-protocol-security-github/) and preserving backwards compatibility. 49 * **Important:** A source control manager URL cannot start with `http://` `https://`, `ftp://` or `file://`. For example, `https://github.com/keplerproject/wsapi.git` is incorrect, even though it works perfectly fine with `git clone`. The correct one is `git+https://github.com/keplerproject/wsapi.git`. Also note that only for GitHub URLs `git://` is being automatically handled internally as if it was `git+https://`. This is due to preserve backwards compatibility while still working with [GitHub's increased default security](https://github.blog/security/application-security/improving-git-protocol-security-github/) measures in blocking insecure connection types.
50 * **source.md5** (string) - the MD5 sum for the source archive. Example: "9ca22fd9f9413b54802d3d40b38c4e5c" 50 * **source.md5** (string) - the MD5 sum for the source archive. Example: "9ca22fd9f9413b54802d3d40b38c4e5c"
51 * **source.file** (string) - the filename of the source archive. Can be omitted if it can be inferred from the `source.url` field. Example: "luasocket-2.0.1.tar.gz" 51 * **source.file** (string) - the filename of the source archive. Can be omitted if it can be inferred from the `source.url` field. Example: "luasocket-2.0.1.tar.gz"
52 * **source.dir** (string) - the name of the directory created when the source archive is unpacked. Can be omitted if it can be inferred from the `source.file` field. Example: "luasocket-2.0.1" 52 * **source.dir** (string) - the name of the directory created when the source archive is unpacked. Can be omitted if it can be inferred from the `source.file` field. Example: "luasocket-2.0.1"