From d7e9dbb31fb41f2d4c5073cf2800e6f99e83d545 Mon Sep 17 00:00:00 2001 From: Alexandre Rostovtsev Date: Thu, 1 Sep 2022 08:19:43 -0400 Subject: [PATCH] Add missing docs and doc links; update bazel.build links (#387) --- README.md | 6 ++++++ docs/BUILD | 5 +++++ docs/build_test_doc.md | 2 +- docs/common_settings_doc.md | 2 +- docs/diff_test_doc.md | 2 +- docs/native_binary_doc.md | 4 ++-- docs/run_binary_doc.md | 4 ++-- docs/select_file_doc.md | 28 ++++++++++++++++++++++++++++ rules/build_test.bzl | 2 +- rules/common_settings.bzl | 2 +- rules/diff_test.bzl | 2 +- rules/native_binary.bzl | 2 +- rules/run_binary.bzl | 4 ++-- rules/select_file.bzl | 5 ++--- 14 files changed, 54 insertions(+), 16 deletions(-) create mode 100755 docs/select_file_doc.md diff --git a/README.md b/README.md index 52733eb..ce70bab 100644 --- a/README.md +++ b/README.md @@ -60,8 +60,14 @@ s = shell.quote(p) * [analysis_test](docs/analysis_test_doc.md) * [build_test](docs/build_test_doc.md) +* [common_settings](docs/common_settings_doc.md) +* [copy_directory](docs/copy_directory_doc.md) * [copy_file](docs/copy_file_doc.md) +* [diff_test](docs/diff_test_doc.md) * [expand_template](docs/expand_template_doc.md) +* [native_binary and native_test](docs/native_binary_doc.md) +* [run_binary](docs/run_binary_doc.md) +* [select_file](docs/select_file_doc.md) * [write_file](docs/write_file_doc.md) ## Writing a new module diff --git a/docs/BUILD b/docs/BUILD index bac20b1..c6f1b61 100644 --- a/docs/BUILD +++ b/docs/BUILD @@ -77,6 +77,11 @@ stardoc_with_diff_test( out_label = "//docs:selects_doc.md", ) +stardoc_with_diff_test( + bzl_library_target = "//rules:select_file", + out_label = "//docs:select_file_doc.md", +) + stardoc_with_diff_test( bzl_library_target = "//lib:shell", out_label = "//docs:shell_doc.md", diff --git a/docs/build_test_doc.md b/docs/build_test_doc.md index eba4904..d547406 100755 --- a/docs/build_test_doc.md +++ b/docs/build_test_doc.md @@ -36,6 +36,6 @@ Typical usage: | :------------- | :------------- | :------------- | | name | The name of the test rule. | none | | targets | A list of targets to ensure build. | none | -| kwargs | The <a href="https://docs.bazel.build/versions/main/be/common-definitions.html#common-attributes-tests">common attributes for tests</a>. | none | +| kwargs | The <a href="https://bazel.build/reference/be/common-definitions#common-attributes-tests">common attributes for tests</a>. | none | diff --git a/docs/common_settings_doc.md b/docs/common_settings_doc.md index 5ab7cd2..4dda47c 100755 --- a/docs/common_settings_doc.md +++ b/docs/common_settings_doc.md @@ -6,7 +6,7 @@ These rules return a BuildSettingInfo with the value of the build setting. For label-typed settings, use the native label_flag and label_setting rules. More documentation on how to use build settings at -https://docs.bazel.build/versions/main/skylark/config.html#user-defined-build-settings +https://bazel.build/extending/config#user-defined-build-settings diff --git a/docs/diff_test_doc.md b/docs/diff_test_doc.md index 41a030b..4fc2416 100755 --- a/docs/diff_test_doc.md +++ b/docs/diff_test_doc.md @@ -28,6 +28,6 @@ The test succeeds if the files' contents match. | file1 | Label of the file to compare to <code>file2</code>. | none | | file2 | Label of the file to compare to <code>file1</code>. | none | | failure_message | Additional message to log if the files' contents do not match. | None | -| kwargs | The <a href="https://docs.bazel.build/versions/main/be/common-definitions.html#common-attributes-tests">common attributes for tests</a>. | none | +| kwargs | The <a href="https://bazel.build/reference/be/common-definitions#common-attributes-tests">common attributes for tests</a>. | none | diff --git a/docs/native_binary_doc.md b/docs/native_binary_doc.md index 7a54315..b512b25 100755 --- a/docs/native_binary_doc.md +++ b/docs/native_binary_doc.md @@ -29,7 +29,7 @@ in genrule.tools for example. You can also augment the binary with runfiles. | Name | Description | Type | Mandatory | Default | | :------------- | :------------- | :------------- | :------------- | :------------- | | name | A unique name for this target. | Name | required | | -| data | data dependencies. See https://docs.bazel.build/versions/main/be/common-definitions.html#typical.data | List of labels | optional | [] | +| data | data dependencies. See https://bazel.build/reference/be/common-definitions#typical.data | List of labels | optional | [] | | out | An output name for the copy of the binary | String | required | | | src | path of the pre-built executable | Label | required | | @@ -55,7 +55,7 @@ the binary with runfiles. | Name | Description | Type | Mandatory | Default | | :------------- | :------------- | :------------- | :------------- | :------------- | | name | A unique name for this target. | Name | required | | -| data | data dependencies. See https://docs.bazel.build/versions/main/be/common-definitions.html#typical.data | List of labels | optional | [] | +| data | data dependencies. See https://bazel.build/reference/be/common-definitions#typical.data | List of labels | optional | [] | | out | An output name for the copy of the binary | String | required | | | src | path of the pre-built executable | Label | required | | diff --git a/docs/run_binary_doc.md b/docs/run_binary_doc.md index 7d4f9fb..8e4491d 100755 --- a/docs/run_binary_doc.md +++ b/docs/run_binary_doc.md @@ -22,8 +22,8 @@ Runs a binary as a build action.

This rule does not require Bash (unlik | Name | Description | Type | Mandatory | Default | | :------------- | :------------- | :------------- | :------------- | :------------- | | name | A unique name for this target. | Name | required | | -| args | Command line arguments of the binary.<br/><br/>Subject to<code><a href="https://docs.bazel.build/versions/main/be/make-variables.html#location">$(location)</a></code> expansion. | List of strings | optional | [] | -| env | Environment variables of the action.<br/><br/>Subject to <code><a href="https://docs.bazel.build/versions/main/be/make-variables.html#location">$(location)</a></code> expansion. | Dictionary: String -> String | optional | {} | +| args | Command line arguments of the binary.<br/><br/>Subject to<code><a href="https://bazel.build/reference/be/make-variables#predefined_label_variables">$(location)</a></code> expansion. | List of strings | optional | [] | +| env | Environment variables of the action.<br/><br/>Subject to <code><a href="https://bazel.build/reference/be/make-variables#predefined_label_variables">$(location)</a></code> expansion. | Dictionary: String -> String | optional | {} | | outs | Output files generated by the action.<br/><br/>These labels are available for <code>$(location)</code> expansion in <code>args</code> and <code>env</code>. | List of labels | required | | | srcs | Additional inputs of the action.<br/><br/>These labels are available for <code>$(location)</code> expansion in <code>args</code> and <code>env</code>. | List of labels | optional | [] | | tool | The tool to run in the action.<br/><br/>Must be the label of a *_binary rule, of a rule that generates an executable file, or of a file that can be executed as a subprocess (e.g. an .exe or .bat file on Windows or a binary with executable permission on Linux). This label is available for <code>$(location)</code> expansion in <code>args</code> and <code>env</code>. | Label | required | | diff --git a/docs/select_file_doc.md b/docs/select_file_doc.md new file mode 100755 index 0000000..667f519 --- /dev/null +++ b/docs/select_file_doc.md @@ -0,0 +1,28 @@ + + + +select_file() build rule implementation. + +Selects a single file from the outputs of a target by given relative path. + + + + +## select_file + +
+select_file(name, srcs, subpath)
+
+ +Selects a single file from the outputs of a target by given relative path + +**ATTRIBUTES** + + +| Name | Description | Type | Mandatory | Default | +| :------------- | :------------- | :------------- | :------------- | :------------- | +| name | A unique name for this target. | Name | required | | +| srcs | The target producing the file among other outputs | Label | required | | +| subpath | Relative path to the file | String | required | | + + diff --git a/rules/build_test.bzl b/rules/build_test.bzl index 9ec8ab1..682901e 100644 --- a/rules/build_test.bzl +++ b/rules/build_test.bzl @@ -63,7 +63,7 @@ def build_test(name, targets, **kwargs): Args: name: The name of the test rule. targets: A list of targets to ensure build. - **kwargs: The common attributes for tests. + **kwargs: The common attributes for tests. """ if len(targets) == 0: fail("targets must be non-empty", "targets") diff --git a/rules/common_settings.bzl b/rules/common_settings.bzl index 7f56a7f..d5b8408 100644 --- a/rules/common_settings.bzl +++ b/rules/common_settings.bzl @@ -18,7 +18,7 @@ These rules return a BuildSettingInfo with the value of the build setting. For label-typed settings, use the native label_flag and label_setting rules. More documentation on how to use build settings at -https://docs.bazel.build/versions/main/skylark/config.html#user-defined-build-settings +https://bazel.build/extending/config#user-defined-build-settings """ BuildSettingInfo = provider( diff --git a/rules/diff_test.bzl b/rules/diff_test.bzl index 25213d6..ee2f589 100644 --- a/rules/diff_test.bzl +++ b/rules/diff_test.bzl @@ -164,7 +164,7 @@ def diff_test(name, file1, file2, failure_message = None, **kwargs): file1: Label of the file to compare to file2. file2: Label of the file to compare to file1. failure_message: Additional message to log if the files' contents do not match. - **kwargs: The common attributes for tests. + **kwargs: The common attributes for tests. """ _diff_test( name = name, diff --git a/rules/native_binary.bzl b/rules/native_binary.bzl index a027fc9..b33347b 100644 --- a/rules/native_binary.bzl +++ b/rules/native_binary.bzl @@ -61,7 +61,7 @@ _ATTRS = { "data": attr.label_list( allow_files = True, doc = "data dependencies. See" + - " https://docs.bazel.build/versions/main/be/common-definitions.html#typical.data", + " https://bazel.build/reference/be/common-definitions#typical.data", ), # "out" is attr.string instead of attr.output, so that it is select()'able. "out": attr.string(mandatory = True, doc = "An output name for the copy of the binary"), diff --git a/rules/run_binary.bzl b/rules/run_binary.bzl index 47c8bc5..c40c0be 100644 --- a/rules/run_binary.bzl +++ b/rules/run_binary.bzl @@ -76,7 +76,7 @@ run_binary = rule( ), "env": attr.string_dict( doc = "Environment variables of the action.

Subject to " + - " $(location)" + + " $(location)" + " expansion.", ), "srcs": attr.label_list( @@ -91,7 +91,7 @@ run_binary = rule( ), "args": attr.string_list( doc = "Command line arguments of the binary.

Subject to" + - "$(location)" + + "$(location)" + " expansion.", ), }, diff --git a/rules/select_file.bzl b/rules/select_file.bzl index f359e43..1b73093 100644 --- a/rules/select_file.bzl +++ b/rules/select_file.bzl @@ -15,7 +15,7 @@ """ select_file() build rule implementation. -Selects a single file from the outputs of some target by given relative path. +Selects a single file from the outputs of a target by given relative path. """ def _impl(ctx): @@ -38,8 +38,7 @@ def _impl(ctx): select_file = rule( implementation = _impl, - doc = "Selects a single file from the outputs of some target \ -by given relative path", + doc = "Selects a single file from the outputs of a target by given relative path", attrs = { "srcs": attr.label( allow_files = True,