mirror of
https://github.com/ethauvin/kobalt-doc.git
synced 2025-04-24 11:37:11 -07:00
Reformat
This commit is contained in:
Cedric Beust
parent
bda4b0e66b
commit
7db92fe117
1 changed files with 128 additions and 114 deletions
|
|
@ -688,128 +688,142 @@ Here are the options that you can pass to <code>./kobaltw</code>:
|
|||
|
||||
<table style="font-size: 14px" class="table table-striped">
|
||||
<colgroup>
|
||||
<col span="1" style="width: 30%;">
|
||||
<col span="1" style="width: 5%;">
|
||||
<col span="1" style="width: 10%;">
|
||||
<col span="1" style="width: 20%;">
|
||||
<col span="1" style="width: 40%;">
|
||||
</colgroup>
|
||||
<thead>
|
||||
<col span="1" style="width: 30%;">
|
||||
<col span="1" style="width: 5%;">
|
||||
<col span="1" style="width: 10%;">
|
||||
<col span="1" style="width: 20%;">
|
||||
<col span="1" style="width: 40%;">
|
||||
</colgroup>
|
||||
<thead>
|
||||
<tr>
|
||||
<td>Name</td>
|
||||
<td>Type</td>
|
||||
<td>Default</td>
|
||||
<td>Description</td>
|
||||
<td>Details</td>
|
||||
<td>Name</td>
|
||||
<td>Type</td>
|
||||
<td>Default</td>
|
||||
<td>Description</td>
|
||||
<td>Details</td>
|
||||
</tr>
|
||||
</thead>
|
||||
</thead>
|
||||
|
||||
<tr>
|
||||
<td><code>--buildFile</code></td>
|
||||
<td>File</td>
|
||||
<td>kobalt/src/Build.kt</td>
|
||||
<td>Specify a build file.</td>
|
||||
<td>Use this option if you are trying to build a project whose <code>Build.kt</code> is not in <code>kobalt/src</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code><span style="white-space:nowrap">--checkVersions</span></code></td>
|
||||
<td>Boolean</td>
|
||||
<td>false</td>
|
||||
<td>Display all the new versions of your dependencies.</td>
|
||||
<td>This option looks at all the dependencies found in your build file and then contacts all the Maven repositories in order to find out if any of these repos contains a newer version. If any are found, they are displayed:
|
||||
<pre class="brush:plain">
|
||||
<tr>
|
||||
<td><code>--buildFile</code></td>
|
||||
<td>File</td>
|
||||
<td>kobalt/src/Build.kt</td>
|
||||
<td>Specify a build file.</td>
|
||||
<td>Use this option if you are trying to build a project whose <code>Build.kt</code> is not in
|
||||
<code>kobalt/src</code>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code><span style="white-space:nowrap">--checkVersions</span></code></td>
|
||||
<td>Boolean</td>
|
||||
<td>false</td>
|
||||
<td>Display all the new versions of your dependencies.</td>
|
||||
<td>This option looks at all the dependencies found in your build file and then contacts all the Maven
|
||||
repositories in order to find out if any of these repos contains a newer version. If any are found, they are
|
||||
displayed:
|
||||
<pre class="brush:plain">
|
||||
$ ./kobaltw --checkVersions
|
||||
New versions found:
|
||||
com.beust:klaxon:0.14
|
||||
org.testng:testng:6.9.12
|
||||
</pre>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--downloadSources</code></td>
|
||||
<td>Boolean</td>
|
||||
<td>false</td>
|
||||
<td>Whenever dependencies are resolved, their sources and Javadoc are downloaded as well.</td>
|
||||
<td>Mostly useful when used with <code>--resolve</code> or when Kobalt is launched in <code>--server</code> mode. </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--dryRun</code></td>
|
||||
<td>Boolean</td>
|
||||
<td>false</td>
|
||||
<td>Display the tasks about to be run without actually running them.</td>
|
||||
<td>Use this option to get an idea of what the build will run without actually building anything.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--init</code></td>
|
||||
<td>Comma-separated strings of template names.</td>
|
||||
<td>null</td>
|
||||
<td>Initialize a project for Kobalt with the given templates.</td>
|
||||
<td>The parameter to this argument is a list of template names separated by commas, e.g. <code>"java,myProject"</code>. Each template will be invoked in order so they can generate their files.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code><span style="white-space:nowrap">--listTemplates</span></code></td>
|
||||
<td></td>
|
||||
<td>N/A</td>
|
||||
<td>List all the templates available.</td>
|
||||
<td>Templates displayed by this command can then be passed as an argument to the <code>--init</code> parameter.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log</code></td>
|
||||
<td>Integer (0..3)</td>
|
||||
<td>1</td>
|
||||
<td>Specify the log level.</td>
|
||||
<td>The default level is 1. Level 0 will quiet everything and 2 and 3 will display increasingly verbose output.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code><span style="white-space:nowrap">--noIncremental</span></code></td>
|
||||
<td>Boolean</td>
|
||||
<td>false</td>
|
||||
<td>Turn off incremental builds.</td>
|
||||
<td>If this flag is specified, Kobalt will run all the tasks, even those that are incremental and would have
|
||||
been skipped.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--plugins</code></td>
|
||||
<td>Comma-separated list of plugin id's</td>
|
||||
<td></td>
|
||||
<td>Specify the plug-ins to load.</td>
|
||||
<td>This is similar to specifying these plug-in id's in a build file except that no build file is needed.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code><span style="white-space:nowrap">--pluginJarFiles</span></code></td>
|
||||
<td>Comma-separated list of plugin jar files</td>
|
||||
<td></td>
|
||||
<td>Specify the plug-ins to load.</td>
|
||||
<td>This is similar to specifying these plug-in id's in a build file except that no build file is needed.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--profiling</code></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>Display timings for the build tasks.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--resolve</code></td>
|
||||
<td>Maven id<br/>(e.g. <code>"com.beust:kobalt:0.228"</code>)</td>
|
||||
<td>N/A</td>
|
||||
<td>Display information about the given id.</td>
|
||||
<td>Display which repo this artifact can be found in and the whole graph of its dependencies.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--tasks</code></td>
|
||||
<td>Boolean</td>
|
||||
<td>false</td>
|
||||
<td>List the tasks available.</td>
|
||||
<td>Note that the available tasks will vary depending on which projects are in your build file.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--update</code></td>
|
||||
<td>Boolean</td>
|
||||
<td>false</td>
|
||||
<td>Update Kobalt to the latest version available.</td>
|
||||
<td>Use this flag if Kobalt just notified you that a new version is available and you want to update. Another way of doing this is to edit <code>kobalt/wrapper/kobalt-wrapper.properties</code> manually.</td>
|
||||
</tr>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--downloadSources</code></td>
|
||||
<td>Boolean</td>
|
||||
<td>false</td>
|
||||
<td>Whenever dependencies are resolved, their sources and Javadoc are downloaded as well.</td>
|
||||
<td>Mostly useful when used with <code>--resolve</code> or when Kobalt is launched in <code>--server</code>
|
||||
mode.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--dryRun</code></td>
|
||||
<td>Boolean</td>
|
||||
<td>false</td>
|
||||
<td>Display the tasks about to be run without actually running them.</td>
|
||||
<td>Use this option to get an idea of what the build will run without actually building anything.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--init</code></td>
|
||||
<td>Comma-separated strings of template names.</td>
|
||||
<td>null</td>
|
||||
<td>Initialize a project for Kobalt with the given templates.</td>
|
||||
<td>The parameter to this argument is a list of template names separated by commas, e.g.
|
||||
<code>"java,myProject"</code>. Each template will be invoked in order so they can generate their files.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code><span style="white-space:nowrap">--listTemplates</span></code></td>
|
||||
<td></td>
|
||||
<td>N/A</td>
|
||||
<td>List all the templates available.</td>
|
||||
<td>Templates displayed by this command can then be passed as an argument to the <code>--init</code> parameter.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log</code></td>
|
||||
<td>Integer (0..3)</td>
|
||||
<td>1</td>
|
||||
<td>Specify the log level.</td>
|
||||
<td>The default level is 1. Level 0 will quiet everything and 2 and 3 will display increasingly verbose
|
||||
output.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code><span style="white-space:nowrap">--noIncremental</span></code></td>
|
||||
<td>Boolean</td>
|
||||
<td>false</td>
|
||||
<td>Turn off incremental builds.</td>
|
||||
<td>If this flag is specified, Kobalt will run all the tasks, even those that are incremental and would have
|
||||
been skipped.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--plugins</code></td>
|
||||
<td>Comma-separated list of plugin id's</td>
|
||||
<td></td>
|
||||
<td>Specify the plug-ins to load.</td>
|
||||
<td>This is similar to specifying these plug-in id's in a build file except that no build file is needed.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code><span style="white-space:nowrap">--pluginJarFiles</span></code></td>
|
||||
<td>Comma-separated list of plugin jar files</td>
|
||||
<td></td>
|
||||
<td>Specify the plug-ins to load.</td>
|
||||
<td>This is similar to specifying these plug-in id's in a build file except that no build file is needed.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--profiling</code></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>Display timings for the build tasks.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--resolve</code></td>
|
||||
<td>Maven id<br/>(e.g. <code>"com.beust:kobalt:0.228"</code>)</td>
|
||||
<td>N/A</td>
|
||||
<td>Display information about the given id.</td>
|
||||
<td>Display which repo this artifact can be found in and the whole graph of its dependencies.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--tasks</code></td>
|
||||
<td>Boolean</td>
|
||||
<td>false</td>
|
||||
<td>List the tasks available.</td>
|
||||
<td>Note that the available tasks will vary depending on which projects are in your build file.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--update</code></td>
|
||||
<td>Boolean</td>
|
||||
<td>false</td>
|
||||
<td>Update Kobalt to the latest version available.</td>
|
||||
<td>Use this flag if Kobalt just notified you that a new version is available and you want to update. Another
|
||||
way of doing this is to edit <code>kobalt/wrapper/kobalt-wrapper.properties</code> manually.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p>
|
||||
<em>Note:</em> If the <code>--update</code> parameter can't download Kobalt because your machine is
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue