aboutsummaryrefslogtreecommitdiffhomepage
path: root/site
diff options
context:
space:
mode:
authorGravatar brandjon <brandjon@google.com>2017-09-12 18:48:33 +0200
committerGravatar Philipp Wollermann <philwo@google.com>2017-09-13 19:05:13 +0200
commitaa1a4f2c3dfdb40bd0f4349cf313354a7543a5a8 (patch)
tree805a6f6255455c5029b8e7a22f0f5fc68f79d0b6 /site
parente1b4bc2b872894b51d545c0c4867981eebd886c9 (diff)
Added missing documentation for a few options in backward-compatibility.md.
RELNOTES: None PiperOrigin-RevId: 168388811
Diffstat (limited to 'site')
-rw-r--r--site/docs/skylark/backward-compatibility.md46
1 files changed, 45 insertions, 1 deletions
diff --git a/site/docs/skylark/backward-compatibility.md b/site/docs/skylark/backward-compatibility.md
index a17b9bfebc..52237e65c3 100644
--- a/site/docs/skylark/backward-compatibility.md
+++ b/site/docs/skylark/backward-compatibility.md
@@ -30,7 +30,7 @@ We are doing this to reduce confusion between the specialized
[depset](depsets.md) data structure and Python's set datatype.
* Flag: `--incompatible_disallow_set_constructor`
-* Default: `false`
+* Default: `true`
## Keyword-only arguments
@@ -90,6 +90,16 @@ with Python. A possible workaround is to use the `.update` method instead.
* Default: `false`
+## Load must appear at top of file
+
+Previously, the `load` statement could appear anywhere in a `.bzl` file so long
+as it was at the top level. With this change, for `.bzl` files, `load` must
+appear at the beginning of the file, i.e. before any other non-`load` statement.
+
+* Flag: `--incompatible_bzl_disallow_load_after_statement`
+* Default: `false`
+
+
## Load argument is a label
Historically, the first argument of `load` could be a path with an implicit
@@ -223,6 +233,27 @@ If you really want to override a value, use a separate statement:
* Default: `true`
+## New actions API
+
+This change removes the old methods for registering actions within rules, and
+requires that you use the new methods instead (which are available regardless).
+The deprecated methods and their replacements are as follows.
+
+* `ctx.new_file(...)` --> `ctx.actions.declare_file(...)`
+* `ctx.experimental_new_directory(...)` -->
+ `ctx.actions.declare_directory(...)`
+* `ctx.action(...)` --> either `ctx.actions.run(...)` or
+ `ctx.actions.run_shell(...)`
+* `ctx.file_action(...)` --> `ctx.actions.write(...)`
+* `ctx.empty_action(...)` --> `ctx.actions.do_nothing(...)`
+* `ctx.template_action(...)` --> `ctx.actions.expand_template(...)`
+
+<!-- filler comment, needed by Markdown to separate the lists -->
+
+* Flag: `--incompatible_new_actions_api`
+* Default: `false`
+
+
## Checked arithmetic
When set, arithmetic operations (`+`, `-`, `*`) will fail in case of overflow.
@@ -230,3 +261,16 @@ All integers are stored using signed 32 bits.
* Flag: `--incompatible_checked_arithmetic`
* Default: `true`
+
+
+## Descriptive string representations
+
+For certain types of objects, this changes the string representations returned
+by `str()` and `repr()` to be more uniform and safe. In particular, the new
+representations are hermetic and deterministic.
+
+* Flag: `--incompatible_descriptive_string_representations`
+* Default: `true`
+
+
+<!-- Add new options here -->