Skip to content

Commit

Permalink
Deploy website
Browse files Browse the repository at this point in the history
Deploy website version based on e2f4fb5
  • Loading branch information
Docusaurus bot committed Jan 19, 2024
1 parent feb8206 commit 8c41706
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 13,155 deletions.
2 changes: 1 addition & 1 deletion docs/plugins/sbt-plugin.html
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
of tips that users of this plugin must take into account to get reliable data.</p>
<h3><a class="anchor" aria-hidden="true" id="installation"></a><a href="#installation" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Installation</h3>
<p>Add the plugin into <code>project/plugins.sbt</code>:</p>
<pre><code class="hljs css language-scala">addSbtPlugin(<span class="hljs-string">"ch.epfl.scala"</span> % <span class="hljs-string">"sbt-scalac-profiling"</span> % <span class="hljs-string">"1.1.0-RC1"</span>)
<pre><code class="hljs css language-scala">addSbtPlugin(<span class="hljs-string">"ch.epfl.scala"</span> % <span class="hljs-string">"sbt-scalac-profiling"</span> % <span class="hljs-string">"1.1.0-RC2"</span>)
</code></pre>
<h3><a class="anchor" aria-hidden="true" id="usage"></a><a href="#usage" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Usage</h3>
<p>Run the <code>profilingWarmupCompiler</code> task in SBT in your CI / local machine
Expand Down
10 changes: 5 additions & 5 deletions docs/user-guide/installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,28 +60,28 @@
<tr><th style="text-align:left">Scala series</th><th style="text-align:left">Supported versions</th><th style="text-align:left"><code>scalac-profiling</code></th></tr>
</thead>
<tbody>
<tr><td style="text-align:left">2.12.x</td><td style="text-align:left">2.12.13, 2.12.14, 2.12.15, 2.12.16, 2.12.17, 2.12.18</td><td style="text-align:left"><code>1.1.0-RC1</code></td></tr>
<tr><td style="text-align:left">2.13.x</td><td style="text-align:left">2.13.5, 2.13.6, 2.13.7, 2.13.8, 2.13.9, 2.13.10, 2.13.11, 2.13.12</td><td style="text-align:left"><code>1.1.0-RC1</code></td></tr>
<tr><td style="text-align:left">2.12.x</td><td style="text-align:left">2.12.13, 2.12.14, 2.12.15, 2.12.16, 2.12.17, 2.12.18</td><td style="text-align:left"><code>1.1.0-RC2</code></td></tr>
<tr><td style="text-align:left">2.13.x</td><td style="text-align:left">2.13.5, 2.13.6, 2.13.7, 2.13.8, 2.13.9, 2.13.10, 2.13.11, 2.13.12</td><td style="text-align:left"><code>1.1.0-RC2</code></td></tr>
</tbody>
</table>
<h3><a class="anchor" aria-hidden="true" id="add-the-dependency"></a><a href="#add-the-dependency" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Add the dependency</h3>
<p>Add the scalac compiler plugin into your build:</p>
<pre><code class="hljs css language-scala">addCompilerPlugin(<span class="hljs-string">"ch.epfl.scala"</span> %% <span class="hljs-string">"scalac-profiling"</span> % <span class="hljs-string">"1.1.0-RC1"</span> cross <span class="hljs-type">CrossVersion</span>.full)
<pre><code class="hljs css language-scala">addCompilerPlugin(<span class="hljs-string">"ch.epfl.scala"</span> %% <span class="hljs-string">"scalac-profiling"</span> % <span class="hljs-string">"1.1.0-RC2"</span> cross <span class="hljs-type">CrossVersion</span>.full)
</code></pre>
<p>Also, it's required to enable compiler statistics — for Scala 2.13 the needed compiler
flag is <code>-Vstatistics</code>, and for Scala 2.12 is <code>-Ystatistics</code>.</p>
<p>For example, for the SBT build tool, add the following settings to <code>build.sbt</code>:</p>
<pre><code class="hljs css language-diff"><span class="hljs-addition">+ inThisBuild(</span>
<span class="hljs-addition">+ List(</span>
<span class="hljs-addition">+ addCompilerPlugin("ch.epfl.scala" %% "scalac-profiling" % "1.1.0-RC1" cross CrossVersion.full),</span>
<span class="hljs-addition">+ addCompilerPlugin("ch.epfl.scala" %% "scalac-profiling" % "1.1.0-RC2" cross CrossVersion.full),</span>
<span class="hljs-addition">+ ThisBuild / scalacOptions += "-Vstatistics",</span>
<span class="hljs-addition">+ )</span>
<span class="hljs-addition">+ )</span>
</code></pre>
<p>You can also use project-scoped settings if you want to profile a particular project:</p>
<pre><code class="hljs css language-diff">lazy val myproject = project
.settings(
<span class="hljs-addition">+ addCompilerPlugin("ch.epfl.scala" %% "scalac-profiling" % "1.1.0-RC1" cross CrossVersion.full),</span>
<span class="hljs-addition">+ addCompilerPlugin("ch.epfl.scala" %% "scalac-profiling" % "1.1.0-RC2" cross CrossVersion.full),</span>
<span class="hljs-addition">+ ThisBuild / scalacOptions += "-Vstatistics",</span>
)
</code></pre>
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/motivation.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
});
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/scalacenter/scalac-profiling/edit/main/docs/user-guide/motivation.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">What is scalac-profiling?</h1></header><article><div><span><p><code>scalac-profiling</code> is a compilation profiling tool for Scala 2 projects
which aims to help you better understand what is slowing down compilation in your project.
As of the <code>1.1.0-RC1</code> version, it's built for Scala 2.12 and 2.13.</p>
As of the <code>1.1.0-RC2</code> version, it's built for Scala 2.12 and 2.13.</p>
<h3><a class="anchor" aria-hidden="true" id="when-to-use-scalac-profiling"></a><a href="#when-to-use-scalac-profiling" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>When to use scalac-profiling?</h3>
<p>Using implicits and macros can significantly increase compilation time,
based on their usage and your codebase organization. Suppose your project
Expand Down
Loading

0 comments on commit 8c41706

Please sign in to comment.