From 21ee269a55222df15f49f0cec3bca997de292a66 Mon Sep 17 00:00:00 2001 From: Julie <30670028+juliexxia@users.noreply.github.com> Date: Wed, 3 Jul 2019 12:46:14 -0400 Subject: [PATCH] Create new stardoc target for common_settings.bzl (#166) --- docs/BUILD | 8 + docs/common_settings_doc.md | 296 ++++++++++++++++++++++++++++++++++++ rules/BUILD | 5 + 3 files changed, 309 insertions(+) create mode 100755 docs/common_settings_doc.md diff --git a/docs/BUILD b/docs/BUILD index 9894eb5..56a5f4c 100644 --- a/docs/BUILD +++ b/docs/BUILD @@ -128,3 +128,11 @@ stardoc( input = "//rules:run_binary.bzl", deps = ["//rules:run_binary"], ) + +stardoc( + name = "common_settings_docs", + out = "common_settings_doc_gen.md", + input = "//rules:common_settings.bzl", + deps = ["//rules:common_settings"], + semantic_flags = ["--experimental_build_setting_api=True"], +) diff --git a/docs/common_settings_doc.md b/docs/common_settings_doc.md new file mode 100755 index 0000000..1ab03a3 --- /dev/null +++ b/docs/common_settings_doc.md @@ -0,0 +1,296 @@ + + + + +## bool_flag + +
+bool_flag(name)
+
+ +A bool-typed build setting that can be set on the command line + +### Attributes + + + + + + + + + + + + +
name + Name; required +

+ A unique name for this target. +

+
+ + + + +## bool_setting + +
+bool_setting(name)
+
+ +A bool-typed build setting that cannot be set on the command line + +### Attributes + + + + + + + + + + + + +
name + Name; required +

+ A unique name for this target. +

+
+ + + + +## int_flag + +
+int_flag(name)
+
+ +An int-typed build setting that can be set on the command line + +### Attributes + + + + + + + + + + + + +
name + Name; required +

+ A unique name for this target. +

+
+ + + + +## int_setting + +
+int_setting(name)
+
+ +An int-typed build setting that cannot be set on the command line + +### Attributes + + + + + + + + + + + + +
name + Name; required +

+ A unique name for this target. +

+
+ + + + +## string_flag + +
+string_flag(name, values)
+
+ +A string-typed build setting that can be set on the command line + +### Attributes + + + + + + + + + + + + + + + + +
name + Name; required +

+ A unique name for this target. +

+
values + List of strings; optional +

+ The list of allowed values for this setting. An error is raised if any other value is given. +

+
+ + + + +## string_list_flag + +
+string_list_flag(name)
+
+ +A string list-typed build setting that can be set on the command line + +### Attributes + + + + + + + + + + + + +
name + Name; required +

+ A unique name for this target. +

+
+ + + + +## string_list_setting + +
+string_list_setting(name)
+
+ +A string list-typed build setting that cannot be set on the command line + +### Attributes + + + + + + + + + + + + +
name + Name; required +

+ A unique name for this target. +

+
+ + + + +## string_setting + +
+string_setting(name, values)
+
+ +A string-typed build setting that cannot be set on the command line + +### Attributes + + + + + + + + + + + + + + + + +
name + Name; required +

+ A unique name for this target. +

+
values + List of strings; optional +

+ The list of allowed values for this setting. An error is raised if any other value is given. +

+
+ + + + +## BuildSettingInfo + +
+BuildSettingInfo(value)
+
+ +A singleton provider that contains the raw value of a build setting + +### Fields + + + + + + + + + + + + +
value +

(Undocumented)

+
+ + diff --git a/rules/BUILD b/rules/BUILD index d61e755..a22dd46 100644 --- a/rules/BUILD +++ b/rules/BUILD @@ -39,6 +39,11 @@ bzl_library( deps = ["//lib:dicts"], ) +bzl_library( + name = "common_settings", + srcs = ["common_settings.bzl"], +) + # Exported for build_test.bzl to make sure of, it is an implementation detail # of the rule and should not be directly used by anything else. exports_files(["empty_test.sh"])