Skip to content

Commit 0176412

Browse files
committed
updated site
1 parent 0f3a3e7 commit 0176412

21 files changed

+269
-297
lines changed

2.x/docs/en/print.html

Lines changed: 29 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2105,19 +2105,17 @@ <h3 id="sbt-runner-and-sbt-server"><a class="header" href="#sbt-runner-and-sbt-s
21052105
<p>This mechanism allows builds to be configured to a specific version of sbt, and everyone working on the project would use the same build semantics, regardless of the sbt runner installed on their machine.</p>
21062106
<p>This also means that some features are implemented at sbt runner or sbtn level, while other features are implemented at sbt server level.</p>
21072107
<h2 id="sbt-commands"><a class="header" href="#sbt-commands">sbt commands</a></h2>
2108-
<div id="admonition-note" class="admonition admonish-note" role="note" aria-labelledby="admonition-note-title">
2108+
<div id="admonition-note-on-commands" class="admonition admonish-note" role="note" aria-labelledby="admonition-note-on-commands-title">
21092109
<div class="admonition-title">
2110-
<div id="admonition-note-title">
2111-
<p>Note</p>
2110+
<div id="admonition-note-on-commands-title">
2111+
<p>Note on commands</p>
21122112
</div>
2113-
<a class="admonition-anchor-link" href="reference/sbt.html#admonition-note"></a>
2113+
<a class="admonition-anchor-link" href="reference/sbt.html#admonition-note-on-commands"></a>
21142114
</div>
21152115
<div>
2116-
<p>There is a technical distinction in sbt between <em>tasks</em>, which are
2117-
<em>inside</em> the build definition, and <em>commands</em>, which often manipulate the
2118-
build definition itself.
2119-
This specific sbt meaning of <em>command</em> means there's no good general term for
2120-
<em>thing you can type at the sbt prompt</em>, which may be a setting, task, or command.</p>
2116+
<p>In sbt, there are <em>tasks</em> that operate at the subproject level (like <code>compile</code>), and <em>commands</em> in the narrow sense (like <code>set</code>), which is capable of manipulating the build definition itself.</p>
2117+
<p>Given that settings and tasks are lifted into the <code>act</code> command, we can consider <em>all things that can be typed into the sbt shell</em> as commands in the wide sense.
2118+
See the <a href="reference/../concepts/command.html">Command</a> concept page for details.</p>
21212119
</div>
21222120
</div>
21232121
<!--
@@ -2128,11 +2126,11 @@ <h2 id="sbt-commands"><a class="header" href="#sbt-commands">sbt commands</a></h
21282126
setting control which tasks from which projects are executed. See
21292127
[multi-project builds][Multi-Project].
21302128
-->
2131-
<h3 id="project-level-tasks"><a class="header" href="#project-level-tasks">Project-level tasks</a></h3>
2129+
<h3 id="subproject-level-tasks"><a class="header" href="#subproject-level-tasks">Subproject-level tasks</a></h3>
21322130
<ul>
21332131
<li><code>clean</code> Deletes all generated files (the <code>target</code> directory).</li>
21342132
<li><a href="reference/./sbt-publish.html"><code>publish</code></a> Publishes artifacts (such as JARs) to the repository
2135-
defined by the publishTo setting, described in Publishing.</li>
2133+
defined by the <code>publishTo</code> setting.</li>
21362134
<li><a href="reference/./sbt-publish.html"><code>publishLocal</code></a> Publishes artifacts (such as JARs) to the local Ivy
21372135
repository as described in Publishing.</li>
21382136
<li><a href="reference/./sbt-update.html"><code>update</code></a> Resolves and retrieves external dependencies.</li>
@@ -2184,15 +2182,16 @@ <h3 id="configuration-level-tasks"><a class="header" href="#configuration-level-
21842182
<ol>
21852183
<li>have not been run yet OR</li>
21862184
<li>failed the last time they were run OR</li>
2187-
<li>had any transitive dependencies recompiled since the last
2188-
successful run <code>*</code> is interpreted as a wildcard in the
2185+
<li>had any transitive dependencies recompiled since the last successful run<br>
2186+
<code>*</code> is interpreted as a wildcard in the
21892187
test name.</li>
21902188
</ol>
21912189
</li>
21922190
<li><a href="reference/./sbt-test.html"><code>testFull</code></a> Runs all tests detected during test compilation.</li>
2193-
<li><a href="reference/./sbt-test.html"><code>testOnly &lt;test&gt;*</code></a> Runs the tests provided as arguments.</li>
21942191
</ul>
21952192
<!--
2193+
- [`testOnly <test>*`](./sbt-test.md) Runs the tests provided as arguments.
2194+
21962195
- `consoleQuick` Starts the Scala interpreter with the project's
21972196
compile-time dependencies on the classpath. Test/consoleQuick uses
21982197
the test dependencies. This task differs from console in that it
@@ -2205,32 +2204,29 @@ <h3 id="configuration-level-tasks"><a class="header" href="#configuration-level-
22052204
-->
22062205
<h3 id="general-commands"><a class="header" href="#general-commands">General commands</a></h3>
22072206
<ul>
2208-
<li>
2209-
<p><code>exit</code> or <code>quit</code> End the current interactive session or build.
2207+
<li><code>shutdown</code> Shuts down the sbt server to end the current sbt session.</li>
2208+
<li><code>exit</code> or <code>quit</code> End the current interactive session or build.
22102209
Additionally, Ctrl+D (Unix) or Ctrl+Z (Windows) will exit the
2211-
interactive prompt.</p>
2212-
</li>
2213-
<li>
2214-
<p><code>help &lt;command&gt;</code> Displays detailed help for the specified command.
2210+
interactive prompt.</li>
2211+
<li><code>help &lt;command&gt;</code> Displays detailed help for the specified command.
22152212
If the command does not exist, help lists detailed help for commands
22162213
whose name or description match the argument, which is interpreted
22172214
as a regular expression. If no command is provided, displays brief
22182215
descriptions of the main commands. Related commands are tasks and
2219-
settings.</p>
2220-
</li>
2221-
<li>
2222-
<p><code>projects [add|remove &lt;URI&gt;]</code> List all available projects if no
2223-
arguments provided or adds/removes the build at the provided URI.</p>
2224-
<!-- (See [multi-project builds][Multi-Project] for details on multi-project
2216+
settings.</li>
2217+
<li><code>projects [add|remove &lt;URI&gt;]</code> List all available projects if no
2218+
arguments provided or adds/removes the build at the provided URI.<!-- (See [multi-project builds][Multi-Project] for details on multi-project
22252219
builds.) -->
22262220
</li>
2227-
<li>
2228-
<p><code>project &lt;project-id&gt;</code> Change the current project to the project
2229-
with ID <code>&lt;project-id&gt;</code>. Further operations will be done in the
2230-
context of the given project.</p>
2231-
<!-- (See [multi-project builds][Multi-Project] for
2232-
details on multiple project builds.) -->
2233-
</li>
2221+
</ul>
2222+
<!--
2223+
- `project <project-id>` Change the current project to the project
2224+
with ID `<project-id>`. Further operations will be done in the
2225+
context of the given project.
2226+
(See [multi-project builds][Multi-Project] for
2227+
details on multiple project builds.)
2228+
-->
2229+
<ul>
22342230
<li>
22352231
<p><a href="reference/./watch.html">Watch command</a> <code>~ &lt;command&gt;</code> Executes the project specified action or method
22362232
whenever source files change.</p>

2.x/docs/en/reference/sbt.html

Lines changed: 29 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -238,19 +238,17 @@ <h3 id="sbt-runner-and-sbt-server"><a class="header" href="#sbt-runner-and-sbt-s
238238
<p>This mechanism allows builds to be configured to a specific version of sbt, and everyone working on the project would use the same build semantics, regardless of the sbt runner installed on their machine.</p>
239239
<p>This also means that some features are implemented at sbt runner or sbtn level, while other features are implemented at sbt server level.</p>
240240
<h2 id="sbt-commands"><a class="header" href="#sbt-commands">sbt commands</a></h2>
241-
<div id="admonition-note" class="admonition admonish-note" role="note" aria-labelledby="admonition-note-title">
241+
<div id="admonition-note-on-commands" class="admonition admonish-note" role="note" aria-labelledby="admonition-note-on-commands-title">
242242
<div class="admonition-title">
243-
<div id="admonition-note-title">
244-
<p>Note</p>
243+
<div id="admonition-note-on-commands-title">
244+
<p>Note on commands</p>
245245
</div>
246-
<a class="admonition-anchor-link" href="#admonition-note"></a>
246+
<a class="admonition-anchor-link" href="#admonition-note-on-commands"></a>
247247
</div>
248248
<div>
249-
<p>There is a technical distinction in sbt between <em>tasks</em>, which are
250-
<em>inside</em> the build definition, and <em>commands</em>, which often manipulate the
251-
build definition itself.
252-
This specific sbt meaning of <em>command</em> means there's no good general term for
253-
<em>thing you can type at the sbt prompt</em>, which may be a setting, task, or command.</p>
249+
<p>In sbt, there are <em>tasks</em> that operate at the subproject level (like <code>compile</code>), and <em>commands</em> in the narrow sense (like <code>set</code>), which is capable of manipulating the build definition itself.</p>
250+
<p>Given that settings and tasks are lifted into the <code>act</code> command, we can consider <em>all things that can be typed into the sbt shell</em> as commands in the wide sense.
251+
See the <a href="../concepts/command.html">Command</a> concept page for details.</p>
254252
</div>
255253
</div>
256254
<!--
@@ -261,11 +259,11 @@ <h2 id="sbt-commands"><a class="header" href="#sbt-commands">sbt commands</a></h
261259
setting control which tasks from which projects are executed. See
262260
[multi-project builds][Multi-Project].
263261
-->
264-
<h3 id="project-level-tasks"><a class="header" href="#project-level-tasks">Project-level tasks</a></h3>
262+
<h3 id="subproject-level-tasks"><a class="header" href="#subproject-level-tasks">Subproject-level tasks</a></h3>
265263
<ul>
266264
<li><code>clean</code> Deletes all generated files (the <code>target</code> directory).</li>
267265
<li><a href="./sbt-publish.html"><code>publish</code></a> Publishes artifacts (such as JARs) to the repository
268-
defined by the publishTo setting, described in Publishing.</li>
266+
defined by the <code>publishTo</code> setting.</li>
269267
<li><a href="./sbt-publish.html"><code>publishLocal</code></a> Publishes artifacts (such as JARs) to the local Ivy
270268
repository as described in Publishing.</li>
271269
<li><a href="./sbt-update.html"><code>update</code></a> Resolves and retrieves external dependencies.</li>
@@ -317,15 +315,16 @@ <h3 id="configuration-level-tasks"><a class="header" href="#configuration-level-
317315
<ol>
318316
<li>have not been run yet OR</li>
319317
<li>failed the last time they were run OR</li>
320-
<li>had any transitive dependencies recompiled since the last
321-
successful run <code>*</code> is interpreted as a wildcard in the
318+
<li>had any transitive dependencies recompiled since the last successful run<br>
319+
<code>*</code> is interpreted as a wildcard in the
322320
test name.</li>
323321
</ol>
324322
</li>
325323
<li><a href="./sbt-test.html"><code>testFull</code></a> Runs all tests detected during test compilation.</li>
326-
<li><a href="./sbt-test.html"><code>testOnly &lt;test&gt;*</code></a> Runs the tests provided as arguments.</li>
327324
</ul>
328325
<!--
326+
- [`testOnly <test>*`](./sbt-test.md) Runs the tests provided as arguments.
327+
329328
- `consoleQuick` Starts the Scala interpreter with the project's
330329
compile-time dependencies on the classpath. Test/consoleQuick uses
331330
the test dependencies. This task differs from console in that it
@@ -338,32 +337,29 @@ <h3 id="configuration-level-tasks"><a class="header" href="#configuration-level-
338337
-->
339338
<h3 id="general-commands"><a class="header" href="#general-commands">General commands</a></h3>
340339
<ul>
341-
<li>
342-
<p><code>exit</code> or <code>quit</code> End the current interactive session or build.
340+
<li><code>shutdown</code> Shuts down the sbt server to end the current sbt session.</li>
341+
<li><code>exit</code> or <code>quit</code> End the current interactive session or build.
343342
Additionally, Ctrl+D (Unix) or Ctrl+Z (Windows) will exit the
344-
interactive prompt.</p>
345-
</li>
346-
<li>
347-
<p><code>help &lt;command&gt;</code> Displays detailed help for the specified command.
343+
interactive prompt.</li>
344+
<li><code>help &lt;command&gt;</code> Displays detailed help for the specified command.
348345
If the command does not exist, help lists detailed help for commands
349346
whose name or description match the argument, which is interpreted
350347
as a regular expression. If no command is provided, displays brief
351348
descriptions of the main commands. Related commands are tasks and
352-
settings.</p>
353-
</li>
354-
<li>
355-
<p><code>projects [add|remove &lt;URI&gt;]</code> List all available projects if no
356-
arguments provided or adds/removes the build at the provided URI.</p>
357-
<!-- (See [multi-project builds][Multi-Project] for details on multi-project
349+
settings.</li>
350+
<li><code>projects [add|remove &lt;URI&gt;]</code> List all available projects if no
351+
arguments provided or adds/removes the build at the provided URI.<!-- (See [multi-project builds][Multi-Project] for details on multi-project
358352
builds.) -->
359353
</li>
360-
<li>
361-
<p><code>project &lt;project-id&gt;</code> Change the current project to the project
362-
with ID <code>&lt;project-id&gt;</code>. Further operations will be done in the
363-
context of the given project.</p>
364-
<!-- (See [multi-project builds][Multi-Project] for
365-
details on multiple project builds.) -->
366-
</li>
354+
</ul>
355+
<!--
356+
- `project <project-id>` Change the current project to the project
357+
with ID `<project-id>`. Further operations will be done in the
358+
context of the given project.
359+
(See [multi-project builds][Multi-Project] for
360+
details on multiple project builds.)
361+
-->
362+
<ul>
367363
<li>
368364
<p><a href="./watch.html">Watch command</a> <code>~ &lt;command&gt;</code> Executes the project specified action or method
369365
whenever source files change.</p>

2.x/docs/en/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)