aboutsummaryrefslogtreecommitdiff
path: root/docs/creating_a_rock.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/creating_a_rock.md')
-rw-r--r--docs/creating_a_rock.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/docs/creating_a_rock.md b/docs/creating_a_rock.md
index 07de5ca5..a5441ea4 100644
--- a/docs/creating_a_rock.md
+++ b/docs/creating_a_rock.md
@@ -148,6 +148,14 @@ and `5.3`, but not yet-to-be-released `5.4`. There are a few other operators
148for specifying version constraints, see 148for specifying version constraints, see
149[Rockspec format](rockspec_format.md#dependency-information). 149[Rockspec format](rockspec_format.md#dependency-information).
150 150
151Rockspecs from [`rockspec_format = "3.1"`](rockspec_format.md#package-metadata)),
152have access to special variables with the path of the installed rocks of its
153dependencies. See the [section below](#including-documentation-and-other-files)
154for information on how rocks can include files in their installation. Each
155variable is the name of the dependency followed by the suffix `_ROCKDIR`. For
156the example above, variable `LUAKNIFE_ROCKDIR` will be provided with the path of
157the installed rock.
158
151#### C modules linking to external libraries 159#### C modules linking to external libraries
152 160
153*If your code does not use third-party libraries, you may skip this subsection.* 161*If your code does not use third-party libraries, you may skip this subsection.*
@@ -231,7 +239,7 @@ luarocks doc ROCKNAME
231Now, to complete the rockspec for public consumption we need to fill the 239Now, to complete the rockspec for public consumption we need to fill the
232sources.url field. For that, we need the code to be available online. We have 240sources.url field. For that, we need the code to be available online. We have
233two approaches for that: if you have your source code in an online repository 241two approaches for that: if you have your source code in an online repository
234such as [GitHub](GitHub)(https://github.com), you may use that directly. 242such as [GitHub](https://github.com), you may use that directly.
235Alternatively, you can publish a tarball with the sources on the web. 243Alternatively, you can publish a tarball with the sources on the web.
236 244
237### Method 1: using a repository such as Github 245### Method 1: using a repository such as Github
@@ -315,7 +323,7 @@ tar czvpf luafruits-1.0.tar.gz luafruits-1.0/
315 323
316And now we're ready to publish the tarball online. You can upload it to any 324And now we're ready to publish the tarball online. You can upload it to any
317public web server; if you need hosting space, you can use the Pages feature 325public web server; if you need hosting space, you can use the Pages feature
318from [GitHub](GitHub)(https://github.com). Your source section would then look 326from [GitHub](https://github.com). Your source section would then look
319something like this: 327something like this:
320 328
321```lua 329```lua