From 6273fcd1e0f21e9c5c475dd870b2437f5c5f3851 Mon Sep 17 00:00:00 2001 From: Hisham Muhammad Date: Sun, 5 Jan 2025 22:12:26 -0300 Subject: docs: update `upload` docs as per #1733 --- docs/luarocks_upload.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/luarocks_upload.md b/docs/luarocks_upload.md index 167ec803..c80a5104 100644 --- a/docs/luarocks_upload.md +++ b/docs/luarocks_upload.md @@ -4,10 +4,13 @@ Upload a rockspec to the public rocks repository. ## Usage -`luarocks upload [--skip-pack] [--api-key=] [--force] ` +`luarocks upload [--skip-pack] [--api-key=] [--force] []` -Packs a source rock file (`.src.rock`) using a rockspec and uploads it -and the rockspec to the public rocks repository. +Packs a source rock file (`.src.rock`) using a rockspec and + +Uploads a rockspec and a source rock file (`.src.rock`) to the public rocks +repository. If the `.src.rock` file is not given, the command generates the +`.src.rock` file from the rockspec by itself. To access the server, an API key is required. It is passed using `--api-key` option and can be issued at the [LuaRocks site](https://luarocks.org/) on -- cgit v1.2.3-55-g6feb