Skip to content

Update Zinc information in documentation site #408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 21, 2020
Merged

Update Zinc information in documentation site #408

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5474007
Remove Documention on using Zinc server
brandonbyskov Jun 21, 2020
9e939ab
Update documentation references to Zinc homepage
brandonbyskov Jun 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 1 addition & 44 deletions src/site/xdoc/example_incremental.xml.vm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<p>
Incremental compilation is supported using
<a href="https://github.com/typesafehub/zinc">Zinc</a>,
<a href="https://github.com/sbt/zinc">Zinc</a>,
a stand-alone version of sbt's incremental compiler.
</p>

Expand Down Expand Up @@ -44,49 +44,6 @@
via the "MAVEN_OPTS" environment variable.
</section>

<section name="Zinc Server">
<p>
Zinc supports much faster compilation by running as a server, keeping the
JVM and classloaders warm, and the Scala Maven Plugin can be used as a
Zinc client, connecting to a currently running Zinc server. This can
improve compilation speeds by a factor of two, or even more, giving the
same benefits as using sbt's interactive shell.
</p>
<p>
To use Zinc as a server, first install a local version of Zinc via the
<a href="https://github.com/typesafehub/zinc">Zinc homepage</a>.
You can start the Zinc server with:
</p>
<source>zinc -start</source>
<p>
Configure your project to use the Zinc server with the "useZincServer"
configuration option:
</p>
<source>
<![CDATA[
<project>
...
<plugin>
<groupId>${project.groupId}</groupId>
<artifactId>${project.artifactId}</artifactId>
<version>${project.version}</version>
<configuration>
<recompileMode>incremental</recompileMode>
<useZincServer>true</useZincServer>
</configuration>
</plugin>
...
</project>
]]>
</source>
<p>
If there is no Zinc server currently running then the plugin falls back
to regular incremental compilation. To configure which port to connect
to, if Zinc is running on a non-default port, use the "zincPort"
configuration option.
</p>
</section>

<section name="Mixed Scala and Java Sources">
<p>
The incremental compiler will compile both Scala and Java sources, rather
Expand Down
2 changes: 1 addition & 1 deletion src/site/xdoc/faq.xml.vm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<section name="Incremental Compilation (w/ Zinc)">
<dl>
<dt>Why does the maven plugin compile both Java and Scala sources</dt>
<dd>The <a href="https://github.com/typesafehub/zinc">Zinc incremental compilation</a> library needs access to both Java and Scala sources to accurately determine recompilation.
<dd>The <a href="https://github.com/sbt/zinc">Zinc incremental compilation</a> library needs access to both Java and Scala sources to accurately determine recompilation.
</dd>
</dl>
<dl>
Expand Down