Skip to content
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.

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

Update java_export.bzl docs #1158

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ maven_install(<a href="#maven_install-name">name</a>, <a href="#maven_install-re
<a href="#maven_install-strict_visibility_value">strict_visibility_value</a>, <a href="#maven_install-resolve_timeout">resolve_timeout</a>, <a href="#maven_install-additional_netrc_lines">additional_netrc_lines</a>,
<a href="#maven_install-use_credentials_from_home_netrc_file">use_credentials_from_home_netrc_file</a>, <a href="#maven_install-fail_if_repin_required">fail_if_repin_required</a>,
<a href="#maven_install-use_starlark_android_rules">use_starlark_android_rules</a>, <a href="#maven_install-aar_import_bzl_label">aar_import_bzl_label</a>, <a href="#maven_install-duplicate_version_warning">duplicate_version_warning</a>,
<a href="#maven_install-repin_instructions">repin_instructions</a>, <a href="#maven_install-ignore_empty_files">ignore_empty_files</a>)
<a href="#maven_install-repin_instructions">repin_instructions</a>, <a href="#maven_install-ignore_empty_files">ignore_empty_files</a>, <a href="#maven_install-additional_coursier_options">additional_coursier_options</a>)
</pre>

Resolves and fetches artifacts transitively from Maven repositories.
Expand Down Expand Up @@ -218,6 +218,7 @@ and fetch Maven artifacts transitively.
| <a id="maven_install-duplicate_version_warning"></a>duplicate_version_warning | What to do if an artifact is specified multiple times. If "error" then fail the build, if "warn" then print a message and continue, if "none" then do nothing. The default is "warn". | <code>"warn"</code> |
| <a id="maven_install-repin_instructions"></a>repin_instructions | Instructions to re-pin dependencies in your repository. Will be shown when re-pinning is required. | <code>None</code> |
| <a id="maven_install-ignore_empty_files"></a>ignore_empty_files | Treat jars that are empty as if they were not found. | <code>False</code> |
| <a id="maven_install-additional_coursier_options"></a>additional_coursier_options | Additional options that will be passed to coursier. | <code>[]</code> |


# Maven specification functions
Expand Down
8 changes: 4 additions & 4 deletions private/rules/java_export.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ def java_export(
with an extra dependency.
classifier_artifacts: A dict of classifier -> artifact of additional artifacts to publish to Maven.
doc_deps: Other `javadoc` targets that are referenced by the generated `javadoc` target
(if not using `tags = ["no-javadoc"]`)
(if not using `tags = ["no-javadocs"]`)
doc_url: The URL at which the generated `javadoc` will be hosted (if not using
`tags = ["no-javadoc"]`).
`tags = ["no-javadocs"]`).
visibility: The visibility of the target
kwargs: These are passed to [`java_library`](https://bazel.build/reference/be/java#java_library),
and so may contain any valid parameter for that rule.
Expand Down Expand Up @@ -186,9 +186,9 @@ def maven_export(
that workspace should be replaced by, or `None` if the exclusion shouldn't be replaced
with an extra dependency.
doc_deps: Other `javadoc` targets that are referenced by the generated `javadoc` target
(if not using `tags = ["no-javadoc"]`)
(if not using `tags = ["no-javadocs"]`)
doc_url: The URL at which the generated `javadoc` will be hosted (if not using
`tags = ["no-javadoc"]`).
`tags = ["no-javadocs"]`).
visibility: The visibility of the target
kwargs: These are passed to [`java_library`](https://bazel.build/reference/be/java#java_library),
and so may contain any valid parameter for that rule.
Expand Down