diff options
| author | Hisham Muhammad <hisham@gobolinux.org> | 2025-01-05 22:12:26 -0300 |
|---|---|---|
| committer | Hisham Muhammad <hisham@gobolinux.org> | 2025-02-21 11:22:43 -0300 |
| commit | 6273fcd1e0f21e9c5c475dd870b2437f5c5f3851 (patch) | |
| tree | e037aeb5af72418ad19428ab1bf23ebe26ee124d | |
| parent | 7e86fa86b4d08fd6118d6eab46d92b29ffea791e (diff) | |
| download | luarocks-6273fcd1e0f21e9c5c475dd870b2437f5c5f3851.tar.gz luarocks-6273fcd1e0f21e9c5c475dd870b2437f5c5f3851.tar.bz2 luarocks-6273fcd1e0f21e9c5c475dd870b2437f5c5f3851.zip | |
docs: update `upload` docs as per #1733
| -rw-r--r-- | docs/luarocks_upload.md | 9 |
1 files changed, 6 insertions, 3 deletions
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. | |||
| 4 | 4 | ||
| 5 | ## Usage | 5 | ## Usage |
| 6 | 6 | ||
| 7 | `luarocks upload [--skip-pack] [--api-key=<key>] [--force] <rockspec>` | 7 | `luarocks upload [--skip-pack] [--api-key=<key>] [--force] <rockspec> [<src.rock>]` |
| 8 | 8 | ||
| 9 | Packs a source rock file (`.src.rock`) using a rockspec and uploads it | 9 | Packs a source rock file (`.src.rock`) using a rockspec and |
| 10 | and the rockspec to the public rocks repository. | 10 | |
| 11 | Uploads a rockspec and a source rock file (`.src.rock`) to the public rocks | ||
| 12 | repository. If the `.src.rock` file is not given, the command generates the | ||
| 13 | `.src.rock` file from the rockspec by itself. | ||
| 11 | 14 | ||
| 12 | To access the server, an API key is required. It is passed using `--api-key` | 15 | To access the server, an API key is required. It is passed using `--api-key` |
| 13 | option and can be issued at the [LuaRocks site](https://luarocks.org/) on | 16 | option and can be issued at the [LuaRocks site](https://luarocks.org/) on |