From e2497e1f5c7071cc2054c13beb51304a41bf2217 Mon Sep 17 00:00:00 2001 From: David Chen Date: Mon, 22 Aug 2016 09:04:22 +0000 Subject: Use ${link} references in common attribute documentation. -- MOS_MIGRATED_REVID=130916210 --- .../build/docgen/templates/attributes/binary/args.html | 4 ++-- .../build/docgen/templates/attributes/common/distribs.html | 2 +- .../build/docgen/templates/attributes/common/features.html | 2 +- .../build/docgen/templates/attributes/common/licenses.html | 2 +- .../build/docgen/templates/attributes/common/testonly.html | 4 ++-- .../build/docgen/templates/attributes/common/visibility.html | 12 ++++++------ .../build/docgen/templates/attributes/test/args.html | 4 ++-- 7 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/binary/args.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/binary/args.html index edfc61bb69..0bac9f0457 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/attributes/binary/args.html +++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/binary/args.html @@ -1,7 +1,7 @@

List of strings; optional; subject to -$(location) and -"Make variable" substitution, and + $(location) and + "Make variable" substitution, and Bourne shell tokenization

diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/distribs.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/distribs.html index 180adfedcc..70b19eb39d 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/distribs.html +++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/distribs.html @@ -3,5 +3,5 @@

A list of distribution-method strings to be used for this particular build rule. Overrides the BUILD-file scope defaults defined by the -distribs() directive. +distribs() directive.

diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/features.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/features.html index 66cb58ba92..a37642dcec 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/features.html +++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/features.html @@ -1,7 +1,7 @@

List of features. Default is the empty list.

Features on a rule modify the features currently enabled on -the package level via the features attribute.
+ the package level via the features attribute.
For example, if the features ['a', 'b'] are enabled on the package level, and a rule features attribute contains ['-a', 'c'], the features enabled for the rule will be 'b' and 'c'. diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/licenses.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/licenses.html index 0535d68deb..9f5855629a 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/licenses.html +++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/licenses.html @@ -3,5 +3,5 @@

A list of license-type strings to be used for this particular build rule. Overrides the BUILD-file scope defaults defined by the -licenses() directive. +licenses() directive.

diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/testonly.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/testonly.html index 816e3cc203..ed26e6198f 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/testonly.html +++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/testonly.html @@ -11,13 +11,13 @@ depend on any rule that is testonly.

Tests (*_test rules) -and test suites (test_suite rules) +and test suites (test_suite rules) are testonly by default.

By virtue of -default_testonly, +default_testonly, targets under javatests are testonly by default.

diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/visibility.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/visibility.html index 60198d123a..173b344565 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/visibility.html +++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/visibility.html @@ -1,6 +1,6 @@

List of labels; optional; -default default_visibility from -package if specified, else private

+default default_visibility from +package if specified, else private

The visibility attribute on a rule controls whether @@ -33,7 +33,7 @@ in one of their sub-packages have access to this rule. For example, this rule (but not //independent:evil)

  • ["//some/package:my_package_group"]: -A package group is +A package group is a named set of package names. Package groups can also grant access rights to entire subtrees, e.g.//myproj/....
    • @@ -46,10 +46,10 @@ can not be combined with any other visibility specifications. A visibility specification may contain a combination of package labels (i.e. //foo:__pkg__) and package_groups.

    If a rule does not specify the visibility attribute, -the default_visibility -attribute of the package +the default_visibility +attribute of the package statement in the BUILD file containing the rule is used -(except exports_files).

    +(except exports_files).

    If the default visibility for the package is not specified, the rule is private.

    Example:

    diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/args.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/args.html index 161e56f761..7dab0d99d1 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/args.html +++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/args.html @@ -1,6 +1,6 @@

    List of strings; optional; subject to -$(location) and -"Make variable" substitution, and +$(location) and +"Make variable" substitution, and Bourne shell tokenization

    Add these arguments to the --test_arg -- cgit v1.2.3