diff --git a/documentation/index.html b/documentation/index.html index 2889f88..eceb918 100644 --- a/documentation/index.html +++ b/documentation/index.html @@ -229,6 +229,31 @@ dependencies { } +

Dependency versions

+

+ Kobalt lets you specify Maven coordinates in one line, such as "org.testng:testng:6.9.10". Note that Kobalt uses the Maven Coordinates defined in the Maven specification, which are a little bit different from the ones that Gradle uses. +

+

+ The standard format for such coordinates, as explained in the link above, is: +

+
+groupId:artifactId:packaging:classifier:version
+

+ packaging (e.g. "jar") and classifier (usually an arbitrary name) are optional and can be omitted. If version + is omitted, Kobalt will resolve the artifact to its latest version from all the specified repos. + Most of the time, you will only specify groupId, artifactId and version, but if you ever need to specify additional components such as packaging (sometimes referred to as "extension") or classifier, + please take note that these should appear before the version number. +

+

+ Here are a few examples of valid Maven coordinates: +

+
+# No version, resolves to the latest
+org.testng:testng:
+
+# Specifies an extension and a qualifier
+com.badlogicgames.gdx:gdx-platform:jar:natives-desktop:1.9.2
+

Dependency types

@@ -245,33 +270,21 @@ dependencies {

Exclude the given dependencies from the classpath. You can either specify a versioned id (e.g. "groupId:artifactId:version") or a versionless one ("groupId:artifactId:").
+
native
+
Used to define native dependencies.
-

Dependency versions

+
Native dependencies

-Kobalt lets you specify Maven coordinates in one line, such as "org.testng:testng:6.9.10". Note that Kobalt uses the Maven Coordinates defined in the Maven specification, which are a little bit different from the ones that Gradle uses. + Native dependencies will only be used when you invoke the run task on your project:

-

- The standard format for such coordinates, as explained in the link above, is: -

-
-groupId:artifactId:packaging:classifier:version
-

- packaging and classifier are optional and can be omitted. If version - is omitted, Kobalt will resolve the artifact to its latest version from all the specified repos. - Most of the time, you will only specify groupId, artifactId and version, but if you ever need to specify additional components such as packaging (sometimes referred to as "extension") or classifier, - please take note that these should appear before the version number. -

-

- Here are a few examples of valid Maven coordinates: -

-
-# No version, resolves to the latest
-org.testng:testng:
-
-# Specifies an extension and a qualifier
-com.badlogicgames.gdx:gdx-platform:jar:natives-desktop:1.9.2
- +
+dependencies {
+    native("org.lwjgl.lwjgl:lwjgl-platform:jar:natives-windows:2.9.3",
+           "org.lwjgl.lwjgl:lwjgl-platform:jar:natives-linux:2.9.3",
+           "org.lwjgl.lwjgl:lwjgl-platform:jar:natives-osx:2.9.3"
+        )
+    }

Settings

You can define settings that will apply to all your Kobalt builds by creating diff --git a/plug-in-development/index.html b/plug-in-development/index.html index 13d014d..75aafde 100644 --- a/plug-in-development/index.html +++ b/plug-in-development/index.html @@ -474,9 +474,8 @@ The @Task annotation accepts the following attributes:

Orderings, controlled by "runBefore" and "runAfter" merely specify an ordering - but do not pull new tasks in. This is how you tell Kobalt "In case task X is run, run my task before it - (or after)". But if task X doesn't run, your task will not be run either (unless it's explicitly requested - by the user). + but do not pull new tasks in. This is how you tell Kobalt "In case the user asks for my task to run, + here is when it should be invoked", but your task will run only if it's explicitly invoked by the user.

Here are a few different scenarios to illustrate how the three attributes work for the task example: