regenerate the documentation and remove deprecated startup option removals
diff --git a/.bazelrc b/.bazelrc index 6c4d67d..e75318b 100644 --- a/.bazelrc +++ b/.bazelrc
@@ -2,7 +2,3 @@ build --test_output=errors build --verbose_failures -# Cannot use this until skydoc removes filetypes as well. -# build --incompatible_disallow_filetype -build --incompatible_remove_native_git_repository -build --incompatible_remove_native_http_archive
diff --git a/README.md b/README.md index 23e7b11..9bfe029 100644 --- a/README.md +++ b/README.md
@@ -29,7 +29,10 @@ * Persistent worker support. * Mixed-Mode compilation (compile Java and Kotlin in one pass). -# Usage +# Quick Guide +Consult the generated [documentation](https://bazelbuild.github.io/rules_kotlin). This section just contains a quick +overview. + ## WORKSPACE In the project's `WORKSPACE`, declare the external repository and initialize the toolchains, like
diff --git a/docs/index.html b/docs/index.html index 6bf282a..5719cbd 100644 --- a/docs/index.html +++ b/docs/index.html
@@ -86,7 +86,7 @@ </ul> </nav> -<h2><a href="https://bazelbuild.github.io/rules_kotlin/kotlin/kotlin.html">Kotlin Rules</a></h2> +<h2><a href="https://bazelbuild.github.io/rules_kotlin/kotlin/kotlin.html" id="kotlin">Kotlin Rules</a></h2> <h3>Rules</h3> <table class="overview-table"> @@ -173,7 +173,7 @@ </tr> </tbody> </table> -<h2><a href="https://bazelbuild.github.io/rules_kotlin/kotlin/toolchains.html">toolchains Rules</a></h2> +<h2><a href="https://bazelbuild.github.io/rules_kotlin/kotlin/toolchains.html" id="toolchains">toolchains Rules</a></h2> <h3>Rules</h3> <table class="overview-table">
diff --git a/docs/kotlin/kotlin.html b/docs/kotlin/kotlin.html index 640b263..976f158 100644 --- a/docs/kotlin/kotlin.html +++ b/docs/kotlin/kotlin.html
@@ -304,14 +304,14 @@ <h2 id="kt_jvm_import">kt_jvm_import</h2> - <pre>kt_jvm_import(<a href="#kt_jvm_import.name">name</a>, <a href="#kt_jvm_import.jars">jars</a>, <a href="#kt_jvm_import.srcjar">srcjar</a>)</pre> + <pre>kt_jvm_import(<a href="#kt_jvm_import.name">name</a>, <a href="#kt_jvm_import.jars">jars</a>, <a href="#kt_jvm_import.runtime_deps">runtime_deps</a>, <a href="#kt_jvm_import.srcjar">srcjar</a>)</pre> <p>(experimental) Import Kotlin jars.</p> <p><strong>Status:</strong> This rule is not a counterpart to <code>java_import</code>. The current purpose for this rule is to import a kotlin jar without creating ijars. It will eventually <a href="https://github.com/bazelbuild/rules_kotlin/issues/4">be replaced</a> with <code>java_import</code>. If there is a need for expanding this rule we can instead create a utility macro that delegates to this.</p> <h2>examples</h2> -<pre><code class="lang-bzl"># Import a collection of class jars and source jars from filegroup labels. +<pre><code class="lang-bzl"># Old style usage -- reference file groups, do not used this. kt_jvm_import( name = "kodein", jars = [ @@ -320,6 +320,15 @@ ] ) +# This style will pull in the transitive runtime dependencies of the targets as well. +kt_jvm_import( + name = "kodein", + jars = [ + "@com_github_salomonbrys_kodein_kodein//jar", + "@com_github_salomonbrys_kodein_kodein_core//jar" + ] +) + # Import a single kotlin jar. kt_jvm_import( name = "kotlin-runtime", @@ -353,6 +362,13 @@ with a single class jar and a single source jar. a source jar is recognized by the suffix <code>-sources.jar</code>.</p> </td> </tr> + <tr id="kt_jvm_import.runtime_deps"> + <td><code>runtime_deps</code></td> + <td> + <p><code>List of <a href="https://bazel.build/docs/build-ref.html#labels">labels</a>; Optional; Default is []</code></p> + <p>Additional runtime deps.</p> + </td> + </tr> <tr id="kt_jvm_import.srcjar"> <td><code>srcjar</code></td> <td> @@ -468,7 +484,7 @@ <h2 id="kt_jvm_test">kt_jvm_test</h2> - <pre>kt_jvm_test(<a href="#kt_jvm_test.name">name</a>, <a href="#kt_jvm_test.deps">deps</a>, <a href="#kt_jvm_test.data">data</a>, <a href="#kt_jvm_test.resources">resources</a>, <a href="#kt_jvm_test.srcs">srcs</a>, <a href="#kt_jvm_test.jvm_flags">jvm_flags</a>, <a href="#kt_jvm_test.module_name">module_name</a>, <a href="#kt_jvm_test.plugins">plugins</a>, <a href="#kt_jvm_test.resource_jars">resource_jars</a>, <a href="#kt_jvm_test.resource_strip_prefix">resource_strip_prefix</a>, <a href="#kt_jvm_test.runtime_deps">runtime_deps</a>, <a href="#kt_jvm_test.test_class">test_class</a>)</pre> + <pre>kt_jvm_test(<a href="#kt_jvm_test.name">name</a>, <a href="#kt_jvm_test.deps">deps</a>, <a href="#kt_jvm_test.data">data</a>, <a href="#kt_jvm_test.resources">resources</a>, <a href="#kt_jvm_test.srcs">srcs</a>, <a href="#kt_jvm_test.friends">friends</a>, <a href="#kt_jvm_test.jvm_flags">jvm_flags</a>, <a href="#kt_jvm_test.main_class">main_class</a>, <a href="#kt_jvm_test.module_name">module_name</a>, <a href="#kt_jvm_test.plugins">plugins</a>, <a href="#kt_jvm_test.resource_jars">resource_jars</a>, <a href="#kt_jvm_test.resource_strip_prefix">resource_strip_prefix</a>, <a href="#kt_jvm_test.runtime_deps">runtime_deps</a>, <a href="#kt_jvm_test.test_class">test_class</a>)</pre> <p>Setup a simple kotlin_test.</p> <p><strong>Notes:</strong></p> @@ -521,6 +537,14 @@ classes may depend on Java classes in the same compilation unit.</p> </td> </tr> + <tr id="kt_jvm_test.friends"> + <td><code>friends</code></td> + <td> + <p><code>List of <a href="https://bazel.build/docs/build-ref.html#labels">labels</a>; Optional; Default is []</code></p> + <p>A single Kotlin dep which allows the test code access to internal members. Currently uses the output jar of +the module -- i.e., exported deps won't be included.</p> + </td> + </tr> <tr id="kt_jvm_test.jvm_flags"> <td><code>jvm_flags</code></td> <td> @@ -528,6 +552,13 @@ <p>A list of flags to embed in the wrapper script generated for running this binary. Note: does not yet support make variable substitution.</p> </td> </tr> + <tr id="kt_jvm_test.main_class"> + <td><code>main_class</code></td> + <td> + <p><code>String; Optional; Default is 'com.google.testing.junit.runner.BazelTestRunner'</code></p> + + </td> + </tr> <tr id="kt_jvm_test.module_name"> <td><code>module_name</code></td> <td>
diff --git a/docs/main.css b/docs/main.css index f506e12..89f66fe 100755 --- a/docs/main.css +++ b/docs/main.css
@@ -1,3 +1 @@ -body{background-color:#fafafa}pre,code{font-family:'Liberation Mono', Consolas, Monaco, 'Andale Mono', monospace}pre{background-color:#eee;padding:20px;overflow-x:auto;word-wrap:normal}pre code{overflow-wrap:normal;white-space:pre}code{display:inline-block;font-size:90%;white-space:pre-wrap}.mdl-layout__drawer{background-color:#fff}.mdl-layout__drawer .mdl-layout-title{border-bottom:1px solid #e0e0e0;padding-left:24px}.drawer-nav ul{list-style:none;padding-left:0}.drawer-nav ul li{display:block;padding:0}.drawer-nav ul li ul li a{padding-left:44px;font-weight:400}.drawer-nav ul li a{display:block;flex-shrink:0;padding:15px 0 15px 22px;margin:0;font-weight:600;color:#757575;line-height:1em;text-decoration:none;cursor:pointer}.drawer-nav ul li a:active,.drawer-nav ul li a:hover{background-color:#f0f0f0}.drawer-nav ul li.active a{color:#4caf50;font-weight:500}h1.page-title{font-size:34px;font-weight:400;line-height:40px;margin-bottom:30px;color:#4caf50}p.lead{font-size:20px;line-height:32px}table{border-collapse:collapse;border-spacing:0;background-color:#fff;table-layout:auto}table thead th{background-color:#fafafa;border:1px solid #eee;color:#757575;padding:12px 12px 12px 24px;vertical-align:top}table tbody td{border:1px solid #eee;padding:12px 12px 12px 24px;vertical-align:top}table.params-table{width:100%}table.params-table col.col-param{width:25%}table.params-table col.col-description{width:75%}table.overview-table{width:100%}table.overview-table col.col-name{width:25%}table.overview-table col.col-description{width:75%}table.overview-table td p{margin:0}hr{margin-top:80px;margin-bottom:80px}nav.toc{border-left:5px solid #4caf50;padding-left:20px;margin-bottom:48px}nav.toc h1,nav.toc h2{font-size:15px;line-height:16px;padding-bottom:12px;margin-bottom:0;font-weight:400;color:#757575}nav.toc ul{list-style:none;margin-top:0;padding-left:0}nav.toc ul li{font-size:20px;line-height:40px}nav.toc ul li a{color:#4caf50}.page-content{margin-left:auto;margin-right:auto;padding-top:60px;padding-bottom:60px;width:760px}.page-content a{text-decoration:none}.page-content h1{font-size:34px;font-weight:400;line-height:40px;margin-bottom:30px;color:#4caf50}.page-content h2{font-size:24px;font-weight:400;line-height:32px;margin-bottom:30px;color:#4caf50}.page-content h3{font-size:20px;font-weight:400;line-height:32px;margin-bottom:30px;color:#4caf50}@media (max-width: 768px){.page-content{width:360px}}@media (min-width: 768px){.page-content{width:760px}}@media (min-width: 1476px){.page-content{width:1160px}}.mdl-mini-footer{padding-left:40px} - -/*# sourceMappingURL=main.css.map */ \ No newline at end of file +body{background-color:#fafafa}pre,code{font-family:"Liberation Mono",Consolas,Monaco,"Andale Mono",monospace}pre{background-color:#eee;padding:20px;overflow-x:auto;word-wrap:normal}pre code{overflow-wrap:normal;white-space:pre}code{display:inline-block;font-size:90%;white-space:pre-wrap}.mdl-layout__drawer{background-color:#fff}.mdl-layout__drawer .mdl-layout-title{border-bottom:1px solid #e0e0e0;padding-left:24px}.drawer-nav ul{list-style:none;padding-left:0}.drawer-nav ul li{display:block;padding:0}.drawer-nav ul li ul li a{padding-left:44px;font-weight:400}.drawer-nav ul li a{display:block;flex-shrink:0;padding:15px 0 15px 22px;margin:0;font-weight:600;color:#757575;line-height:1em;text-decoration:none;cursor:pointer}.drawer-nav ul li a:active,.drawer-nav ul li a:hover{background-color:#f0f0f0}.drawer-nav ul li.active a{color:#4caf50;font-weight:500}h1.page-title{font-size:34px;font-weight:400;line-height:40px;margin-bottom:30px;color:#4caf50}p.lead{font-size:20px;line-height:32px}table{border-collapse:collapse;border-spacing:0;background-color:#fff;table-layout:auto}table thead th{background-color:#fafafa;border:1px solid #eee;color:#757575;padding:12px 12px 12px 24px;vertical-align:top}table tbody td{border:1px solid #eee;padding:12px 12px 12px 24px;vertical-align:top}table.params-table{width:100%}table.params-table col.col-param{width:25%}table.params-table col.col-description{width:75%}table.overview-table{width:100%}table.overview-table col.col-name{width:25%}table.overview-table col.col-description{width:75%}table.overview-table td p{margin:0}hr{margin-top:40px;margin-bottom:40px}nav.toc{border-left:5px solid #4caf50;padding-left:20px;margin-bottom:48px}nav.toc h1,nav.toc h2{font-size:15px;line-height:16px;padding-bottom:12px;margin-bottom:0;font-weight:400;color:#757575}nav.toc ul{list-style:none;margin-top:0;padding-left:0}nav.toc ul li{font-size:20px;line-height:40px}nav.toc ul li a{color:#4caf50}.page-content{margin-left:auto;margin-right:auto;padding-top:60px;padding-bottom:60px;width:760px}.page-content a{text-decoration:none}.page-content h1{font-size:34px;font-weight:400;line-height:40px;margin-bottom:30px;color:#4caf50}.page-content h2{font-size:24px;font-weight:400;line-height:32px;margin-bottom:30px;color:#4caf50}.page-content h3{font-size:20px;font-weight:400;line-height:32px;margin-bottom:30px;color:#4caf50}@media(max-width: 768px){.page-content{width:360px}}@media(min-width: 768px){.page-content{width:760px}}@media(min-width: 1476px){.page-content{width:1160px}}.mdl-mini-footer{padding-left:40px}/*# sourceMappingURL=main.css.map */