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

fix: correct link to toolchain documentation #1978

Merged
merged 1 commit into from
Dec 20, 2021
Merged
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
24 changes: 12 additions & 12 deletions container/image.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -600,7 +600,7 @@ _attrs = dicts.add(_layer.attrs, {
Acceptable formats: Integer or floating point seconds since Unix Epoch, RFC 3339 date/time.

This field supports stamp variables.

If not set, defaults to {BUILD_TIMESTAMP} when stamp = True, otherwise 0""",
),
"docker_run_flags": attr.string(
Expand All @@ -612,14 +612,14 @@ _attrs = dicts.add(_layer.attrs, {
doc = """List of entrypoints to add in the image.

See https://docs.docker.com/engine/reference/builder/#entrypoint

Set `entrypoint` to `None`, `[]` or `""` will set the `Entrypoint` of the image
to be `null`.

The behavior between using `""` and `[]` may differ.
Please see [#1448](https://github.com/bazelbuild/rules_docker/issues/1448)
for more details.

This field supports stamp variables.""",
),
"experimental_tarball_format": attr.string(
Expand All @@ -642,12 +642,12 @@ _attrs = dicts.add(_layer.attrs, {
),
"labels": attr.string_dict(
doc = """Dictionary from custom metadata names to their values.

See https://docs.docker.com/engine/reference/builder/#label

You can also put a file name prefixed by '@' as a value.
Then the value is replaced with the contents of the file.

Example:

labels = {
Expand All @@ -674,7 +674,7 @@ _attrs = dicts.add(_layer.attrs, {
),
"layers": attr.label_list(
doc = """List of `container_layer` targets.

The data from each `container_layer` will be part of container image,
and the environment variable will be available in the image as well.""",
providers = [LayerInfo],
Expand Down Expand Up @@ -706,7 +706,7 @@ _attrs = dicts.add(_layer.attrs, {
# Starlark doesn't support int_list...
"ports": attr.string_list(
doc = """List of ports to expose.

See https://docs.docker.com/engine/reference/builder/#expose""",
),
"repository": attr.string(
Expand All @@ -716,7 +716,7 @@ _attrs = dicts.add(_layer.attrs, {
Images generated by `container_image` are tagged by default to
`bazel/package_name:target` for a `container_image` target at
`//package/name:target`.

Setting this attribute to `gcr.io/dummy` would set the default tag to
`gcr.io/dummy/package_name:target`.""",
),
Expand All @@ -733,14 +733,14 @@ _attrs = dicts.add(_layer.attrs, {
),
"volumes": attr.string_list(
doc = """List of volumes to mount.

See https://docs.docker.com/engine/reference/builder/#volumes""",
),
"workdir": attr.string(
doc = """Initial working directory when running the Docker image.

See https://docs.docker.com/engine/reference/builder/#workdir

Because building the image never happens inside a Docker container,
this working directory does not affect the other actions (e.g., adding files).

Expand Down Expand Up @@ -946,7 +946,7 @@ def container_image(**kwargs):
layers inside the Docker registry.

This rule references the `@io_bazel_rules_docker//toolchains/docker:toolchain_type`.
See [How to use the Docker Toolchain](toolchains/docker/readme.md#how-to-use-the-docker-toolchain) for details.
See [How to use the Docker Toolchain](/toolchains/docker/readme.md#how-to-use-the-docker-toolchain) for details.

Args:
**kwargs: Attributes are described by `container_image_` above.
Expand Down
2 changes: 1 addition & 1 deletion docs/container.md
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,7 @@ The implicit output targets are:
layers inside the Docker registry.

This rule references the `@io_bazel_rules_docker//toolchains/docker:toolchain_type`.
See [How to use the Docker Toolchain](toolchains/docker/readme.md#how-to-use-the-docker-toolchain) for details.
See [How to use the Docker Toolchain](/toolchains/docker/readme.md#how-to-use-the-docker-toolchain) for details.


**PARAMETERS**
Expand Down