Skip to content

Commit 11cf1cf

Browse files
committed
docs: two usage examples name the current version, and dist-apk says which of its payloads is asked for
The examples named 0.8.0 and 0.11.0, which a reader copies into a project that then resolves a release without what the page describes. The reason dist-apk's tools are features also predated on-request provisioning: `xim:bundletool` is now asked for while a bundle is planned, and `xim:kotlin` is still installed with the feature that compiles Kotlin.
1 parent a694d16 commit 11cf1cf

2 files changed

Lines changed: 10 additions & 6 deletions

File tree

‎docs/dist-apk.md‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,17 @@ Both features imply `dist-apk`, so a project names them in its place:
2727

2828
```toml
2929
[build-dependencies.mcpp]
30-
plugins = { version = "0.11.0", features = ["dist-apk-kotlin", "dist-apk-maven"], host-module = true }
30+
plugins = { version = "0.19.0", features = ["dist-apk-kotlin", "dist-apk-maven"], host-module = true }
3131
```
3232

33-
They are features and not payloads of `dist-apk` because provisioning runs
34-
before the build program says what it compiles. A payload of `dist-apk` would be
35-
installed for every Android consumer, and the Kotlin compiler is 90 MB. Kotlin
36-
sources without the feature are refused, naming it.
33+
They are features and not payloads of `dist-apk` because a feature is what a
34+
project selects, and selecting is the statement: a payload of `dist-apk` would
35+
belong to every Android consumer, and the Kotlin compiler is 90 MB. A project
36+
that selects `dist-apk-kotlin` compiles Kotlin, so `xim:kotlin` is installed with
37+
the feature; `xim:bundletool`, which only `--format aab` uses, is asked for while
38+
that bundle is planned (`provision = "on-request"`, 0.19.0), so an ordinary
39+
`--format apk` build installs nothing for it. Kotlin sources without the feature
40+
are refused, naming it.
3741

3842
**An ordinary build does not reach the network.** A Maven graph is resolved and
3943
downloaded only when the developer asks:

‎docs/engine-and-rules.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ A project names the rule and nothing else:
4141

4242
```toml
4343
[build-dependencies.mcpp]
44-
plugins = { version = "0.8.0", features = ["rules-cuda"], host-module = true }
44+
plugins = { version = "0.19.0", features = ["rules-cuda"], host-module = true }
4545
```
4646

4747
The payloads each rule drives are declared **here**, under the feature that

0 commit comments

Comments
 (0)