From b351922fdb9bb1a30b5695cc8050cee609f02828 Mon Sep 17 00:00:00 2001
From: "Worker Pants (Pantsbuild GitHub Automation Bot)"
<133242086+WorkerPants@users.noreply.github.com>
Date: Wed, 17 Jan 2024 14:13:36 -0800
Subject: [PATCH] Update docs site for version 2.19.0rc5 (#131)
Docs from
https://github.com/pantsbuild/pants/releases/tag/release_2.19.0rc5
---
.../version-2.19/docs/docker/index.mdx | 30 +-
.../getting-started/initial-configuration.mdx | 12 +-
.../goals/go-dump-import-path-mapping.mdx | 41 +
.../reference/goals/go-export-cgo-codegen.mdx | 44 +
.../goals/go-show-package-analysis.mdx | 44 +
.../goals/java-dump-source-analysis.mdx | 45 +
.../reference/goals/jvm-symbol-map.mdx | 43 +
.../goals/kotlin-dump-source-analysis.mdx | 45 +
.../goals/scala-dump-source-analysis.mdx | 47 +
.../version-2.19/reference/help-all.json | 137248 +++++++++------
.../reference/subsystems/avro.mdx | 48 +
.../reference/subsystems/cc-external.mdx | 252 +
.../reference/subsystems/cc-infer.mdx | 66 +
.../version-2.19/reference/subsystems/cc.mdx | 184 +
.../reference/subsystems/clang-format.mdx | 156 +
.../version-2.19/reference/subsystems/cue.mdx | 168 +
.../subsystems/environments-preview.mdx | 2 +-
.../reference/subsystems/go-vet.mdx | 48 +
.../reference/subsystems/golangci-lint.mdx | 198 +
.../subsystems/google-java-format.mdx | 2 +-
.../reference/subsystems/jarjar.mdx | 2 +-
.../reference/subsystems/java-avro.mdx | 104 +
.../reference/subsystems/java-thrift.mdx | 52 +
.../reference/subsystems/junit.mdx | 2 +-
.../reference/subsystems/ktlint.mdx | 2 +-
.../reference/subsystems/kubeconform.mdx | 223 +
.../reference/subsystems/nodejs-infer.mdx | 2 +-
.../reference/subsystems/nodejs-test.mdx | 99 +
.../reference/subsystems/nodejs.mdx | 2 +-
.../subsystems/openapi-generator.mdx | 104 +
.../reference/subsystems/prettier.mdx | 94 +
.../subsystems/protobuf-java-grpc.mdx | 2 +-
.../reference/subsystems/pydocstyle.mdx | 2 +-
.../subsystems/pyenv-python-provider.mdx | 169 +
.../reference/subsystems/pyright.mdx | 112 +
.../reference/subsystems/rust.mdx | 68 +
.../reference/subsystems/rustfmt.mdx | 48 +
.../reference/subsystems/scalafmt.mdx | 2 +-
.../reference/subsystems/scalapb.mdx | 2 +-
.../reference/subsystems/scalatest.mdx | 2 +-
.../reference/subsystems/scrooge.mdx | 104 +
.../reference/subsystems/taplo.mdx | 206 +
.../reference/subsystems/terraform-tfsec.mdx | 162 +
.../reference/subsystems/visibility.mdx | 62 +
.../reference/targets/avro_source.mdx | 106 +
.../reference/targets/avro_sources.mdx | 134 +
.../reference/targets/cc_source.mdx | 90 +
.../reference/targets/cc_sources.mdx | 92 +
.../reference/targets/cue_package.mdx | 63 +
.../reference/targets/debian_package.mdx | 123 +
.../reference/targets/docker_environment.mdx | 168 +-
.../reference/targets/docker_image.mdx | 2 -
.../reference/targets/go_package.mdx | 24 +
.../reference/targets/helm_chart.mdx | 84 +
.../reference/targets/helm_deployment.mdx | 84 +
.../reference/targets/javascript_source.mdx | 90 +
.../reference/targets/javascript_sources.mdx | 121 +
.../reference/targets/javascript_test.mdx | 130 +
.../reference/targets/javascript_tests.mdx | 161 +
.../reference/targets/jvm_artifact.mdx | 2 +-
.../reference/targets/local_environment.mdx | 168 +-
.../reference/targets/node_package.mdx | 104 +
.../targets/node_third_party_package.mdx | 91 +
.../reference/targets/openapi_document.mdx | 62 +
.../reference/targets/openapi_documents.mdx | 62 +
.../reference/targets/package_json.mdx | 95 +
.../reference/targets/pants_requirements.mdx | 2 +-
.../reference/targets/protobuf_source.mdx | 42 +-
.../reference/targets/protobuf_sources.mdx | 54 +-
.../targets/python_aws_lambda_function.mdx | 13 +
.../targets/python_aws_lambda_layer.mdx | 13 +
.../targets/python_google_cloud_function.mdx | 13 +
.../reference/targets/python_requirement.mdx | 4 +-
.../reference/targets/python_source.mdx | 96 +-
.../reference/targets/python_sources.mdx | 96 +-
.../reference/targets/python_test.mdx | 118 +-
.../reference/targets/python_test_utils.mdx | 96 +-
.../reference/targets/python_tests.mdx | 118 +-
.../reference/targets/remote_environment.mdx | 168 +-
.../reference/targets/rust_package.mdx | 75 +
.../reference/targets/scala_artifact.mdx | 2 +-
.../reference/targets/swift_source.mdx | 78 +
.../reference/targets/swift_sources.mdx | 80 +
.../targets/terraform_deployment.mdx | 12 +
.../reference/targets/terraform_module.mdx | 24 +
.../reference/targets/thrift_source.mdx | 38 +
.../reference/targets/thrift_sources.mdx | 38 +
87 files changed, 90181 insertions(+), 53405 deletions(-)
create mode 100644 versioned_docs/version-2.19/reference/goals/go-dump-import-path-mapping.mdx
create mode 100644 versioned_docs/version-2.19/reference/goals/go-export-cgo-codegen.mdx
create mode 100644 versioned_docs/version-2.19/reference/goals/go-show-package-analysis.mdx
create mode 100644 versioned_docs/version-2.19/reference/goals/java-dump-source-analysis.mdx
create mode 100644 versioned_docs/version-2.19/reference/goals/jvm-symbol-map.mdx
create mode 100644 versioned_docs/version-2.19/reference/goals/kotlin-dump-source-analysis.mdx
create mode 100644 versioned_docs/version-2.19/reference/goals/scala-dump-source-analysis.mdx
create mode 100644 versioned_docs/version-2.19/reference/subsystems/avro.mdx
create mode 100644 versioned_docs/version-2.19/reference/subsystems/cc-external.mdx
create mode 100644 versioned_docs/version-2.19/reference/subsystems/cc-infer.mdx
create mode 100644 versioned_docs/version-2.19/reference/subsystems/cc.mdx
create mode 100644 versioned_docs/version-2.19/reference/subsystems/clang-format.mdx
create mode 100644 versioned_docs/version-2.19/reference/subsystems/cue.mdx
create mode 100644 versioned_docs/version-2.19/reference/subsystems/go-vet.mdx
create mode 100644 versioned_docs/version-2.19/reference/subsystems/golangci-lint.mdx
create mode 100644 versioned_docs/version-2.19/reference/subsystems/java-avro.mdx
create mode 100644 versioned_docs/version-2.19/reference/subsystems/java-thrift.mdx
create mode 100644 versioned_docs/version-2.19/reference/subsystems/kubeconform.mdx
create mode 100644 versioned_docs/version-2.19/reference/subsystems/nodejs-test.mdx
create mode 100644 versioned_docs/version-2.19/reference/subsystems/openapi-generator.mdx
create mode 100644 versioned_docs/version-2.19/reference/subsystems/prettier.mdx
create mode 100644 versioned_docs/version-2.19/reference/subsystems/pyenv-python-provider.mdx
create mode 100644 versioned_docs/version-2.19/reference/subsystems/pyright.mdx
create mode 100644 versioned_docs/version-2.19/reference/subsystems/rust.mdx
create mode 100644 versioned_docs/version-2.19/reference/subsystems/rustfmt.mdx
create mode 100644 versioned_docs/version-2.19/reference/subsystems/scrooge.mdx
create mode 100644 versioned_docs/version-2.19/reference/subsystems/taplo.mdx
create mode 100644 versioned_docs/version-2.19/reference/subsystems/terraform-tfsec.mdx
create mode 100644 versioned_docs/version-2.19/reference/subsystems/visibility.mdx
create mode 100644 versioned_docs/version-2.19/reference/targets/avro_source.mdx
create mode 100644 versioned_docs/version-2.19/reference/targets/avro_sources.mdx
create mode 100644 versioned_docs/version-2.19/reference/targets/cc_source.mdx
create mode 100644 versioned_docs/version-2.19/reference/targets/cc_sources.mdx
create mode 100644 versioned_docs/version-2.19/reference/targets/cue_package.mdx
create mode 100644 versioned_docs/version-2.19/reference/targets/debian_package.mdx
create mode 100644 versioned_docs/version-2.19/reference/targets/javascript_source.mdx
create mode 100644 versioned_docs/version-2.19/reference/targets/javascript_sources.mdx
create mode 100644 versioned_docs/version-2.19/reference/targets/javascript_test.mdx
create mode 100644 versioned_docs/version-2.19/reference/targets/javascript_tests.mdx
create mode 100644 versioned_docs/version-2.19/reference/targets/node_package.mdx
create mode 100644 versioned_docs/version-2.19/reference/targets/node_third_party_package.mdx
create mode 100644 versioned_docs/version-2.19/reference/targets/package_json.mdx
create mode 100644 versioned_docs/version-2.19/reference/targets/rust_package.mdx
create mode 100644 versioned_docs/version-2.19/reference/targets/swift_source.mdx
create mode 100644 versioned_docs/version-2.19/reference/targets/swift_sources.mdx
diff --git a/versioned_docs/version-2.19/docs/docker/index.mdx b/versioned_docs/version-2.19/docs/docker/index.mdx
index e3407cd31..d52757209 100644
--- a/versioned_docs/version-2.19/docs/docker/index.mdx
+++ b/versioned_docs/version-2.19/docs/docker/index.mdx
@@ -182,23 +182,20 @@ Secrets should not be checked into version control. Use absolute paths to refere
See the example for the [`secrets`](../../reference/targets/docker_image.mdx#secrets) field.
:::
-### External cache storage backends
+### Buildx Support
-BuildKit supports exporting build cache to an external location, making it possible to import in future builds. Cache backends can be configured using the [`cache_to`](../../reference/targets/docker_image.mdx#cache_to) and [`cache_from`](../../reference/targets/docker_image.mdx#cache_from) fields.
+Buildx (using BuildKit) supports exporting build cache to an external location, making it possible to import in future builds. Cache backends can be configured using the [`cache_to`](../../reference/targets/docker_image.mdx#cache_to) and [`cache_from`](../../reference/targets/docker_image.mdx#cache_from) fields.
-Create a builder using a [build driver](https://docs.docker.com/build/drivers/) that is compatible with the cache backend:
-
-```
-❯ docker buildx create --name container --driver=docker-container container
-```
-
-Use the builder:
-
-```
-❯ export BUILDX_BUILDER=container
+To use BuildKit with Pants, enable the [Containerd Image Store](https://docs.docker.com/desktop/containerd/), either via [Docker Desktop settings](https://docs.docker.com/storage/containerd/) or by [setting daemon config](https://docs.docker.com/storage/containerd/#enable-containerd-image-store-on-docker-engine):
+```json
+{
+ "features": {
+ "containerd-snapshotter": true
+ }
+}
```
-Optionally, validate a build with the Docker CLI directly:
+Optionally, run a build with the Docker CLI directly to validate buildx support on your system:
```
❯ docker buildx build -t pants-cache-test:latest \
@@ -206,14 +203,11 @@ Optionally, validate a build with the Docker CLI directly:
--cache-from type=local,src=/tmp/docker/pants-test-cache .
```
-Configure Pants to use buildx and pass the BUILDX_BUILDER environment variable:
+Configure Pants to use buildx:
```toml tab={"label":"pants.toml"}
[docker]
use_buildx = true
-env_vars = [
- "BUILDX_BUILDER"
-]
```
```python tab={"label":"example/BUILD"}
@@ -230,6 +224,8 @@ docker_image(
)
```
+For working examples, including multi-platform builds with Github Actions, refer to the [example-docker](https://github.com/pantsbuild/example-docker) repository.
+
### Build Docker image example
This example copies both a `file` and `pex_binary`. The file is specified as an explicit dependency in the `BUILD` file, whereas the `pex_binary` dependency is inferred from the path in the `Dockerfile`.
diff --git a/versioned_docs/version-2.19/docs/getting-started/initial-configuration.mdx b/versioned_docs/version-2.19/docs/getting-started/initial-configuration.mdx
index f9b7b8da1..54b27cc84 100644
--- a/versioned_docs/version-2.19/docs/getting-started/initial-configuration.mdx
+++ b/versioned_docs/version-2.19/docs/getting-started/initial-configuration.mdx
@@ -9,7 +9,7 @@ Creating the configuration necessary to run Pants.
To get started in a new repository, follow these steps, and then visit one of the language-specific overview pages.
-1. # Create `pants.toml`
+## 1. Create `pants.toml`
Pants configuration lives in a file called `pants.toml` in the root of the repo. This file uses the [TOML](https://github.com/toml-lang/toml) format.
@@ -22,7 +22,7 @@ pants_version = "$PANTS_VERSION"
where `$PANTS_VERSION` is the version of Pants that you want to pin your repo to. When you'd like to upgrade Pants, edit `pants_version` and the `pants` script will self-update on the next run.
-2. # Configure source roots
+## 2. Configure source roots
Many languages organize code in a package hierarchy, so that the relative location of a source file on the filesystem corresponds to a logical package name. The directories that correspond to the roots of the language's package hierarchy are referred to as [source roots](../using-pants/key-concepts/source-roots.mdx). These are the filesystem locations from which import paths are computed.
@@ -38,7 +38,7 @@ If your project has a different structure, see [Source roots](../using-pants/key
Golang projects already use `go.mod` to indicate source roots.
:::
-3. # Enable backends
+## 3. Enable backends
Most Pants functionality is provided via pluggable [_backends_](../using-pants/key-concepts/backends.mdx), which are activated by adding to the `[GLOBAL].backend_packages` option like this:
@@ -54,7 +54,7 @@ backend_packages = [
See [here](../using-pants/key-concepts/backends.mdx) for a list of available backends.
-4. # Update `.gitignore`
+## 4. Update `.gitignore`
If you use Git, we recommend adding these lines to your top-level `.gitignore` file:
@@ -68,7 +68,7 @@ If you use Git, we recommend adding these lines to your top-level `.gitignore` f
The `pants_ignore` option tells Pants which files to avoid looking at, but it additionally ignores all `.gitignore`d files by default. Occasionally, you will want to ignore something with Git, but still want Pants to work on the file. See [Troubleshooting / common issues](../using-pants/troubleshooting-common-issues.mdx) for how to do this.
:::
-5. # Generate BUILD files
+## 5. Generate BUILD files
Once you have enabled the backends for the language(s) you'd like to use, run [`pants tailor ::`](./initial-configuration.mdx#5-generate-build-files) to generate an initial set of [BUILD](../using-pants/key-concepts/targets-and-build-files.mdx) files.
@@ -106,6 +106,6 @@ To fix `tailor` failures, run `pants tailor`.
:::
-6. # Visit a language specific overview
+## 6. Visit a language specific overview
You're almost ready to go! Next up is visiting one of the language-specific overviews listed below.
diff --git a/versioned_docs/version-2.19/reference/goals/go-dump-import-path-mapping.mdx b/versioned_docs/version-2.19/reference/goals/go-dump-import-path-mapping.mdx
new file mode 100644
index 000000000..065c13791
--- /dev/null
+++ b/versioned_docs/version-2.19/reference/goals/go-dump-import-path-mapping.mdx
@@ -0,0 +1,41 @@
+---
+title: go-dump-import-path-mapping
+description: |
+ Dump import paths mapped to package addresses.
+---
+
+import Option from "@site/src/components/reference/Option";
+import styles from "@site/src/components/reference/styles.module.css";
+
+---
+
+```
+pants go-dump-import-path-mapping [args]
+```
+
+Dump import paths mapped to package addresses.
+
+Backend: `pants.backend.experimental.go.debug_goals`
+
+Config section: `[go-dump-import-path-mapping]`
+
+
+
+## Basic options
+
+None
+
+## Advanced options
+
+None
+
+## Deprecated options
+
+None
+
+## Related subsystems
+
+- [environments-preview](../subsystems/environments-preview.mdx)
+- [filter](../subsystems/filter.mdx)
+
+
diff --git a/versioned_docs/version-2.19/reference/goals/go-export-cgo-codegen.mdx b/versioned_docs/version-2.19/reference/goals/go-export-cgo-codegen.mdx
new file mode 100644
index 000000000..b479be09c
--- /dev/null
+++ b/versioned_docs/version-2.19/reference/goals/go-export-cgo-codegen.mdx
@@ -0,0 +1,44 @@
+---
+title: go-export-cgo-codegen
+description: |
+ Export files generated by Cgo.
+---
+
+import Option from "@site/src/components/reference/Option";
+import styles from "@site/src/components/reference/styles.module.css";
+
+---
+
+```
+pants go-export-cgo-codegen [args]
+```
+
+Export files generated by Cgo.
+
+Backend: `pants.backend.experimental.go.debug_goals`
+
+Config section: `[go-export-cgo-codegen]`
+
+
+
+## Basic options
+
+None
+
+## Advanced options
+
+None
+
+## Deprecated options
+
+None
+
+## Related subsystems
+
+- [environments-preview](../subsystems/environments-preview.mdx)
+- [filter](../subsystems/filter.mdx)
+- [go-test](../subsystems/go-test.mdx)
+- [golang](../subsystems/golang.mdx)
+- [system-binaries](../subsystems/system-binaries.mdx)
+
+
diff --git a/versioned_docs/version-2.19/reference/goals/go-show-package-analysis.mdx b/versioned_docs/version-2.19/reference/goals/go-show-package-analysis.mdx
new file mode 100644
index 000000000..f9b44692c
--- /dev/null
+++ b/versioned_docs/version-2.19/reference/goals/go-show-package-analysis.mdx
@@ -0,0 +1,44 @@
+---
+title: go-show-package-analysis
+description: |
+ Show the package analysis for Go package targets.
+---
+
+import Option from "@site/src/components/reference/Option";
+import styles from "@site/src/components/reference/styles.module.css";
+
+---
+
+```
+pants go-show-package-analysis [args]
+```
+
+Show the package analysis for Go package targets.
+
+Backend: `pants.backend.experimental.go.debug_goals`
+
+Config section: `[go-show-package-analysis]`
+
+
+
+## Basic options
+
+None
+
+## Advanced options
+
+None
+
+## Deprecated options
+
+None
+
+## Related subsystems
+
+- [environments-preview](../subsystems/environments-preview.mdx)
+- [filter](../subsystems/filter.mdx)
+- [go-test](../subsystems/go-test.mdx)
+- [golang](../subsystems/golang.mdx)
+- [system-binaries](../subsystems/system-binaries.mdx)
+
+
diff --git a/versioned_docs/version-2.19/reference/goals/java-dump-source-analysis.mdx b/versioned_docs/version-2.19/reference/goals/java-dump-source-analysis.mdx
new file mode 100644
index 000000000..fdef972de
--- /dev/null
+++ b/versioned_docs/version-2.19/reference/goals/java-dump-source-analysis.mdx
@@ -0,0 +1,45 @@
+---
+title: java-dump-source-analysis
+description: |
+ Dump source analysis for java_source[s] targets.
+---
+
+import Option from "@site/src/components/reference/Option";
+import styles from "@site/src/components/reference/styles.module.css";
+
+---
+
+```
+pants java-dump-source-analysis [args]
+```
+
+Dump source analysis for java_source[s] targets.
+
+Backend: `pants.backend.experimental.java.debug_goals`
+
+Config section: `[java-dump-source-analysis]`
+
+
+
+## Basic options
+
+None
+
+## Advanced options
+
+None
+
+## Deprecated options
+
+None
+
+## Related subsystems
+
+- [coursier](../subsystems/coursier.mdx)
+- [environments-preview](../subsystems/environments-preview.mdx)
+- [filter](../subsystems/filter.mdx)
+- [jvm](../subsystems/jvm.mdx)
+- [python-bootstrap](../subsystems/python-bootstrap.mdx)
+- [system-binaries](../subsystems/system-binaries.mdx)
+
+
diff --git a/versioned_docs/version-2.19/reference/goals/jvm-symbol-map.mdx b/versioned_docs/version-2.19/reference/goals/jvm-symbol-map.mdx
new file mode 100644
index 000000000..90be05024
--- /dev/null
+++ b/versioned_docs/version-2.19/reference/goals/jvm-symbol-map.mdx
@@ -0,0 +1,43 @@
+---
+title: jvm-symbol-map
+description: |
+ Dump the JVM dependency inference symbol mapping.
+---
+
+import Option from "@site/src/components/reference/Option";
+import styles from "@site/src/components/reference/styles.module.css";
+
+---
+
+```
+pants jvm-symbol-map [args]
+```
+
+Dump the JVM dependency inference symbol mapping.
+
+Backend: `pants.backend.experimental.java.debug_goals`
+
+Config section: `[jvm-symbol-map]`
+
+
+
+## Basic options
+
+None
+
+## Advanced options
+
+None
+
+## Deprecated options
+
+None
+
+## Related subsystems
+
+- [environments-preview](../subsystems/environments-preview.mdx)
+- [filter](../subsystems/filter.mdx)
+- [java-infer](../subsystems/java-infer.mdx)
+- [jvm](../subsystems/jvm.mdx)
+
+
diff --git a/versioned_docs/version-2.19/reference/goals/kotlin-dump-source-analysis.mdx b/versioned_docs/version-2.19/reference/goals/kotlin-dump-source-analysis.mdx
new file mode 100644
index 000000000..1b18e154c
--- /dev/null
+++ b/versioned_docs/version-2.19/reference/goals/kotlin-dump-source-analysis.mdx
@@ -0,0 +1,45 @@
+---
+title: kotlin-dump-source-analysis
+description: |
+ Dump source analysis for kotlin_source targets.
+---
+
+import Option from "@site/src/components/reference/Option";
+import styles from "@site/src/components/reference/styles.module.css";
+
+---
+
+```
+pants kotlin-dump-source-analysis [args]
+```
+
+Dump source analysis for kotlin_source targets.
+
+Backend: `pants.backend.experimental.kotlin.debug_goals`
+
+Config section: `[kotlin-dump-source-analysis]`
+
+
+
+## Basic options
+
+None
+
+## Advanced options
+
+None
+
+## Deprecated options
+
+None
+
+## Related subsystems
+
+- [coursier](../subsystems/coursier.mdx)
+- [environments-preview](../subsystems/environments-preview.mdx)
+- [filter](../subsystems/filter.mdx)
+- [jvm](../subsystems/jvm.mdx)
+- [python-bootstrap](../subsystems/python-bootstrap.mdx)
+- [system-binaries](../subsystems/system-binaries.mdx)
+
+
diff --git a/versioned_docs/version-2.19/reference/goals/scala-dump-source-analysis.mdx b/versioned_docs/version-2.19/reference/goals/scala-dump-source-analysis.mdx
new file mode 100644
index 000000000..37525aa7b
--- /dev/null
+++ b/versioned_docs/version-2.19/reference/goals/scala-dump-source-analysis.mdx
@@ -0,0 +1,47 @@
+---
+title: scala-dump-source-analysis
+description: |
+ Dump source analysis for scala_source targets.
+---
+
+import Option from "@site/src/components/reference/Option";
+import styles from "@site/src/components/reference/styles.module.css";
+
+---
+
+```
+pants scala-dump-source-analysis [args]
+```
+
+Dump source analysis for scala_source targets.
+
+Backend: `pants.backend.experimental.scala.debug_goals`
+
+Config section: `[scala-dump-source-analysis]`
+
+
+
+## Basic options
+
+None
+
+## Advanced options
+
+None
+
+## Deprecated options
+
+None
+
+## Related subsystems
+
+- [coursier](../subsystems/coursier.mdx)
+- [environments-preview](../subsystems/environments-preview.mdx)
+- [filter](../subsystems/filter.mdx)
+- [jvm](../subsystems/jvm.mdx)
+- [python-bootstrap](../subsystems/python-bootstrap.mdx)
+- [scala](../subsystems/scala.mdx)
+- [scalac](../subsystems/scalac.mdx)
+- [system-binaries](../subsystems/system-binaries.mdx)
+
+
diff --git a/versioned_docs/version-2.19/reference/help-all.json b/versioned_docs/version-2.19/reference/help-all.json
index a9649c3fe..ffc3f236c 100644
--- a/versioned_docs/version-2.19/reference/help-all.json
+++ b/versioned_docs/version-2.19/reference/help-all.json
@@ -16,10 +16,14 @@
"help": "Arguments to pass directly to add-trailing-comma, e.g. `--add-trailing-comma-args='--py36-plus'`.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--add-trailing-comma-args"],
+ "scoped_cmd_line_args": [
+ "--add-trailing-comma-args"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--args"],
+ "unscoped_cmd_line_args": [
+ "--args"
+ ],
"value_history": {
"ranked_values": [
{
@@ -43,16 +47,22 @@
"default": "add-trailing-comma",
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--add-trailing-comma-console-script="],
+ "display_args": [
+ "--add-trailing-comma-console-script="
+ ],
"env_var": "PANTS_ADD_TRAILING_COMMA_CONSOLE_SCRIPT",
"fromfile": false,
"help": "The console script for the tool. Using this option is generally preferable to (and mutually exclusive with) specifying an `--entry-point` since console script names have a higher expectation of staying stable across releases of the tool. Usually, you will not want to change this from the default.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--add-trailing-comma-console-script"],
+ "scoped_cmd_line_args": [
+ "--add-trailing-comma-console-script"
+ ],
"target_field_name": null,
"typ": "str",
- "unscoped_cmd_line_args": ["--console-script"],
+ "unscoped_cmd_line_args": [
+ "--console-script"
+ ],
"value_history": {
"ranked_values": [
{
@@ -76,16 +86,22 @@
"default": null,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--add-trailing-comma-entry-point="],
+ "display_args": [
+ "--add-trailing-comma-entry-point="
+ ],
"env_var": "PANTS_ADD_TRAILING_COMMA_ENTRY_POINT",
"fromfile": false,
"help": "The entry point for the tool. Generally you only want to use this option if the tool does not offer a `--console-script` (which this option is mutually exclusive with). Usually, you will not want to change this from the default.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--add-trailing-comma-entry-point"],
+ "scoped_cmd_line_args": [
+ "--add-trailing-comma-entry-point"
+ ],
"target_field_name": null,
"typ": "str",
- "unscoped_cmd_line_args": ["--entry-point"],
+ "unscoped_cmd_line_args": [
+ "--entry-point"
+ ],
"value_history": {
"ranked_values": [
{
@@ -104,16 +120,22 @@
"default": null,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--add-trailing-comma-install-from-resolve="],
+ "display_args": [
+ "--add-trailing-comma-install-from-resolve="
+ ],
"env_var": "PANTS_ADD_TRAILING_COMMA_INSTALL_FROM_RESOLVE",
"fromfile": false,
"help": "If specified, install the tool using the lockfile for this named resolve.\n\nThis resolve must be defined in `[python].resolves`, as described in https://www.pantsbuild.org/v2.19/docs/python-third-party-dependencies#user-lockfiles.\n\nThe resolve's entire lockfile will be installed, unless specific requirements are listed via the `requirements` option, in which case only those requirements will be installed. This is useful if you don't want to invalidate the tool's outputs when the resolve incurs changes to unrelated requirements.\n\nIf unspecified, and the `lockfile` option is unset, the tool will be installed using the default lockfile shipped with Pants.\n\nIf unspecified, and the `lockfile` option is set, the tool will use the custom `add-trailing-comma` \"tool lockfile\" generated from the `version` and `extra_requirements` options. But note that this mechanism is deprecated.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--add-trailing-comma-install-from-resolve"],
+ "scoped_cmd_line_args": [
+ "--add-trailing-comma-install-from-resolve"
+ ],
"target_field_name": null,
"typ": "str",
- "unscoped_cmd_line_args": ["--install-from-resolve"],
+ "unscoped_cmd_line_args": [
+ "--install-from-resolve"
+ ],
"value_history": {
"ranked_values": [
{
@@ -129,7 +151,9 @@
"comma_separated_choices": null,
"comma_separated_display_args": "--add-trailing-comma-interpreter-constraints=\"['', '', ...]\"",
"config_key": "interpreter_constraints",
- "default": ["CPython>=3.7,<4"],
+ "default": [
+ "CPython>=3.7,<4"
+ ],
"deprecated_message": null,
"deprecation_active": false,
"display_args": [
@@ -140,10 +164,14 @@
"help": "Python interpreter constraints for this tool.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--add-trailing-comma-interpreter-constraints"],
+ "scoped_cmd_line_args": [
+ "--add-trailing-comma-interpreter-constraints"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--interpreter-constraints"],
+ "unscoped_cmd_line_args": [
+ "--interpreter-constraints"
+ ],
"value_history": {
"ranked_values": [
{
@@ -154,7 +182,9 @@
{
"details": "",
"rank": "HARDCODED",
- "value": ["CPython>=3.7,<4"]
+ "value": [
+ "CPython>=3.7,<4"
+ ]
}
]
}
@@ -175,10 +205,14 @@
"help": "If `install_from_resolve` is specified, install these requirements, at the versions provided by the specified resolve's lockfile.\n\nValues can be pip-style requirements (e.g., `tool` or `tool==1.2.3` or `tool>=1.2.3`), or addresses of `python_requirement` targets (or targets that generate or depend on `python_requirement` targets).\n\nThe lockfile will be validated against the requirements - if a lockfile doesn't provide the requirement (at a suitable version, if the requirement specifies version constraints) Pants will error.\n\nIf unspecified, install the entire lockfile.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--add-trailing-comma-requirements"],
+ "scoped_cmd_line_args": [
+ "--add-trailing-comma-requirements"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--requirements"],
+ "unscoped_cmd_line_args": [
+ "--requirements"
+ ],
"value_history": {
"ranked_values": [
{
@@ -202,7 +236,9 @@
"default": false,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--[no-]add-trailing-comma-skip"],
+ "display_args": [
+ "--[no-]add-trailing-comma-skip"
+ ],
"env_var": "PANTS_ADD_TRAILING_COMMA_SKIP",
"fromfile": false,
"help": "If true, don't use add-trailing-comma when running `pants fmt` and `pants lint`.",
@@ -214,7 +250,10 @@
],
"target_field_name": null,
"typ": "bool",
- "unscoped_cmd_line_args": ["--skip", "--no-skip"],
+ "unscoped_cmd_line_args": [
+ "--skip",
+ "--no-skip"
+ ],
"value_history": {
"ranked_values": [
{
@@ -238,7 +277,9 @@
"default": false,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--[no-]anonymous-telemetry-enabled"],
+ "display_args": [
+ "--[no-]anonymous-telemetry-enabled"
+ ],
"env_var": "PANTS_ANONYMOUS_TELEMETRY_ENABLED",
"fromfile": false,
"help": "Whether to send anonymous telemetry to the Pants project.\n\nTelemetry is sent asynchronously, with silent failure, and does not impact build times or outcomes.\n\nSee https://www.pantsbuild.org/v2.19/docs/anonymous-telemetry for details.",
@@ -250,7 +291,10 @@
],
"target_field_name": null,
"typ": "bool",
- "unscoped_cmd_line_args": ["--enabled", "--no-enabled"],
+ "unscoped_cmd_line_args": [
+ "--enabled",
+ "--no-enabled"
+ ],
"value_history": {
"ranked_values": [
{
@@ -274,16 +318,22 @@
"default": null,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--anonymous-telemetry-repo-id="],
+ "display_args": [
+ "--anonymous-telemetry-repo-id="
+ ],
"env_var": "PANTS_ANONYMOUS_TELEMETRY_REPO_ID",
"fromfile": false,
"help": "An anonymized ID representing this repo.\n\nFor private repos, you likely want the ID to not be derived from, or algorithmically convertible to, anything identifying the repo.\n\nFor public repos the ID may be visible in that repo's config file, so anonymity of the repo is not guaranteed (although user anonymity is always guaranteed).\n\nSee https://www.pantsbuild.org/v2.19/docs/anonymous-telemetry for details.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--anonymous-telemetry-repo-id"],
+ "scoped_cmd_line_args": [
+ "--anonymous-telemetry-repo-id"
+ ],
"target_field_name": null,
"typ": "str",
- "unscoped_cmd_line_args": ["--repo-id"],
+ "unscoped_cmd_line_args": [
+ "--repo-id"
+ ],
"value_history": {
"ranked_values": [
{
@@ -302,16 +352,22 @@
"default": "0.15",
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--apache-thrift-expected-version="],
+ "display_args": [
+ "--apache-thrift-expected-version="
+ ],
"env_var": "PANTS_APACHE_THRIFT_EXPECTED_VERSION",
"fromfile": false,
"help": "The major/minor version of Apache Thrift that you are using, such as `0.15`.\n\nPants will only use Thrift binaries from `--thrift-search-paths` that have the expected version, and it will error if none are found.\n\nDo not include the patch version.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--apache-thrift-expected-version"],
+ "scoped_cmd_line_args": [
+ "--apache-thrift-expected-version"
+ ],
"target_field_name": null,
"typ": "str",
- "unscoped_cmd_line_args": ["--expected-version"],
+ "unscoped_cmd_line_args": [
+ "--expected-version"
+ ],
"value_history": {
"ranked_values": [
{
@@ -332,7 +388,9 @@
"comma_separated_choices": null,
"comma_separated_display_args": "--apache-thrift-thrift-search-paths=\"['', '', ...]\"",
"config_key": "thrift_search_paths",
- "default": [""],
+ "default": [
+ ""
+ ],
"deprecated_message": null,
"deprecation_active": false,
"display_args": [
@@ -343,10 +401,14 @@
"help": "A list of paths to search for Thrift.\n\nSpecify absolute paths to directories with the `thrift` binary, e.g. `/usr/bin`. Earlier entries will be searched first.\n\nThe special string `\"\"` will expand to the contents of the PATH env var.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--apache-thrift-thrift-search-paths"],
+ "scoped_cmd_line_args": [
+ "--apache-thrift-thrift-search-paths"
+ ],
"target_field_name": "apache_thrift_thrift_search_paths",
"typ": "list",
- "unscoped_cmd_line_args": ["--thrift-search-paths"],
+ "unscoped_cmd_line_args": [
+ "--thrift-search-paths"
+ ],
"value_history": {
"ranked_values": [
{
@@ -357,7 +419,9 @@
{
"details": "",
"rank": "HARDCODED",
- "value": [""]
+ "value": [
+ ""
+ ]
}
]
}
@@ -367,19 +431,27 @@
"comma_separated_choices": null,
"comma_separated_display_args": "--autoflake-args=\"[, , ...]\"",
"config_key": "args",
- "default": ["--remove-all-unused-imports"],
+ "default": [
+ "--remove-all-unused-imports"
+ ],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--autoflake-args=\"[, , ...]\""],
+ "display_args": [
+ "--autoflake-args=\"[, , ...]\""
+ ],
"env_var": "PANTS_AUTOFLAKE_ARGS",
"fromfile": false,
"help": "Arguments to pass directly to Autoflake, e.g. `--autoflake-args='--remove-all-unused-imports --target-version=py37 --quiet'`.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--autoflake-args"],
+ "scoped_cmd_line_args": [
+ "--autoflake-args"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--args"],
+ "unscoped_cmd_line_args": [
+ "--args"
+ ],
"value_history": {
"ranked_values": [
{
@@ -390,7 +462,9 @@
{
"details": "",
"rank": "HARDCODED",
- "value": ["--remove-all-unused-imports"]
+ "value": [
+ "--remove-all-unused-imports"
+ ]
}
]
}
@@ -403,16 +477,22 @@
"default": "autoflake",
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--autoflake-console-script="],
+ "display_args": [
+ "--autoflake-console-script="
+ ],
"env_var": "PANTS_AUTOFLAKE_CONSOLE_SCRIPT",
"fromfile": false,
"help": "The console script for the tool. Using this option is generally preferable to (and mutually exclusive with) specifying an `--entry-point` since console script names have a higher expectation of staying stable across releases of the tool. Usually, you will not want to change this from the default.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--autoflake-console-script"],
+ "scoped_cmd_line_args": [
+ "--autoflake-console-script"
+ ],
"target_field_name": null,
"typ": "str",
- "unscoped_cmd_line_args": ["--console-script"],
+ "unscoped_cmd_line_args": [
+ "--console-script"
+ ],
"value_history": {
"ranked_values": [
{
@@ -436,16 +516,22 @@
"default": null,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--autoflake-entry-point="],
+ "display_args": [
+ "--autoflake-entry-point="
+ ],
"env_var": "PANTS_AUTOFLAKE_ENTRY_POINT",
"fromfile": false,
"help": "The entry point for the tool. Generally you only want to use this option if the tool does not offer a `--console-script` (which this option is mutually exclusive with). Usually, you will not want to change this from the default.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--autoflake-entry-point"],
+ "scoped_cmd_line_args": [
+ "--autoflake-entry-point"
+ ],
"target_field_name": null,
"typ": "str",
- "unscoped_cmd_line_args": ["--entry-point"],
+ "unscoped_cmd_line_args": [
+ "--entry-point"
+ ],
"value_history": {
"ranked_values": [
{
@@ -464,16 +550,22 @@
"default": null,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--autoflake-install-from-resolve="],
+ "display_args": [
+ "--autoflake-install-from-resolve="
+ ],
"env_var": "PANTS_AUTOFLAKE_INSTALL_FROM_RESOLVE",
"fromfile": false,
"help": "If specified, install the tool using the lockfile for this named resolve.\n\nThis resolve must be defined in `[python].resolves`, as described in https://www.pantsbuild.org/v2.19/docs/python-third-party-dependencies#user-lockfiles.\n\nThe resolve's entire lockfile will be installed, unless specific requirements are listed via the `requirements` option, in which case only those requirements will be installed. This is useful if you don't want to invalidate the tool's outputs when the resolve incurs changes to unrelated requirements.\n\nIf unspecified, and the `lockfile` option is unset, the tool will be installed using the default lockfile shipped with Pants.\n\nIf unspecified, and the `lockfile` option is set, the tool will use the custom `autoflake` \"tool lockfile\" generated from the `version` and `extra_requirements` options. But note that this mechanism is deprecated.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--autoflake-install-from-resolve"],
+ "scoped_cmd_line_args": [
+ "--autoflake-install-from-resolve"
+ ],
"target_field_name": null,
"typ": "str",
- "unscoped_cmd_line_args": ["--install-from-resolve"],
+ "unscoped_cmd_line_args": [
+ "--install-from-resolve"
+ ],
"value_history": {
"ranked_values": [
{
@@ -489,7 +581,9 @@
"comma_separated_choices": null,
"comma_separated_display_args": "--autoflake-interpreter-constraints=\"['', '', ...]\"",
"config_key": "interpreter_constraints",
- "default": ["CPython>=3.7,<4"],
+ "default": [
+ "CPython>=3.7,<4"
+ ],
"deprecated_message": null,
"deprecation_active": false,
"display_args": [
@@ -500,10 +594,14 @@
"help": "Python interpreter constraints for this tool.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--autoflake-interpreter-constraints"],
+ "scoped_cmd_line_args": [
+ "--autoflake-interpreter-constraints"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--interpreter-constraints"],
+ "unscoped_cmd_line_args": [
+ "--interpreter-constraints"
+ ],
"value_history": {
"ranked_values": [
{
@@ -514,7 +612,9 @@
{
"details": "",
"rank": "HARDCODED",
- "value": ["CPython>=3.7,<4"]
+ "value": [
+ "CPython>=3.7,<4"
+ ]
}
]
}
@@ -527,16 +627,22 @@
"default": [],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--autoflake-requirements=\"['', '', ...]\""],
+ "display_args": [
+ "--autoflake-requirements=\"['', '', ...]\""
+ ],
"env_var": "PANTS_AUTOFLAKE_REQUIREMENTS",
"fromfile": false,
"help": "If `install_from_resolve` is specified, install these requirements, at the versions provided by the specified resolve's lockfile.\n\nValues can be pip-style requirements (e.g., `tool` or `tool==1.2.3` or `tool>=1.2.3`), or addresses of `python_requirement` targets (or targets that generate or depend on `python_requirement` targets).\n\nThe lockfile will be validated against the requirements - if a lockfile doesn't provide the requirement (at a suitable version, if the requirement specifies version constraints) Pants will error.\n\nIf unspecified, install the entire lockfile.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--autoflake-requirements"],
+ "scoped_cmd_line_args": [
+ "--autoflake-requirements"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--requirements"],
+ "unscoped_cmd_line_args": [
+ "--requirements"
+ ],
"value_history": {
"ranked_values": [
{
@@ -560,16 +666,24 @@
"default": false,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--[no-]autoflake-skip"],
+ "display_args": [
+ "--[no-]autoflake-skip"
+ ],
"env_var": "PANTS_AUTOFLAKE_SKIP",
"fromfile": false,
"help": "If true, don't use Autoflake when running `pants fmt` and `pants lint`.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--autoflake-skip", "--no-autoflake-skip"],
+ "scoped_cmd_line_args": [
+ "--autoflake-skip",
+ "--no-autoflake-skip"
+ ],
"target_field_name": null,
"typ": "bool",
- "unscoped_cmd_line_args": ["--skip", "--no-skip"],
+ "unscoped_cmd_line_args": [
+ "--skip",
+ "--no-skip"
+ ],
"value_history": {
"ranked_values": [
{
@@ -585,6 +699,47 @@
]
}
},
+ "PANTS_AVRO_TAILOR": {
+ "choices": null,
+ "comma_separated_choices": null,
+ "comma_separated_display_args": "--[no-]avro-tailor",
+ "config_key": "tailor",
+ "default": true,
+ "deprecated_message": null,
+ "deprecation_active": false,
+ "display_args": [
+ "--[no-]avro-tailor"
+ ],
+ "env_var": "PANTS_AVRO_TAILOR",
+ "fromfile": false,
+ "help": "If true, add `avro_sources` targets with the `tailor` goal.",
+ "removal_hint": null,
+ "removal_version": null,
+ "scoped_cmd_line_args": [
+ "--avro-tailor",
+ "--no-avro-tailor"
+ ],
+ "target_field_name": null,
+ "typ": "bool",
+ "unscoped_cmd_line_args": [
+ "--tailor",
+ "--no-tailor"
+ ],
+ "value_history": {
+ "ranked_values": [
+ {
+ "details": null,
+ "rank": "NONE",
+ "value": null
+ },
+ {
+ "details": null,
+ "rank": "HARDCODED",
+ "value": true
+ }
+ ]
+ }
+ },
"PANTS_BACKEND_PACKAGES": {
"choices": null,
"comma_separated_choices": null,
@@ -593,16 +748,22 @@
"default": [],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--backend-packages=\"['', '', ...]\""],
+ "display_args": [
+ "--backend-packages=\"['', '', ...]\""
+ ],
"env_var": "PANTS_BACKEND_PACKAGES",
"fromfile": false,
"help": "Register functionality from these backends.\n\nThe backend packages must be present on the PYTHONPATH, typically because they are in the Pants core dist, in a plugin dist, or available as sources in the repo.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--backend-packages"],
+ "scoped_cmd_line_args": [
+ "--backend-packages"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--backend-packages"],
+ "unscoped_cmd_line_args": [
+ "--backend-packages"
+ ],
"value_history": {
"ranked_values": [
{
@@ -615,52 +776,74 @@
"rank": "HARDCODED",
"value": []
},
- {
- "details": "from env var PANTS_BACKEND_PACKAGES",
- "rank": "ENVIRONMENT",
- "value": []
- },
{
"details": "from command-line flag",
"rank": "FLAG",
"value": [
+ "pants.backend.awslambda.python",
"pants.backend.build_files.fix.deprecations",
"pants.backend.build_files.fmt.black",
"pants.backend.build_files.fmt.buildifier",
"pants.backend.build_files.fmt.yapf",
- "pants.backend.awslambda.python",
"pants.backend.codegen.protobuf.lint.buf",
"pants.backend.codegen.protobuf.python",
"pants.backend.codegen.thrift.apache.python",
"pants.backend.docker",
"pants.backend.docker.lint.hadolint",
"pants.backend.experimental.adhoc",
+ "pants.backend.experimental.cc",
+ "pants.backend.experimental.cc.lint.clangformat",
+ "pants.backend.experimental.codegen.avro.java",
"pants.backend.experimental.codegen.protobuf.go",
"pants.backend.experimental.codegen.protobuf.java",
"pants.backend.experimental.codegen.protobuf.scala",
+ "pants.backend.experimental.codegen.thrift.apache.java",
+ "pants.backend.experimental.codegen.thrift.scrooge.java",
+ "pants.backend.experimental.codegen.thrift.scrooge.scala",
+ "pants.backend.experimental.cue",
+ "pants.backend.experimental.debian",
"pants.backend.experimental.go",
+ "pants.backend.experimental.go.debug_goals",
+ "pants.backend.experimental.go.lint.golangci_lint",
+ "pants.backend.experimental.go.lint.vet",
"pants.backend.experimental.helm",
+ "pants.backend.experimental.helm.check.kubeconform",
"pants.backend.experimental.java",
+ "pants.backend.experimental.java.debug_goals",
"pants.backend.experimental.java.lint.google_java_format",
+ "pants.backend.experimental.javascript",
+ "pants.backend.experimental.javascript.lint.prettier",
"pants.backend.experimental.kotlin",
+ "pants.backend.experimental.kotlin.debug_goals",
"pants.backend.experimental.kotlin.lint.ktlint",
"pants.backend.experimental.openapi",
+ "pants.backend.experimental.openapi.codegen.java",
"pants.backend.experimental.openapi.lint.openapi_format",
"pants.backend.experimental.openapi.lint.spectral",
"pants.backend.experimental.python",
+ "pants.backend.experimental.python.framework.django",
"pants.backend.experimental.python.framework.stevedore",
"pants.backend.experimental.python.lint.add_trailing_comma",
+ "pants.backend.experimental.python.lint.autoflake",
+ "pants.backend.experimental.python.lint.pyupgrade",
"pants.backend.experimental.python.lint.ruff",
"pants.backend.experimental.python.packaging.pyoxidizer",
+ "pants.backend.experimental.python.typecheck.pyright",
"pants.backend.experimental.python.typecheck.pytype",
+ "pants.backend.experimental.rust",
"pants.backend.experimental.scala",
+ "pants.backend.experimental.scala.debug_goals",
"pants.backend.experimental.scala.lint.scalafmt",
+ "pants.backend.experimental.swift",
"pants.backend.experimental.terraform",
+ "pants.backend.experimental.terraform.lint.tfsec",
"pants.backend.experimental.tools.semgrep",
"pants.backend.experimental.tools.workunit_logger",
"pants.backend.experimental.tools.yamllint",
+ "pants.backend.experimental.visibility",
"pants.backend.google_cloud_function.python",
"pants.backend.plugin_development",
+ "pants.backend.project_info",
"pants.backend.python",
"pants.backend.python.lint.autoflake",
"pants.backend.python.lint.bandit",
@@ -673,11 +856,16 @@
"pants.backend.python.lint.pyupgrade",
"pants.backend.python.lint.yapf",
"pants.backend.python.mixed_interpreter_constraints",
+ "pants.backend.python.providers.experimental.pyenv",
+ "pants.backend.python.providers.experimental.pyenv.custom_install",
"pants.backend.python.typecheck.mypy",
"pants.backend.shell",
"pants.backend.shell.lint.shellcheck",
"pants.backend.shell.lint.shfmt",
- "pants.backend.tools.preamble"
+ "pants.backend.tools.preamble",
+ "pants.backend.tools.taplo",
+ "pants.backend.url_handlers.s3",
+ "pants.core"
]
}
]
@@ -691,16 +879,22 @@
"default": [],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--bandit-args=\"[, , ...]\""],
+ "display_args": [
+ "--bandit-args=\"[, , ...]\""
+ ],
"env_var": "PANTS_BANDIT_ARGS",
"fromfile": false,
"help": "Arguments to pass directly to Bandit, e.g. `--bandit-args='--skip B101,B308 --confidence'`.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--bandit-args"],
+ "scoped_cmd_line_args": [
+ "--bandit-args"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--args"],
+ "unscoped_cmd_line_args": [
+ "--args"
+ ],
"value_history": {
"ranked_values": [
{
@@ -724,16 +918,22 @@
"default": null,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--bandit-config="],
+ "display_args": [
+ "--bandit-config="
+ ],
"env_var": "PANTS_BANDIT_CONFIG",
"fromfile": false,
"help": "Path to a Bandit YAML config file (https://bandit.readthedocs.io/en/latest/config.html).",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--bandit-config"],
+ "scoped_cmd_line_args": [
+ "--bandit-config"
+ ],
"target_field_name": null,
"typ": "file_option",
- "unscoped_cmd_line_args": ["--config"],
+ "unscoped_cmd_line_args": [
+ "--config"
+ ],
"value_history": {
"ranked_values": [
{
@@ -752,16 +952,22 @@
"default": "bandit",
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--bandit-console-script="],
+ "display_args": [
+ "--bandit-console-script="
+ ],
"env_var": "PANTS_BANDIT_CONSOLE_SCRIPT",
"fromfile": false,
"help": "The console script for the tool. Using this option is generally preferable to (and mutually exclusive with) specifying an `--entry-point` since console script names have a higher expectation of staying stable across releases of the tool. Usually, you will not want to change this from the default.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--bandit-console-script"],
+ "scoped_cmd_line_args": [
+ "--bandit-console-script"
+ ],
"target_field_name": null,
"typ": "str",
- "unscoped_cmd_line_args": ["--console-script"],
+ "unscoped_cmd_line_args": [
+ "--console-script"
+ ],
"value_history": {
"ranked_values": [
{
@@ -785,16 +991,22 @@
"default": null,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--bandit-entry-point="],
+ "display_args": [
+ "--bandit-entry-point="
+ ],
"env_var": "PANTS_BANDIT_ENTRY_POINT",
"fromfile": false,
"help": "The entry point for the tool. Generally you only want to use this option if the tool does not offer a `--console-script` (which this option is mutually exclusive with). Usually, you will not want to change this from the default.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--bandit-entry-point"],
+ "scoped_cmd_line_args": [
+ "--bandit-entry-point"
+ ],
"target_field_name": null,
"typ": "str",
- "unscoped_cmd_line_args": ["--entry-point"],
+ "unscoped_cmd_line_args": [
+ "--entry-point"
+ ],
"value_history": {
"ranked_values": [
{
@@ -813,16 +1025,22 @@
"default": null,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--bandit-install-from-resolve="],
+ "display_args": [
+ "--bandit-install-from-resolve="
+ ],
"env_var": "PANTS_BANDIT_INSTALL_FROM_RESOLVE",
"fromfile": false,
"help": "If specified, install the tool using the lockfile for this named resolve.\n\nThis resolve must be defined in `[python].resolves`, as described in https://www.pantsbuild.org/v2.19/docs/python-third-party-dependencies#user-lockfiles.\n\nThe resolve's entire lockfile will be installed, unless specific requirements are listed via the `requirements` option, in which case only those requirements will be installed. This is useful if you don't want to invalidate the tool's outputs when the resolve incurs changes to unrelated requirements.\n\nIf unspecified, and the `lockfile` option is unset, the tool will be installed using the default lockfile shipped with Pants.\n\nIf unspecified, and the `lockfile` option is set, the tool will use the custom `bandit` \"tool lockfile\" generated from the `version` and `extra_requirements` options. But note that this mechanism is deprecated.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--bandit-install-from-resolve"],
+ "scoped_cmd_line_args": [
+ "--bandit-install-from-resolve"
+ ],
"target_field_name": null,
"typ": "str",
- "unscoped_cmd_line_args": ["--install-from-resolve"],
+ "unscoped_cmd_line_args": [
+ "--install-from-resolve"
+ ],
"value_history": {
"ranked_values": [
{
@@ -841,16 +1059,22 @@
"default": [],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--bandit-requirements=\"['', '', ...]\""],
+ "display_args": [
+ "--bandit-requirements=\"['', '', ...]\""
+ ],
"env_var": "PANTS_BANDIT_REQUIREMENTS",
"fromfile": false,
"help": "If `install_from_resolve` is specified, install these requirements, at the versions provided by the specified resolve's lockfile.\n\nValues can be pip-style requirements (e.g., `tool` or `tool==1.2.3` or `tool>=1.2.3`), or addresses of `python_requirement` targets (or targets that generate or depend on `python_requirement` targets).\n\nThe lockfile will be validated against the requirements - if a lockfile doesn't provide the requirement (at a suitable version, if the requirement specifies version constraints) Pants will error.\n\nIf unspecified, install the entire lockfile.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--bandit-requirements"],
+ "scoped_cmd_line_args": [
+ "--bandit-requirements"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--requirements"],
+ "unscoped_cmd_line_args": [
+ "--requirements"
+ ],
"value_history": {
"ranked_values": [
{
@@ -874,16 +1098,24 @@
"default": false,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--[no-]bandit-skip"],
+ "display_args": [
+ "--[no-]bandit-skip"
+ ],
"env_var": "PANTS_BANDIT_SKIP",
"fromfile": false,
"help": "If true, don't use Bandit when running `pants lint`.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--bandit-skip", "--no-bandit-skip"],
+ "scoped_cmd_line_args": [
+ "--bandit-skip",
+ "--no-bandit-skip"
+ ],
"target_field_name": null,
"typ": "bool",
- "unscoped_cmd_line_args": ["--skip", "--no-skip"],
+ "unscoped_cmd_line_args": [
+ "--skip",
+ "--no-skip"
+ ],
"value_history": {
"ranked_values": [
{
@@ -907,16 +1139,22 @@
"default": "pants",
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--pants-bin-name="],
+ "display_args": [
+ "--pants-bin-name="
+ ],
"env_var": "PANTS_BIN_NAME",
"fromfile": false,
"help": "The name of the script or binary used to invoke Pants. Useful when printing help messages.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--pants-bin-name"],
+ "scoped_cmd_line_args": [
+ "--pants-bin-name"
+ ],
"target_field_name": null,
"typ": "str",
- "unscoped_cmd_line_args": ["--pants-bin-name"],
+ "unscoped_cmd_line_args": [
+ "--pants-bin-name"
+ ],
"value_history": {
"ranked_values": [
{
@@ -932,7 +1170,7 @@
{
"details": "from env var PANTS_BIN_NAME",
"rank": "ENVIRONMENT",
- "value": "/home/josh/work/scie-pants/dist/pants"
+ "value": "pants"
}
]
}
@@ -945,16 +1183,22 @@
"default": [],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--black-args=\"[, , ...]\""],
+ "display_args": [
+ "--black-args=\"[, , ...]\""
+ ],
"env_var": "PANTS_BLACK_ARGS",
"fromfile": false,
"help": "Arguments to pass directly to Black, e.g. `--black-args='--target-version=py37 --quiet'`.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--black-args"],
+ "scoped_cmd_line_args": [
+ "--black-args"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--args"],
+ "unscoped_cmd_line_args": [
+ "--args"
+ ],
"value_history": {
"ranked_values": [
{
@@ -978,16 +1222,22 @@
"default": null,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--black-config="],
+ "display_args": [
+ "--black-config="
+ ],
"env_var": "PANTS_BLACK_CONFIG",
"fromfile": false,
"help": "Path to a TOML config file understood by Black (https://github.com/psf/black#configuration-format).\n\nSetting this option will disable `[black].config_discovery`. Use this option if the config is located in a non-standard location.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--black-config"],
+ "scoped_cmd_line_args": [
+ "--black-config"
+ ],
"target_field_name": null,
"typ": "file_option",
- "unscoped_cmd_line_args": ["--config"],
+ "unscoped_cmd_line_args": [
+ "--config"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1006,7 +1256,9 @@
"default": true,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--[no-]black-config-discovery"],
+ "display_args": [
+ "--[no-]black-config-discovery"
+ ],
"env_var": "PANTS_BLACK_CONFIG_DISCOVERY",
"fromfile": false,
"help": "If true, Pants will include any relevant pyproject.toml config files during runs.\n\nUse `[black].config` instead if your config is in a non-standard location.",
@@ -1018,7 +1270,10 @@
],
"target_field_name": null,
"typ": "bool",
- "unscoped_cmd_line_args": ["--config-discovery", "--no-config-discovery"],
+ "unscoped_cmd_line_args": [
+ "--config-discovery",
+ "--no-config-discovery"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1042,16 +1297,22 @@
"default": "black",
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--black-console-script="],
+ "display_args": [
+ "--black-console-script="
+ ],
"env_var": "PANTS_BLACK_CONSOLE_SCRIPT",
"fromfile": false,
"help": "The console script for the tool. Using this option is generally preferable to (and mutually exclusive with) specifying an `--entry-point` since console script names have a higher expectation of staying stable across releases of the tool. Usually, you will not want to change this from the default.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--black-console-script"],
+ "scoped_cmd_line_args": [
+ "--black-console-script"
+ ],
"target_field_name": null,
"typ": "str",
- "unscoped_cmd_line_args": ["--console-script"],
+ "unscoped_cmd_line_args": [
+ "--console-script"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1075,16 +1336,22 @@
"default": null,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--black-entry-point="],
+ "display_args": [
+ "--black-entry-point="
+ ],
"env_var": "PANTS_BLACK_ENTRY_POINT",
"fromfile": false,
"help": "The entry point for the tool. Generally you only want to use this option if the tool does not offer a `--console-script` (which this option is mutually exclusive with). Usually, you will not want to change this from the default.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--black-entry-point"],
+ "scoped_cmd_line_args": [
+ "--black-entry-point"
+ ],
"target_field_name": null,
"typ": "str",
- "unscoped_cmd_line_args": ["--entry-point"],
+ "unscoped_cmd_line_args": [
+ "--entry-point"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1103,16 +1370,22 @@
"default": null,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--black-install-from-resolve="],
+ "display_args": [
+ "--black-install-from-resolve="
+ ],
"env_var": "PANTS_BLACK_INSTALL_FROM_RESOLVE",
"fromfile": false,
"help": "If specified, install the tool using the lockfile for this named resolve.\n\nThis resolve must be defined in `[python].resolves`, as described in https://www.pantsbuild.org/v2.19/docs/python-third-party-dependencies#user-lockfiles.\n\nThe resolve's entire lockfile will be installed, unless specific requirements are listed via the `requirements` option, in which case only those requirements will be installed. This is useful if you don't want to invalidate the tool's outputs when the resolve incurs changes to unrelated requirements.\n\nIf unspecified, and the `lockfile` option is unset, the tool will be installed using the default lockfile shipped with Pants.\n\nIf unspecified, and the `lockfile` option is set, the tool will use the custom `black` \"tool lockfile\" generated from the `version` and `extra_requirements` options. But note that this mechanism is deprecated.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--black-install-from-resolve"],
+ "scoped_cmd_line_args": [
+ "--black-install-from-resolve"
+ ],
"target_field_name": null,
"typ": "str",
- "unscoped_cmd_line_args": ["--install-from-resolve"],
+ "unscoped_cmd_line_args": [
+ "--install-from-resolve"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1128,7 +1401,9 @@
"comma_separated_choices": null,
"comma_separated_display_args": "--black-interpreter-constraints=\"['', '', ...]\"",
"config_key": "interpreter_constraints",
- "default": ["CPython>=3.7,<4"],
+ "default": [
+ "CPython>=3.7,<4"
+ ],
"deprecated_message": null,
"deprecation_active": false,
"display_args": [
@@ -1139,10 +1414,14 @@
"help": "Python interpreter constraints for this tool.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--black-interpreter-constraints"],
+ "scoped_cmd_line_args": [
+ "--black-interpreter-constraints"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--interpreter-constraints"],
+ "unscoped_cmd_line_args": [
+ "--interpreter-constraints"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1153,7 +1432,9 @@
{
"details": "",
"rank": "HARDCODED",
- "value": ["CPython>=3.7,<4"]
+ "value": [
+ "CPython>=3.7,<4"
+ ]
}
]
}
@@ -1166,16 +1447,22 @@
"default": [],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--black-requirements=\"['', '', ...]\""],
+ "display_args": [
+ "--black-requirements=\"['', '', ...]\""
+ ],
"env_var": "PANTS_BLACK_REQUIREMENTS",
"fromfile": false,
"help": "If `install_from_resolve` is specified, install these requirements, at the versions provided by the specified resolve's lockfile.\n\nValues can be pip-style requirements (e.g., `tool` or `tool==1.2.3` or `tool>=1.2.3`), or addresses of `python_requirement` targets (or targets that generate or depend on `python_requirement` targets).\n\nThe lockfile will be validated against the requirements - if a lockfile doesn't provide the requirement (at a suitable version, if the requirement specifies version constraints) Pants will error.\n\nIf unspecified, install the entire lockfile.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--black-requirements"],
+ "scoped_cmd_line_args": [
+ "--black-requirements"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--requirements"],
+ "unscoped_cmd_line_args": [
+ "--requirements"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1199,16 +1486,24 @@
"default": false,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--[no-]black-skip"],
+ "display_args": [
+ "--[no-]black-skip"
+ ],
"env_var": "PANTS_BLACK_SKIP",
"fromfile": false,
"help": "If true, don't use Black when running `pants fmt` and `pants lint`.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--black-skip", "--no-black-skip"],
+ "scoped_cmd_line_args": [
+ "--black-skip",
+ "--no-black-skip"
+ ],
"target_field_name": null,
"typ": "bool",
- "unscoped_cmd_line_args": ["--skip", "--no-skip"],
+ "unscoped_cmd_line_args": [
+ "--skip",
+ "--no-skip"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1232,16 +1527,22 @@
"default": null,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--buf-config="],
+ "display_args": [
+ "--buf-config="
+ ],
"env_var": "PANTS_BUF_CONFIG",
"fromfile": false,
"help": "Path to a config file understood by Buf (https://docs.buf.build/configuration/overview).\n\nSetting this option will disable `[buf].config_discovery`. Use this option if the config is located in a non-standard location.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--buf-config"],
+ "scoped_cmd_line_args": [
+ "--buf-config"
+ ],
"target_field_name": null,
"typ": "file_option",
- "unscoped_cmd_line_args": ["--config"],
+ "unscoped_cmd_line_args": [
+ "--config"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1260,7 +1561,9 @@
"default": true,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--[no-]buf-config-discovery"],
+ "display_args": [
+ "--[no-]buf-config-discovery"
+ ],
"env_var": "PANTS_BUF_CONFIG_DISCOVERY",
"fromfile": false,
"help": "If true, Pants will include any relevant root config files during runs (`buf.yaml`). If the json format is preferred, the path to the `buf.json` file should be provided in the config option.\n\nUse `[buf].config` instead if your config is in a non-standard location.",
@@ -1272,7 +1575,10 @@
],
"target_field_name": null,
"typ": "bool",
- "unscoped_cmd_line_args": ["--config-discovery", "--no-config-discovery"],
+ "unscoped_cmd_line_args": [
+ "--config-discovery",
+ "--no-config-discovery"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1296,16 +1602,22 @@
"default": [],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--buf-format-args=\"[, , ...]\""],
+ "display_args": [
+ "--buf-format-args=\"[, , ...]\""
+ ],
"env_var": "PANTS_BUF_FORMAT_ARGS",
"fromfile": false,
"help": "Arguments to pass directly to Buf, e.g. `--buf-args='--error-format json'`.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--buf-format-args"],
+ "scoped_cmd_line_args": [
+ "--buf-format-args"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--format-args"],
+ "unscoped_cmd_line_args": [
+ "--format-args"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1329,16 +1641,24 @@
"default": false,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--[no-]buf-format-skip"],
+ "display_args": [
+ "--[no-]buf-format-skip"
+ ],
"env_var": "PANTS_BUF_FORMAT_SKIP",
"fromfile": false,
"help": "If true, don't use Buf when running `pants fmt` and `pants lint`.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--buf-format-skip", "--no-buf-format-skip"],
+ "scoped_cmd_line_args": [
+ "--buf-format-skip",
+ "--no-buf-format-skip"
+ ],
"target_field_name": null,
"typ": "bool",
- "unscoped_cmd_line_args": ["--format-skip", "--no-format-skip"],
+ "unscoped_cmd_line_args": [
+ "--format-skip",
+ "--no-format-skip"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1367,16 +1687,22 @@
],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--buf-known-versions=\"['', '', ...]\""],
+ "display_args": [
+ "--buf-known-versions=\"['', '', ...]\""
+ ],
"env_var": "PANTS_BUF_KNOWN_VERSIONS",
"fromfile": false,
"help": "\nKnown versions to verify downloads against.\n\nEach element is a pipe-separated string of `version|platform|sha256|length` or\n`version|platform|sha256|length|url_override`, where:\n\n - `version` is the version string\n - `platform` is one of `[linux_arm64,linux_x86_64,macos_arm64,macos_x86_64]`\n - `sha256` is the 64-character hex representation of the expected sha256\n digest of the download file, as emitted by `shasum -a 256`\n - `length` is the expected length of the download file in bytes, as emitted by\n `wc -c`\n - (Optional) `url_override` is a specific url to use instead of the normally\n generated url for this version\n\nE.g., `3.1.2|macos_x86_64|6d0f18cd84b918c7b3edd0203e75569e0c7caecb1367bbbe409b44e28514f5be|42813`.\nand `3.1.2|macos_arm64 |aca5c1da0192e2fd46b7b55ab290a92c5f07309e7b0ebf4e45ba95731ae98291|50926|https://example.mac.org/bin/v3.1.2/mac-aarch64-v3.1.2.tgz`.\n\nValues are space-stripped, so pipes can be indented for readability if necessary.\n",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--buf-known-versions"],
+ "scoped_cmd_line_args": [
+ "--buf-known-versions"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--known-versions"],
+ "unscoped_cmd_line_args": [
+ "--known-versions"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1405,16 +1731,22 @@
"default": [],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--buf-lint-args=\"[, , ...]\""],
+ "display_args": [
+ "--buf-lint-args=\"[, , ...]\""
+ ],
"env_var": "PANTS_BUF_LINT_ARGS",
"fromfile": false,
"help": "Arguments to pass directly to Buf, e.g. `--buf-args='--error-format json'`.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--buf-lint-args"],
+ "scoped_cmd_line_args": [
+ "--buf-lint-args"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--lint-args"],
+ "unscoped_cmd_line_args": [
+ "--lint-args"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1438,16 +1770,24 @@
"default": false,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--[no-]buf-lint-skip"],
+ "display_args": [
+ "--[no-]buf-lint-skip"
+ ],
"env_var": "PANTS_BUF_LINT_SKIP",
"fromfile": false,
"help": "If true, don't use Buf when running `pants lint`.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--buf-lint-skip", "--no-buf-lint-skip"],
+ "scoped_cmd_line_args": [
+ "--buf-lint-skip",
+ "--no-buf-lint-skip"
+ ],
"target_field_name": null,
"typ": "bool",
- "unscoped_cmd_line_args": ["--lint-skip", "--no-lint-skip"],
+ "unscoped_cmd_line_args": [
+ "--lint-skip",
+ "--no-lint-skip"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1484,10 +1824,14 @@
"help": "A dictionary mapping platforms to strings to be used when generating the URL to download the tool.\n\nIn `--url-template`, anytime the `{platform}` string is used, Pants will determine the current platform, and substitute `{platform}` with the respective value from your dictionary.\n\nFor example, if you define `{\"macos_x86_64\": \"apple-darwin\", \"linux_x86_64\": \"unknown-linux\"}`, and run Pants on Linux with an intel architecture, then `{platform}` will be substituted in the `--url-template` option with `unknown-linux`.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--buf-url-platform-mapping"],
+ "scoped_cmd_line_args": [
+ "--buf-url-platform-mapping"
+ ],
"target_field_name": null,
"typ": "dict",
- "unscoped_cmd_line_args": ["--url-platform-mapping"],
+ "unscoped_cmd_line_args": [
+ "--url-platform-mapping"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1516,16 +1860,22 @@
"default": "https://github.com/bufbuild/buf/releases/download/{version}/buf-{platform}.tar.gz",
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--buf-url-template="],
+ "display_args": [
+ "--buf-url-template="
+ ],
"env_var": "PANTS_BUF_URL_TEMPLATE",
"fromfile": false,
"help": "URL to download the tool, either as a single binary file or a compressed file (e.g. zip file). You can change this to point to your own hosted file, e.g. to work with proxies or for access via the filesystem through a `file:$abspath` URL (e.g. `file:/this/is/absolute`, possibly by [templating the buildroot in a config file](https://www.pantsbuild.org/v2.19/docs/options#config-file-entries)).\n\nUse `{version}` to have the value from `--version` substituted, and `{platform}` to have a value from `--url-platform-mapping` substituted in, depending on the current platform. For example, https://github.com/.../protoc-{version}-{platform}.zip.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--buf-url-template"],
+ "scoped_cmd_line_args": [
+ "--buf-url-template"
+ ],
"target_field_name": null,
"typ": "str",
- "unscoped_cmd_line_args": ["--url-template"],
+ "unscoped_cmd_line_args": [
+ "--url-template"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1542,7 +1892,10 @@
}
},
"PANTS_BUF_USE_UNSUPPORTED_VERSION": {
- "choices": ["error", "warning"],
+ "choices": [
+ "error",
+ "warning"
+ ],
"comma_separated_choices": "error, warning",
"comma_separated_display_args": "--buf-use-unsupported-version=",
"config_key": "use_unsupported_version",
@@ -1557,10 +1910,14 @@
"help": "\nWhat action to take in case the requested version of Buf is not supported.\n\nSupported Buf versions: unspecified\n",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--buf-use-unsupported-version"],
+ "scoped_cmd_line_args": [
+ "--buf-use-unsupported-version"
+ ],
"target_field_name": null,
"typ": "UnsupportedVersionUsage",
- "unscoped_cmd_line_args": ["--use-unsupported-version"],
+ "unscoped_cmd_line_args": [
+ "--use-unsupported-version"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1584,16 +1941,22 @@
"default": "v1.3.0",
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--buf-version="],
+ "display_args": [
+ "--buf-version="
+ ],
"env_var": "PANTS_BUF_VERSION",
"fromfile": false,
"help": "Use this version of Buf.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--buf-version"],
+ "scoped_cmd_line_args": [
+ "--buf-version"
+ ],
"target_field_name": null,
"typ": "str",
- "unscoped_cmd_line_args": ["--version"],
+ "unscoped_cmd_line_args": [
+ "--version"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1617,16 +1980,22 @@
"default": [],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--buildifier-args=\"[, , ...]\""],
+ "display_args": [
+ "--buildifier-args=\"[, , ...]\""
+ ],
"env_var": "PANTS_BUILDIFIER_ARGS",
"fromfile": false,
"help": "Arguments to pass directly to Buildifier, e.g. `--buildifier-args='-lint=fix'`.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--buildifier-args"],
+ "scoped_cmd_line_args": [
+ "--buildifier-args"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--args"],
+ "unscoped_cmd_line_args": [
+ "--args"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1663,10 +2032,14 @@
"help": "\nKnown versions to verify downloads against.\n\nEach element is a pipe-separated string of `version|platform|sha256|length` or\n`version|platform|sha256|length|url_override`, where:\n\n - `version` is the version string\n - `platform` is one of `[linux_arm64,linux_x86_64,macos_arm64,macos_x86_64]`\n - `sha256` is the 64-character hex representation of the expected sha256\n digest of the download file, as emitted by `shasum -a 256`\n - `length` is the expected length of the download file in bytes, as emitted by\n `wc -c`\n - (Optional) `url_override` is a specific url to use instead of the normally\n generated url for this version\n\nE.g., `3.1.2|macos_x86_64|6d0f18cd84b918c7b3edd0203e75569e0c7caecb1367bbbe409b44e28514f5be|42813`.\nand `3.1.2|macos_arm64 |aca5c1da0192e2fd46b7b55ab290a92c5f07309e7b0ebf4e45ba95731ae98291|50926|https://example.mac.org/bin/v3.1.2/mac-aarch64-v3.1.2.tgz`.\n\nValues are space-stripped, so pipes can be indented for readability if necessary.\n",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--buildifier-known-versions"],
+ "scoped_cmd_line_args": [
+ "--buildifier-known-versions"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--known-versions"],
+ "unscoped_cmd_line_args": [
+ "--known-versions"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1695,16 +2068,24 @@
"default": false,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--[no-]buildifier-skip"],
+ "display_args": [
+ "--[no-]buildifier-skip"
+ ],
"env_var": "PANTS_BUILDIFIER_SKIP",
"fromfile": false,
"help": "If true, don't use Buildifier when running `pants fmt`.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--buildifier-skip", "--no-buildifier-skip"],
+ "scoped_cmd_line_args": [
+ "--buildifier-skip",
+ "--no-buildifier-skip"
+ ],
"target_field_name": null,
"typ": "bool",
- "unscoped_cmd_line_args": ["--skip", "--no-skip"],
+ "unscoped_cmd_line_args": [
+ "--skip",
+ "--no-skip"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1741,10 +2122,14 @@
"help": "A dictionary mapping platforms to strings to be used when generating the URL to download the tool.\n\nIn `--url-template`, anytime the `{platform}` string is used, Pants will determine the current platform, and substitute `{platform}` with the respective value from your dictionary.\n\nFor example, if you define `{\"macos_x86_64\": \"apple-darwin\", \"linux_x86_64\": \"unknown-linux\"}`, and run Pants on Linux with an intel architecture, then `{platform}` will be substituted in the `--url-template` option with `unknown-linux`.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--buildifier-url-platform-mapping"],
+ "scoped_cmd_line_args": [
+ "--buildifier-url-platform-mapping"
+ ],
"target_field_name": null,
"typ": "dict",
- "unscoped_cmd_line_args": ["--url-platform-mapping"],
+ "unscoped_cmd_line_args": [
+ "--url-platform-mapping"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1773,16 +2158,22 @@
"default": "https://github.com/bazelbuild/buildtools/releases/download/{version}/buildifier-{platform}",
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--buildifier-url-template="],
+ "display_args": [
+ "--buildifier-url-template="
+ ],
"env_var": "PANTS_BUILDIFIER_URL_TEMPLATE",
"fromfile": false,
"help": "URL to download the tool, either as a single binary file or a compressed file (e.g. zip file). You can change this to point to your own hosted file, e.g. to work with proxies or for access via the filesystem through a `file:$abspath` URL (e.g. `file:/this/is/absolute`, possibly by [templating the buildroot in a config file](https://www.pantsbuild.org/v2.19/docs/options#config-file-entries)).\n\nUse `{version}` to have the value from `--version` substituted, and `{platform}` to have a value from `--url-platform-mapping` substituted in, depending on the current platform. For example, https://github.com/.../protoc-{version}-{platform}.zip.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--buildifier-url-template"],
+ "scoped_cmd_line_args": [
+ "--buildifier-url-template"
+ ],
"target_field_name": null,
"typ": "str",
- "unscoped_cmd_line_args": ["--url-template"],
+ "unscoped_cmd_line_args": [
+ "--url-template"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1799,7 +2190,10 @@
}
},
"PANTS_BUILDIFIER_USE_UNSUPPORTED_VERSION": {
- "choices": ["error", "warning"],
+ "choices": [
+ "error",
+ "warning"
+ ],
"comma_separated_choices": "error, warning",
"comma_separated_display_args": "--buildifier-use-unsupported-version=",
"config_key": "use_unsupported_version",
@@ -1814,10 +2208,14 @@
"help": "\nWhat action to take in case the requested version of Buildifier is not supported.\n\nSupported Buildifier versions: unspecified\n",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--buildifier-use-unsupported-version"],
+ "scoped_cmd_line_args": [
+ "--buildifier-use-unsupported-version"
+ ],
"target_field_name": null,
"typ": "UnsupportedVersionUsage",
- "unscoped_cmd_line_args": ["--use-unsupported-version"],
+ "unscoped_cmd_line_args": [
+ "--use-unsupported-version"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1841,16 +2239,22 @@
"default": "5.1.0",
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--buildifier-version="],
+ "display_args": [
+ "--buildifier-version="
+ ],
"env_var": "PANTS_BUILDIFIER_VERSION",
"fromfile": false,
"help": "Use this version of Buildifier.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--buildifier-version"],
+ "scoped_cmd_line_args": [
+ "--buildifier-version"
+ ],
"target_field_name": null,
"typ": "str",
- "unscoped_cmd_line_args": ["--version"],
+ "unscoped_cmd_line_args": [
+ "--version"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1874,7 +2278,9 @@
"default": false,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--[no-]build-deprecations-fixer-skip"],
+ "display_args": [
+ "--[no-]build-deprecations-fixer-skip"
+ ],
"env_var": "PANTS_BUILD_DEPRECATIONS_FIXER_SKIP",
"fromfile": false,
"help": "If true, don't use BUILD Deprecations Fixer when running `pants fix`.",
@@ -1886,7 +2292,10 @@
],
"target_field_name": null,
"typ": "bool",
- "unscoped_cmd_line_args": ["--skip", "--no-skip"],
+ "unscoped_cmd_line_args": [
+ "--skip",
+ "--no-skip"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1918,10 +2327,14 @@
"help": "Python files to evaluate and whose symbols should be exposed to all BUILD files. See https://www.pantsbuild.org/v2.19/docs/macros.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--build-file-prelude-globs"],
+ "scoped_cmd_line_args": [
+ "--build-file-prelude-globs"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--build-file-prelude-globs"],
+ "unscoped_cmd_line_args": [
+ "--build-file-prelude-globs"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1945,16 +2358,22 @@
"default": [],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--build-ignore=\"['', '', ...]\""],
+ "display_args": [
+ "--build-ignore=\"['', '', ...]\""
+ ],
"env_var": "PANTS_BUILD_IGNORE",
"fromfile": false,
"help": "Path globs or literals to ignore when identifying BUILD files.\n\nThis does not affect any other filesystem operations; use `--pants-ignore` for that instead.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--build-ignore"],
+ "scoped_cmd_line_args": [
+ "--build-ignore"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--build-ignore"],
+ "unscoped_cmd_line_args": [
+ "--build-ignore"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1975,19 +2394,28 @@
"comma_separated_choices": null,
"comma_separated_display_args": "--build-patterns=\"['', '', ...]\"",
"config_key": "build_patterns",
- "default": ["BUILD", "BUILD.*"],
+ "default": [
+ "BUILD",
+ "BUILD.*"
+ ],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--build-patterns=\"['', '', ...]\""],
+ "display_args": [
+ "--build-patterns=\"['', '', ...]\""
+ ],
"env_var": "PANTS_BUILD_PATTERNS",
"fromfile": false,
"help": "The naming scheme for BUILD files, i.e. where you define targets.\n\nThis only sets the naming scheme, not the directory paths to look for. To add ignore patterns, use the option `[GLOBAL].build_ignore`.\n\nYou may also need to update the option `[tailor].build_file_name` so that it is compatible with this option.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--build-patterns"],
+ "scoped_cmd_line_args": [
+ "--build-patterns"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--build-patterns"],
+ "unscoped_cmd_line_args": [
+ "--build-patterns"
+ ],
"value_history": {
"ranked_values": [
{
@@ -1998,29 +2426,42 @@
{
"details": "",
"rank": "HARDCODED",
- "value": ["BUILD", "BUILD.*"]
+ "value": [
+ "BUILD",
+ "BUILD.*"
+ ]
}
]
}
},
"PANTS_CACHE_CONTENT_BEHAVIOR": {
- "choices": ["fetch", "validate", "defer"],
+ "choices": [
+ "fetch",
+ "validate",
+ "defer"
+ ],
"comma_separated_choices": "fetch, validate, defer",
"comma_separated_display_args": "--cache-content-behavior=",
"config_key": "cache_content_behavior",
"default": "fetch",
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--cache-content-behavior="],
+ "display_args": [
+ "--cache-content-behavior="
+ ],
"env_var": "PANTS_CACHE_CONTENT_BEHAVIOR",
"fromfile": false,
"help": "Controls how the content of cache entries is handled during process execution.\n\nWhen using a remote cache, the `fetch` behavior will fetch remote cache content from the remote store before considering the cache lookup a hit, while the `validate` behavior will only validate (for either a local or remote cache) that the content exists, without fetching it.\n\nThe `defer` behavior, on the other hand, will neither fetch nor validate the cache content before calling a cache hit a hit. This \"defers\" actually fetching the cache entry until Pants needs it (which may be never).\n\nThe `defer` mode is the most network efficient (because it will completely skip network requests in many cases), followed by the `validate` mode (since it can still skip fetching the content if no consumer ends up needing it). But both the `validate` and `defer` modes rely on an experimental feature called \"backtracking\" to attempt to recover if content later turns out to be missing (`validate` has a much narrower window for backtracking though, since content would need to disappear between validation and consumption: generally, within one `pantsd` session).",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--cache-content-behavior"],
+ "scoped_cmd_line_args": [
+ "--cache-content-behavior"
+ ],
"target_field_name": null,
"typ": "CacheContentBehavior",
- "unscoped_cmd_line_args": ["--cache-content-behavior"],
+ "unscoped_cmd_line_args": [
+ "--cache-content-behavior"
+ ],
"value_history": {
"ranked_values": [
{
@@ -2044,166 +2485,185 @@
"default": null,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--ca-certs-path="],
+ "display_args": [
+ "--ca-certs-path="
+ ],
"env_var": "PANTS_CA_CERTS_PATH",
"fromfile": false,
"help": "Path to a file containing PEM-format CA certificates used for verifying secure connections when downloading files required by a build.\n\nEven when using the `docker_environment` and `remote_environment` targets, this path will be read from the local host, and those certs will be used in the environment.\n\nThis option cannot be overridden via environment targets, so if you need a different value than what the rest of your organization is using, override the value via an environment variable, CLI argument, or `.pants.rc` file. See https://www.pantsbuild.org/v2.19/docs/options.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--ca-certs-path"],
+ "scoped_cmd_line_args": [
+ "--ca-certs-path"
+ ],
"target_field_name": null,
"typ": "str",
- "unscoped_cmd_line_args": ["--ca-certs-path"],
- "value_history": {
- "ranked_values": [
- {
- "details": null,
- "rank": "NONE",
- "value": null
- }
- ]
- }
- },
- "PANTS_CHANGED_DEPENDEES": {
- "choices": ["none", "direct", "transitive"],
- "comma_separated_choices": "none, direct, transitive",
- "comma_separated_display_args": "--changed-dependees=",
- "config_key": "dependees",
- "default": "none",
- "deprecated_message": "Deprecated, is scheduled to be removed in version: 2.23.0.dev0.",
- "deprecation_active": true,
- "display_args": ["--changed-dependees="],
- "env_var": "PANTS_CHANGED_DEPENDEES",
- "fromfile": false,
- "help": "Include direct or transitive dependents of changed targets.",
- "removal_hint": "Use --dependents instead",
- "removal_version": "2.23.0.dev0",
- "scoped_cmd_line_args": ["--changed-dependees"],
- "target_field_name": null,
- "typ": "DependentsOption",
- "unscoped_cmd_line_args": ["--dependees"],
+ "unscoped_cmd_line_args": [
+ "--ca-certs-path"
+ ],
"value_history": {
"ranked_values": [
{
"details": null,
"rank": "NONE",
"value": null
- },
- {
- "details": null,
- "rank": "HARDCODED",
- "value": "none"
}
]
}
},
- "PANTS_CHANGED_DEPENDENTS": {
- "choices": ["none", "direct", "transitive"],
- "comma_separated_choices": "none, direct, transitive",
- "comma_separated_display_args": "--changed-dependents=",
- "config_key": "dependents",
- "default": "none",
+ "PANTS_CC_CXX_COMPILER_FLAGS": {
+ "choices": null,
+ "comma_separated_choices": null,
+ "comma_separated_display_args": "--cc-cxx-compiler-flags=\"['', '', ...]\"",
+ "config_key": "cxx_compiler_flags",
+ "default": [
+ "-std=c++11"
+ ],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--changed-dependents="],
- "env_var": "PANTS_CHANGED_DEPENDENTS",
+ "display_args": [
+ "--cc-cxx-compiler-flags=\"['', '', ...]\""
+ ],
+ "env_var": "PANTS_CC_CXX_COMPILER_FLAGS",
"fromfile": false,
- "help": "Include direct or transitive dependents of changed targets.",
+ "help": "Flags passed to the C++ compiler. These flags are merged with the target-level defines, with the target-level flags taking precedence.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--changed-dependents"],
+ "scoped_cmd_line_args": [
+ "--cc-cxx-compiler-flags"
+ ],
"target_field_name": null,
- "typ": "DependentsOption",
- "unscoped_cmd_line_args": ["--dependents"],
+ "typ": "list",
+ "unscoped_cmd_line_args": [
+ "--cxx-compiler-flags"
+ ],
"value_history": {
"ranked_values": [
{
- "details": null,
+ "details": "",
"rank": "NONE",
- "value": null
+ "value": []
},
{
- "details": null,
+ "details": "",
"rank": "HARDCODED",
- "value": "none"
+ "value": [
+ "-std=c++11"
+ ]
}
]
}
},
- "PANTS_CHANGED_DIFFSPEC": {
+ "PANTS_CC_CXX_DEFINITIONS": {
"choices": null,
"comma_separated_choices": null,
- "comma_separated_display_args": "--changed-diffspec=",
- "config_key": "diffspec",
- "default": null,
+ "comma_separated_display_args": "--cc-cxx-definitions=\"['', '', ...]\"",
+ "config_key": "cxx_definitions",
+ "default": [],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--changed-diffspec="],
- "env_var": "PANTS_CHANGED_DIFFSPEC",
+ "display_args": [
+ "--cc-cxx-definitions=\"['', '', ...]\""
+ ],
+ "env_var": "PANTS_CC_CXX_DEFINITIONS",
"fromfile": false,
- "help": "Calculate changes contained within a given Git spec (commit range/SHA/ref).",
+ "help": "A list of strings to define in the C++ preprocessor. Will be prefixed by -D at the command line. These defines are merged with the target-level defines, with the target-level definitions taking precedence.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--changed-diffspec"],
+ "scoped_cmd_line_args": [
+ "--cc-cxx-definitions"
+ ],
"target_field_name": null,
- "typ": "str",
- "unscoped_cmd_line_args": ["--diffspec"],
+ "typ": "list",
+ "unscoped_cmd_line_args": [
+ "--cxx-definitions"
+ ],
"value_history": {
"ranked_values": [
{
- "details": null,
+ "details": "",
"rank": "NONE",
- "value": null
+ "value": []
+ },
+ {
+ "details": "",
+ "rank": "HARDCODED",
+ "value": []
}
]
}
},
- "PANTS_CHANGED_SINCE": {
+ "PANTS_CC_CXX_EXECUTABLE": {
"choices": null,
"comma_separated_choices": null,
- "comma_separated_display_args": "--changed-since=",
- "config_key": "since",
- "default": null,
+ "comma_separated_display_args": "--cc-cxx-executable=\"['', '', ...]\"",
+ "config_key": "cxx_executable",
+ "default": [
+ "clang++",
+ "g++"
+ ],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--changed-since="],
- "env_var": "PANTS_CHANGED_SINCE",
+ "display_args": [
+ "--cc-cxx-executable=\"['', '', ...]\""
+ ],
+ "env_var": "PANTS_CC_CXX_EXECUTABLE",
"fromfile": false,
- "help": "Calculate changes since this Git spec (commit range/SHA/ref).",
+ "help": "A list of binary names for the C compiler (in the `search_paths`). The list is searched in order until a compiler is found.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--changed-since"],
+ "scoped_cmd_line_args": [
+ "--cc-cxx-executable"
+ ],
"target_field_name": null,
- "typ": "str",
- "unscoped_cmd_line_args": ["--since"],
+ "typ": "list",
+ "unscoped_cmd_line_args": [
+ "--cxx-executable"
+ ],
"value_history": {
"ranked_values": [
{
- "details": null,
+ "details": "",
"rank": "NONE",
- "value": null
+ "value": []
+ },
+ {
+ "details": "",
+ "rank": "HARDCODED",
+ "value": [
+ "clang++",
+ "g++"
+ ]
}
]
}
},
- "PANTS_CHECK_ONLY": {
+ "PANTS_CC_C_COMPILER_FLAGS": {
"choices": null,
"comma_separated_choices": null,
- "comma_separated_display_args": "--check-only=\"['', '', ...]\"",
- "config_key": "only",
- "default": [],
+ "comma_separated_display_args": "--cc-c-compiler-flags=\"['', '', ...]\"",
+ "config_key": "c_compiler_flags",
+ "default": [
+ "-std=c11"
+ ],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--check-only=\"['', '', ...]\""],
- "env_var": "PANTS_CHECK_ONLY",
+ "display_args": [
+ "--cc-c-compiler-flags=\"['', '', ...]\""
+ ],
+ "env_var": "PANTS_CC_C_COMPILER_FLAGS",
"fromfile": false,
- "help": "Only run these checkers and skip all others.\n\nThe checker names are outputted at the final summary of running this goal, e.g. `mypy` and `javac`. You can also run `check --only=fake` to get a list of all activated checkers.\n\nYou can repeat this option, e.g. `check --only=mypy --only=javac` or `check --only=['mypy', 'javac']`.",
+ "help": "Flags passed to the C compiler. These flags are merged with the target-level defines, with the target-level flags taking precedence.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--check-only"],
+ "scoped_cmd_line_args": [
+ "--cc-c-compiler-flags"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--only"],
+ "unscoped_cmd_line_args": [
+ "--c-compiler-flags"
+ ],
"value_history": {
"ranked_values": [
{
@@ -2214,128 +2674,164 @@
{
"details": "",
"rank": "HARDCODED",
- "value": []
+ "value": [
+ "-std=c11"
+ ]
}
]
}
},
- "PANTS_CLI_ALIAS": {
+ "PANTS_CC_C_DEFINITIONS": {
"choices": null,
"comma_separated_choices": null,
- "comma_separated_display_args": "--cli-alias=\"{'key1': val1, 'key2': val2, ...}\"",
- "config_key": "alias",
- "default": {},
+ "comma_separated_display_args": "--cc-c-definitions=\"['', '', ...]\"",
+ "config_key": "c_definitions",
+ "default": [],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--cli-alias=\"{'key1': val1, 'key2': val2, ...}\""],
- "env_var": "PANTS_CLI_ALIAS",
+ "display_args": [
+ "--cc-c-definitions=\"['', '', ...]\""
+ ],
+ "env_var": "PANTS_CC_C_DEFINITIONS",
"fromfile": false,
- "help": "Register command line aliases.\n\nExample:\n\n [cli.alias]\n green = \"fmt lint check\"\n all-changed = \"--changed-since=HEAD --changed-dependents=transitive\"\n\nThis would allow you to run `pants green all-changed`, which is shorthand for `pants fmt lint check --changed-since=HEAD --changed-dependents=transitive`.\n\nNotice: this option must be placed in a config file (e.g. `pants.toml` or `pantsrc`) to have any effect.",
+ "help": "A list of strings to define in the C preprocessor. Will be prefixed by -D at the command line. These defines are merged with the target-level defines, with the target-level definitions taking precedence.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--cli-alias"],
+ "scoped_cmd_line_args": [
+ "--cc-c-definitions"
+ ],
"target_field_name": null,
- "typ": "dict",
- "unscoped_cmd_line_args": ["--alias"],
+ "typ": "list",
+ "unscoped_cmd_line_args": [
+ "--c-definitions"
+ ],
"value_history": {
"ranked_values": [
{
"details": "",
"rank": "NONE",
- "value": {}
+ "value": []
},
{
"details": "",
"rank": "HARDCODED",
- "value": {}
+ "value": []
}
]
}
},
- "PANTS_COLORS": {
+ "PANTS_CC_C_EXECUTABLE": {
"choices": null,
"comma_separated_choices": null,
- "comma_separated_display_args": "--[no-]colors",
- "config_key": "colors",
- "default": false,
+ "comma_separated_display_args": "--cc-c-executable=\"['', '', ...]\"",
+ "config_key": "c_executable",
+ "default": [
+ "clang",
+ "gcc"
+ ],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--[no-]colors"],
- "env_var": "PANTS_COLORS",
+ "display_args": [
+ "--cc-c-executable=\"['', '', ...]\""
+ ],
+ "env_var": "PANTS_CC_C_EXECUTABLE",
"fromfile": false,
- "help": "Whether Pants should use colors in output or not. This may also impact whether some tools Pants runs use color.\n\nWhen unset, this value defaults based on whether the output destination supports color.",
+ "help": "A list of binary names for the C compiler (in the `search_paths`). The list is searched in order until a compiler is found.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--colors", "--no-colors"],
+ "scoped_cmd_line_args": [
+ "--cc-c-executable"
+ ],
"target_field_name": null,
- "typ": "bool",
- "unscoped_cmd_line_args": ["--colors", "--no-colors"],
+ "typ": "list",
+ "unscoped_cmd_line_args": [
+ "--c-executable"
+ ],
"value_history": {
"ranked_values": [
{
- "details": null,
+ "details": "",
"rank": "NONE",
- "value": null
+ "value": []
},
{
- "details": null,
+ "details": "",
"rank": "HARDCODED",
- "value": false
+ "value": [
+ "clang",
+ "gcc"
+ ]
}
]
}
},
- "PANTS_CONCURRENT": {
+ "PANTS_CC_EXTERNAL_CXX_COMPILER_FLAGS": {
"choices": null,
"comma_separated_choices": null,
- "comma_separated_display_args": "--[no-]concurrent",
- "config_key": "concurrent",
- "default": false,
+ "comma_separated_display_args": "--cc-external-cxx-compiler-flags=\"['', '', ...]\"",
+ "config_key": "cxx_compiler_flags",
+ "default": [
+ "-std=c++11"
+ ],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--[no-]concurrent"],
- "env_var": "PANTS_CONCURRENT",
+ "display_args": [
+ "--cc-external-cxx-compiler-flags=\"['', '', ...]\""
+ ],
+ "env_var": "PANTS_CC_EXTERNAL_CXX_COMPILER_FLAGS",
"fromfile": false,
- "help": "Enable concurrent runs of Pants. With this enabled, Pants will start up all concurrent invocations (e.g. in other terminals) without pantsd. As a result, enabling this option will increase the per-run startup cost, but will not block subsequent invocations.",
+ "help": "Flags passed to the C++ compiler. These flags are merged with the target-level defines, with the target-level flags taking precedence.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--concurrent", "--no-concurrent"],
+ "scoped_cmd_line_args": [
+ "--cc-external-cxx-compiler-flags"
+ ],
"target_field_name": null,
- "typ": "bool",
- "unscoped_cmd_line_args": ["--concurrent", "--no-concurrent"],
+ "typ": "list",
+ "unscoped_cmd_line_args": [
+ "--cxx-compiler-flags"
+ ],
"value_history": {
"ranked_values": [
{
- "details": null,
+ "details": "",
"rank": "NONE",
- "value": null
+ "value": []
},
{
- "details": null,
+ "details": "",
"rank": "HARDCODED",
- "value": false
+ "value": [
+ "-std=c++11"
+ ]
}
]
}
},
- "PANTS_CONFIG_FILES": {
+ "PANTS_CC_EXTERNAL_CXX_DEFINITIONS": {
"choices": null,
"comma_separated_choices": null,
- "comma_separated_display_args": "--pants-config-files=\"['', '', ...]\"",
- "config_key": "pants_config_files",
- "default": ["/tmp/tmp.TG08L3iBWC/pants.toml"],
+ "comma_separated_display_args": "--cc-external-cxx-definitions=\"['', '', ...]\"",
+ "config_key": "cxx_definitions",
+ "default": [],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--pants-config-files=\"['', '', ...]\""],
- "env_var": "PANTS_CONFIG_FILES",
+ "display_args": [
+ "--cc-external-cxx-definitions=\"['', '', ...]\""
+ ],
+ "env_var": "PANTS_CC_EXTERNAL_CXX_DEFINITIONS",
"fromfile": false,
- "help": "Paths to Pants config files. This may only be set through the environment variable `PANTS_CONFIG_FILES` and the command line argument `--pants-config-files`; it will be ignored if in a config file like `pants.toml`.",
+ "help": "A list of strings to define in the C++ preprocessor. Will be prefixed by -D at the command line. These defines are merged with the target-level defines, with the target-level definitions taking precedence.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--pants-config-files"],
+ "scoped_cmd_line_args": [
+ "--cc-external-cxx-definitions"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--pants-config-files"],
+ "unscoped_cmd_line_args": [
+ "--cxx-definitions"
+ ],
"value_history": {
"ranked_values": [
{
@@ -2346,91 +2842,76 @@
{
"details": "",
"rank": "HARDCODED",
- "value": ["/tmp/tmp.TG08L3iBWC/pants.toml"]
+ "value": []
}
]
}
},
- "PANTS_COURSIER_KNOWN_VERSIONS": {
+ "PANTS_CC_EXTERNAL_CXX_EXECUTABLE": {
"choices": null,
"comma_separated_choices": null,
- "comma_separated_display_args": "--coursier-known-versions=\"['', '', ...]\"",
- "config_key": "known_versions",
- "default": [
- "v2.1.6|macos_arm64 |746b3e346fa2c0107fdbc8a627890d495cb09dee4f8dcc87146bdb45941088cf|20829782|https://github.com/VirtusLab/coursier-m1/releases/download/v2.1.6/cs-aarch64-apple-darwin.gz",
- "v2.1.6|linux_arm64 |33330ca433781c9db9458e15d2d32e5d795de3437771647e26835e8b1391af82|20899290|https://github.com/VirtusLab/coursier-m1/releases/download/v2.1.6/cs-aarch64-pc-linux.gz",
- "v2.1.6|linux_x86_64|af7234f8802107f5e1130307ef8a5cc90262d392f16ddff7dce27a4ed0ddd292|20681688",
- "v2.1.6|macos_x86_64|36a5d42a0724be2ac39d0ebd8869b985e3d58ceb121bc60389ee2d6d7408dd56|20037412",
- "v2.1.0-M5-18-gfebf9838c|linux_arm64 |d4ad15ba711228041ad8a46d848c83c8fbc421d7b01c415d8022074dd609760f|19264005",
- "v2.1.0-M5-18-gfebf9838c|linux_x86_64|3e1a1ad1010d5582e9e43c5a26b273b0147baee5ebd27d3ac1ab61964041c90b|19551533",
- "v2.1.0-M5-18-gfebf9838c|macos_arm64 |d13812c5a5ef4c9b3e25cc046d18addd09bacd149f95b20a14e4d2a73e358ecf|18826510",
- "v2.1.0-M5-18-gfebf9838c|macos_x86_64|d13812c5a5ef4c9b3e25cc046d18addd09bacd149f95b20a14e4d2a73e358ecf|18826510",
- "v2.0.16-169-g194ebc55c|linux_arm64 |da38c97d55967505b8454c20a90370c518044829398b9bce8b637d194d79abb3|18114472",
- "v2.0.16-169-g194ebc55c|linux_x86_64|4c61a634c4bd2773b4543fe0fc32210afd343692891121cddb447204b48672e8|18486946",
- "v2.0.16-169-g194ebc55c|macos_arm64 |15bce235d223ef1d022da30b67b4c64e9228d236b876c834b64e029bbe824c6f|17957182",
- "v2.0.16-169-g194ebc55c|macos_x86_64|15bce235d223ef1d022da30b67b4c64e9228d236b876c834b64e029bbe824c6f|17957182"
- ],
+ "comma_separated_display_args": "--cc-external-cxx-executable=",
+ "config_key": "cxx_executable",
+ "default": "",
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--coursier-known-versions=\"['', '', ...]\""],
- "env_var": "PANTS_COURSIER_KNOWN_VERSIONS",
+ "display_args": [
+ "--cc-external-cxx-executable="
+ ],
+ "env_var": "PANTS_CC_EXTERNAL_CXX_EXECUTABLE",
"fromfile": false,
- "help": "\nKnown versions to verify downloads against.\n\nEach element is a pipe-separated string of `version|platform|sha256|length` or\n`version|platform|sha256|length|url_override`, where:\n\n - `version` is the version string\n - `platform` is one of `[linux_arm64,linux_x86_64,macos_arm64,macos_x86_64]`\n - `sha256` is the 64-character hex representation of the expected sha256\n digest of the download file, as emitted by `shasum -a 256`\n - `length` is the expected length of the download file in bytes, as emitted by\n `wc -c`\n - (Optional) `url_override` is a specific url to use instead of the normally\n generated url for this version\n\nE.g., `3.1.2|macos_x86_64|6d0f18cd84b918c7b3edd0203e75569e0c7caecb1367bbbe409b44e28514f5be|42813`.\nand `3.1.2|macos_arm64 |aca5c1da0192e2fd46b7b55ab290a92c5f07309e7b0ebf4e45ba95731ae98291|50926|https://example.mac.org/bin/v3.1.2/mac-aarch64-v3.1.2.tgz`.\n\nValues are space-stripped, so pipes can be indented for readability if necessary.\n",
+ "help": "The relative path to the C++ compiler binary from the downloaded source. E.g. For the ARM gcc-rm toolchain, this value would be: `gcc-arm-none-eabi-10.3-2021.10/bin/arm-none-eabi-g++`",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--coursier-known-versions"],
+ "scoped_cmd_line_args": [
+ "--cc-external-cxx-executable"
+ ],
"target_field_name": null,
- "typ": "list",
- "unscoped_cmd_line_args": ["--known-versions"],
+ "typ": "str",
+ "unscoped_cmd_line_args": [
+ "--cxx-executable"
+ ],
"value_history": {
"ranked_values": [
{
- "details": "",
+ "details": null,
"rank": "NONE",
- "value": []
+ "value": null
},
{
- "details": "",
+ "details": null,
"rank": "HARDCODED",
- "value": [
- "v2.1.6|macos_arm64 |746b3e346fa2c0107fdbc8a627890d495cb09dee4f8dcc87146bdb45941088cf|20829782|https://github.com/VirtusLab/coursier-m1/releases/download/v2.1.6/cs-aarch64-apple-darwin.gz",
- "v2.1.6|linux_arm64 |33330ca433781c9db9458e15d2d32e5d795de3437771647e26835e8b1391af82|20899290|https://github.com/VirtusLab/coursier-m1/releases/download/v2.1.6/cs-aarch64-pc-linux.gz",
- "v2.1.6|linux_x86_64|af7234f8802107f5e1130307ef8a5cc90262d392f16ddff7dce27a4ed0ddd292|20681688",
- "v2.1.6|macos_x86_64|36a5d42a0724be2ac39d0ebd8869b985e3d58ceb121bc60389ee2d6d7408dd56|20037412",
- "v2.1.0-M5-18-gfebf9838c|linux_arm64 |d4ad15ba711228041ad8a46d848c83c8fbc421d7b01c415d8022074dd609760f|19264005",
- "v2.1.0-M5-18-gfebf9838c|linux_x86_64|3e1a1ad1010d5582e9e43c5a26b273b0147baee5ebd27d3ac1ab61964041c90b|19551533",
- "v2.1.0-M5-18-gfebf9838c|macos_arm64 |d13812c5a5ef4c9b3e25cc046d18addd09bacd149f95b20a14e4d2a73e358ecf|18826510",
- "v2.1.0-M5-18-gfebf9838c|macos_x86_64|d13812c5a5ef4c9b3e25cc046d18addd09bacd149f95b20a14e4d2a73e358ecf|18826510",
- "v2.0.16-169-g194ebc55c|linux_arm64 |da38c97d55967505b8454c20a90370c518044829398b9bce8b637d194d79abb3|18114472",
- "v2.0.16-169-g194ebc55c|linux_x86_64|4c61a634c4bd2773b4543fe0fc32210afd343692891121cddb447204b48672e8|18486946",
- "v2.0.16-169-g194ebc55c|macos_arm64 |15bce235d223ef1d022da30b67b4c64e9228d236b876c834b64e029bbe824c6f|17957182",
- "v2.0.16-169-g194ebc55c|macos_x86_64|15bce235d223ef1d022da30b67b4c64e9228d236b876c834b64e029bbe824c6f|17957182"
- ]
+ "value": ""
}
]
}
},
- "PANTS_COURSIER_REPOS": {
+ "PANTS_CC_EXTERNAL_C_COMPILER_FLAGS": {
"choices": null,
"comma_separated_choices": null,
- "comma_separated_display_args": "--coursier-repos=\"['', '', ...]\"",
- "config_key": "repos",
+ "comma_separated_display_args": "--cc-external-c-compiler-flags=\"['', '', ...]\"",
+ "config_key": "c_compiler_flags",
"default": [
- "https://maven-central.storage-download.googleapis.com/maven2",
- "https://repo1.maven.org/maven2"
+ "-std=c11"
],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--coursier-repos=\"['', '', ...]\""],
- "env_var": "PANTS_COURSIER_REPOS",
+ "display_args": [
+ "--cc-external-c-compiler-flags=\"['', '', ...]\""
+ ],
+ "env_var": "PANTS_CC_EXTERNAL_C_COMPILER_FLAGS",
"fromfile": false,
- "help": "Maven style repositories to resolve artifacts from.\n\nCoursier will resolve these repositories in the order in which they are specifed, and re-ordering repositories will cause artifacts to be re-downloaded. This can result in artifacts in lockfiles becoming invalid.",
+ "help": "Flags passed to the C compiler. These flags are merged with the target-level defines, with the target-level flags taking precedence.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--coursier-repos"],
+ "scoped_cmd_line_args": [
+ "--cc-external-c-compiler-flags"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--repos"],
+ "unscoped_cmd_line_args": [
+ "--c-compiler-flags"
+ ],
"value_history": {
"ranked_values": [
{
@@ -2442,76 +2923,75 @@
"details": "",
"rank": "HARDCODED",
"value": [
- "https://maven-central.storage-download.googleapis.com/maven2",
- "https://repo1.maven.org/maven2"
+ "-std=c11"
]
}
]
}
},
- "PANTS_COURSIER_URL_PLATFORM_MAPPING": {
+ "PANTS_CC_EXTERNAL_C_DEFINITIONS": {
"choices": null,
"comma_separated_choices": null,
- "comma_separated_display_args": "--coursier-url-platform-mapping=\"{'key1': val1, 'key2': val2, ...}\"",
- "config_key": "url_platform_mapping",
- "default": {
- "linux_arm64": "aarch64-pc-linux",
- "linux_x86_64": "x86_64-pc-linux",
- "macos_arm64": "x86_64-apple-darwin",
- "macos_x86_64": "x86_64-apple-darwin"
- },
+ "comma_separated_display_args": "--cc-external-c-definitions=\"['', '', ...]\"",
+ "config_key": "c_definitions",
+ "default": [],
"deprecated_message": null,
"deprecation_active": false,
"display_args": [
- "--coursier-url-platform-mapping=\"{'key1': val1, 'key2': val2, ...}\""
+ "--cc-external-c-definitions=\"['', '', ...]\""
],
- "env_var": "PANTS_COURSIER_URL_PLATFORM_MAPPING",
+ "env_var": "PANTS_CC_EXTERNAL_C_DEFINITIONS",
"fromfile": false,
- "help": "A dictionary mapping platforms to strings to be used when generating the URL to download the tool.\n\nIn `--url-template`, anytime the `{platform}` string is used, Pants will determine the current platform, and substitute `{platform}` with the respective value from your dictionary.\n\nFor example, if you define `{\"macos_x86_64\": \"apple-darwin\", \"linux_x86_64\": \"unknown-linux\"}`, and run Pants on Linux with an intel architecture, then `{platform}` will be substituted in the `--url-template` option with `unknown-linux`.",
+ "help": "A list of strings to define in the C preprocessor. Will be prefixed by -D at the command line. These defines are merged with the target-level defines, with the target-level definitions taking precedence.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--coursier-url-platform-mapping"],
+ "scoped_cmd_line_args": [
+ "--cc-external-c-definitions"
+ ],
"target_field_name": null,
- "typ": "dict",
- "unscoped_cmd_line_args": ["--url-platform-mapping"],
+ "typ": "list",
+ "unscoped_cmd_line_args": [
+ "--c-definitions"
+ ],
"value_history": {
"ranked_values": [
{
"details": "",
"rank": "NONE",
- "value": {}
+ "value": []
},
{
"details": "",
"rank": "HARDCODED",
- "value": {
- "linux_arm64": "aarch64-pc-linux",
- "linux_x86_64": "x86_64-pc-linux",
- "macos_arm64": "x86_64-apple-darwin",
- "macos_x86_64": "x86_64-apple-darwin"
- }
+ "value": []
}
]
}
},
- "PANTS_COURSIER_URL_TEMPLATE": {
+ "PANTS_CC_EXTERNAL_C_EXECUTABLE": {
"choices": null,
"comma_separated_choices": null,
- "comma_separated_display_args": "--coursier-url-template=",
- "config_key": "url_template",
- "default": "https://github.com/coursier/coursier/releases/download/{version}/cs-{platform}.gz",
+ "comma_separated_display_args": "--cc-external-c-executable=",
+ "config_key": "c_executable",
+ "default": "",
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--coursier-url-template="],
- "env_var": "PANTS_COURSIER_URL_TEMPLATE",
+ "display_args": [
+ "--cc-external-c-executable="
+ ],
+ "env_var": "PANTS_CC_EXTERNAL_C_EXECUTABLE",
"fromfile": false,
- "help": "URL to download the tool, either as a single binary file or a compressed file (e.g. zip file). You can change this to point to your own hosted file, e.g. to work with proxies or for access via the filesystem through a `file:$abspath` URL (e.g. `file:/this/is/absolute`, possibly by [templating the buildroot in a config file](https://www.pantsbuild.org/v2.19/docs/options#config-file-entries)).\n\nUse `{version}` to have the value from `--version` substituted, and `{platform}` to have a value from `--url-platform-mapping` substituted in, depending on the current platform. For example, https://github.com/.../protoc-{version}-{platform}.zip.",
+ "help": "The relative path to the C compiler binary from the downloaded source. E.g. For the ARM gcc-rm toolchain, this value would be: `gcc-arm-none-eabi-10.3-2021.10/bin/arm-none-eabi-gcc`",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--coursier-url-template"],
+ "scoped_cmd_line_args": [
+ "--cc-external-c-executable"
+ ],
"target_field_name": null,
"typ": "str",
- "unscoped_cmd_line_args": ["--url-template"],
+ "unscoped_cmd_line_args": [
+ "--c-executable"
+ ],
"value_history": {
"ranked_values": [
{
@@ -2522,128 +3002,152 @@
{
"details": null,
"rank": "HARDCODED",
- "value": "https://github.com/coursier/coursier/releases/download/{version}/cs-{platform}.gz"
+ "value": ""
}
]
}
},
- "PANTS_COURSIER_USE_UNSUPPORTED_VERSION": {
- "choices": ["error", "warning"],
- "comma_separated_choices": "error, warning",
- "comma_separated_display_args": "--coursier-use-unsupported-version=",
- "config_key": "use_unsupported_version",
- "default": "error",
+ "PANTS_CC_EXTERNAL_INCLUDE_DIRECTORIES": {
+ "choices": null,
+ "comma_separated_choices": null,
+ "comma_separated_display_args": "--cc-external-include-directories=\"['', '', ...]\"",
+ "config_key": "include_directories",
+ "default": [],
"deprecated_message": null,
"deprecation_active": false,
"display_args": [
- "--coursier-use-unsupported-version="
+ "--cc-external-include-directories=\"['', '', ...]\""
],
- "env_var": "PANTS_COURSIER_USE_UNSUPPORTED_VERSION",
+ "env_var": "PANTS_CC_EXTERNAL_INCLUDE_DIRECTORIES",
"fromfile": false,
- "help": "\nWhat action to take in case the requested version of coursier is not supported.\n\nSupported coursier versions: unspecified\n",
+ "help": "A list of include directories passed to the compiler. Will be prefixed by -I at the command line. These flags are merged with the target-level includes, with the target-level includes taking precedence.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--coursier-use-unsupported-version"],
+ "scoped_cmd_line_args": [
+ "--cc-external-include-directories"
+ ],
"target_field_name": null,
- "typ": "UnsupportedVersionUsage",
- "unscoped_cmd_line_args": ["--use-unsupported-version"],
+ "typ": "list",
+ "unscoped_cmd_line_args": [
+ "--include-directories"
+ ],
"value_history": {
"ranked_values": [
{
- "details": null,
+ "details": "",
"rank": "NONE",
- "value": null
+ "value": []
},
{
- "details": null,
+ "details": "",
"rank": "HARDCODED",
- "value": "error"
+ "value": []
}
]
}
},
- "PANTS_COURSIER_VERSION": {
+ "PANTS_CC_EXTERNAL_KNOWN_VERSIONS": {
"choices": null,
"comma_separated_choices": null,
- "comma_separated_display_args": "--coursier-version=",
- "config_key": "version",
- "default": "v2.1.6",
+ "comma_separated_display_args": "--cc-external-known-versions=\"['', '', ...]\"",
+ "config_key": "known_versions",
+ "default": [],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--coursier-version="],
- "env_var": "PANTS_COURSIER_VERSION",
+ "display_args": [
+ "--cc-external-known-versions=\"['', '', ...]\""
+ ],
+ "env_var": "PANTS_CC_EXTERNAL_KNOWN_VERSIONS",
"fromfile": false,
- "help": "Use this version of coursier.",
+ "help": "\nKnown versions to verify downloads against.\n\nEach element is a pipe-separated string of `version|platform|sha256|length` or\n`version|platform|sha256|length|url_override`, where:\n\n - `version` is the version string\n - `platform` is one of `[linux_arm64,linux_x86_64,macos_arm64,macos_x86_64]`\n - `sha256` is the 64-character hex representation of the expected sha256\n digest of the download file, as emitted by `shasum -a 256`\n - `length` is the expected length of the download file in bytes, as emitted by\n `wc -c`\n - (Optional) `url_override` is a specific url to use instead of the normally\n generated url for this version\n\nE.g., `3.1.2|macos_x86_64|6d0f18cd84b918c7b3edd0203e75569e0c7caecb1367bbbe409b44e28514f5be|42813`.\nand `3.1.2|macos_arm64 |aca5c1da0192e2fd46b7b55ab290a92c5f07309e7b0ebf4e45ba95731ae98291|50926|https://example.mac.org/bin/v3.1.2/mac-aarch64-v3.1.2.tgz`.\n\nValues are space-stripped, so pipes can be indented for readability if necessary.\n",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--coursier-version"],
+ "scoped_cmd_line_args": [
+ "--cc-external-known-versions"
+ ],
"target_field_name": null,
- "typ": "str",
- "unscoped_cmd_line_args": ["--version"],
+ "typ": "list",
+ "unscoped_cmd_line_args": [
+ "--known-versions"
+ ],
"value_history": {
"ranked_values": [
{
- "details": null,
+ "details": "",
"rank": "NONE",
- "value": null
+ "value": []
},
{
- "details": null,
+ "details": "",
"rank": "HARDCODED",
- "value": "v2.1.6"
+ "value": []
}
]
}
},
- "PANTS_COVERAGE_PY_CONFIG": {
+ "PANTS_CC_EXTERNAL_URL_PLATFORM_MAPPING": {
"choices": null,
"comma_separated_choices": null,
- "comma_separated_display_args": "--coverage-py-config=",
- "config_key": "config",
- "default": null,
+ "comma_separated_display_args": "--cc-external-url-platform-mapping=\"{'key1': val1, 'key2': val2, ...}\"",
+ "config_key": "url_platform_mapping",
+ "default": {},
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--coverage-py-config="],
- "env_var": "PANTS_COVERAGE_PY_CONFIG",
+ "display_args": [
+ "--cc-external-url-platform-mapping=\"{'key1': val1, 'key2': val2, ...}\""
+ ],
+ "env_var": "PANTS_CC_EXTERNAL_URL_PLATFORM_MAPPING",
"fromfile": false,
- "help": "Path to an INI or TOML config file understood by coverage.py (https://coverage.readthedocs.io/en/stable/config.html).\n\nSetting this option will disable `[coverage-py].config_discovery`. Use this option if the config is located in a non-standard location.",
+ "help": "A dictionary mapping platforms to strings to be used when generating the URL to download the tool.\n\nIn `--url-template`, anytime the `{platform}` string is used, Pants will determine the current platform, and substitute `{platform}` with the respective value from your dictionary.\n\nFor example, if you define `{\"macos_x86_64\": \"apple-darwin\", \"linux_x86_64\": \"unknown-linux\"}`, and run Pants on Linux with an intel architecture, then `{platform}` will be substituted in the `--url-template` option with `unknown-linux`.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--coverage-py-config"],
+ "scoped_cmd_line_args": [
+ "--cc-external-url-platform-mapping"
+ ],
"target_field_name": null,
- "typ": "file_option",
- "unscoped_cmd_line_args": ["--config"],
+ "typ": "dict",
+ "unscoped_cmd_line_args": [
+ "--url-platform-mapping"
+ ],
"value_history": {
"ranked_values": [
{
- "details": null,
+ "details": "",
"rank": "NONE",
- "value": null
+ "value": {}
+ },
+ {
+ "details": "",
+ "rank": "HARDCODED",
+ "value": {}
}
]
}
},
- "PANTS_COVERAGE_PY_CONFIG_DISCOVERY": {
+ "PANTS_CC_EXTERNAL_URL_TEMPLATE": {
"choices": null,
"comma_separated_choices": null,
- "comma_separated_display_args": "--[no-]coverage-py-config-discovery",
- "config_key": "config_discovery",
- "default": true,
+ "comma_separated_display_args": "--cc-external-url-template=",
+ "config_key": "url_template",
+ "default": "",
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--[no-]coverage-py-config-discovery"],
- "env_var": "PANTS_COVERAGE_PY_CONFIG_DISCOVERY",
+ "display_args": [
+ "--cc-external-url-template="
+ ],
+ "env_var": "PANTS_CC_EXTERNAL_URL_TEMPLATE",
"fromfile": false,
- "help": "If true, Pants will include any relevant config files during runs (`.coveragerc`, `setup.cfg`, `tox.ini`, and `pyproject.toml`).\n\nUse `[coverage-py].config` instead if your config is in a non-standard location.",
+ "help": "URL to download the tool, either as a single binary file or a compressed file (e.g. zip file). You can change this to point to your own hosted file, e.g. to work with proxies or for access via the filesystem through a `file:$abspath` URL (e.g. `file:/this/is/absolute`, possibly by [templating the buildroot in a config file](https://www.pantsbuild.org/v2.19/docs/options#config-file-entries)).\n\nUse `{version}` to have the value from `--version` substituted, and `{platform}` to have a value from `--url-platform-mapping` substituted in, depending on the current platform. For example, https://github.com/.../protoc-{version}-{platform}.zip.",
"removal_hint": null,
"removal_version": null,
"scoped_cmd_line_args": [
- "--coverage-py-config-discovery",
- "--no-coverage-py-config-discovery"
+ "--cc-external-url-template"
],
"target_field_name": null,
- "typ": "bool",
- "unscoped_cmd_line_args": ["--config-discovery", "--no-config-discovery"],
+ "typ": "str",
+ "unscoped_cmd_line_args": [
+ "--url-template"
+ ],
"value_history": {
"ranked_values": [
{
@@ -2654,29 +3158,38 @@
{
"details": null,
"rank": "HARDCODED",
- "value": true
+ "value": ""
}
]
}
},
- "PANTS_COVERAGE_PY_CONSOLE_SCRIPT": {
- "choices": null,
- "comma_separated_choices": null,
- "comma_separated_display_args": "--coverage-py-console-script=",
- "config_key": "console_script",
- "default": "coverage",
+ "PANTS_CC_EXTERNAL_USE_UNSUPPORTED_VERSION": {
+ "choices": [
+ "error",
+ "warning"
+ ],
+ "comma_separated_choices": "error, warning",
+ "comma_separated_display_args": "--cc-external-use-unsupported-version=",
+ "config_key": "use_unsupported_version",
+ "default": "error",
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--coverage-py-console-script="],
- "env_var": "PANTS_COVERAGE_PY_CONSOLE_SCRIPT",
+ "display_args": [
+ "--cc-external-use-unsupported-version="
+ ],
+ "env_var": "PANTS_CC_EXTERNAL_USE_UNSUPPORTED_VERSION",
"fromfile": false,
- "help": "The console script for the tool. Using this option is generally preferable to (and mutually exclusive with) specifying an `--entry-point` since console script names have a higher expectation of staying stable across releases of the tool. Usually, you will not want to change this from the default.",
+ "help": "\nWhat action to take in case the requested version of cc-external is not supported.\n\nSupported cc-external versions: unspecified\n",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--coverage-py-console-script"],
+ "scoped_cmd_line_args": [
+ "--cc-external-use-unsupported-version"
+ ],
"target_field_name": null,
- "typ": "str",
- "unscoped_cmd_line_args": ["--console-script"],
+ "typ": "UnsupportedVersionUsage",
+ "unscoped_cmd_line_args": [
+ "--use-unsupported-version"
+ ],
"value_history": {
"ranked_values": [
{
@@ -2687,85 +3200,74 @@
{
"details": null,
"rank": "HARDCODED",
- "value": "coverage"
+ "value": "error"
}
]
}
},
- "PANTS_COVERAGE_PY_ENTRY_POINT": {
+ "PANTS_CC_EXTERNAL_VERSION": {
"choices": null,
"comma_separated_choices": null,
- "comma_separated_display_args": "--coverage-py-entry-point=",
- "config_key": "entry_point",
- "default": null,
+ "comma_separated_display_args": "--cc-external-version=",
+ "config_key": "version",
+ "default": "",
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--coverage-py-entry-point="],
- "env_var": "PANTS_COVERAGE_PY_ENTRY_POINT",
+ "display_args": [
+ "--cc-external-version="
+ ],
+ "env_var": "PANTS_CC_EXTERNAL_VERSION",
"fromfile": false,
- "help": "The entry point for the tool. Generally you only want to use this option if the tool does not offer a `--console-script` (which this option is mutually exclusive with). Usually, you will not want to change this from the default.",
+ "help": "Use this version of cc-external.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--coverage-py-entry-point"],
+ "scoped_cmd_line_args": [
+ "--cc-external-version"
+ ],
"target_field_name": null,
"typ": "str",
- "unscoped_cmd_line_args": ["--entry-point"],
+ "unscoped_cmd_line_args": [
+ "--version"
+ ],
"value_history": {
"ranked_values": [
{
"details": null,
"rank": "NONE",
"value": null
- }
- ]
- }
- },
- "PANTS_COVERAGE_PY_FAIL_UNDER": {
- "choices": null,
- "comma_separated_choices": null,
- "comma_separated_display_args": "--coverage-py-fail-under=",
- "config_key": "fail_under",
- "default": null,
- "deprecated_message": null,
- "deprecation_active": false,
- "display_args": ["--coverage-py-fail-under="],
- "env_var": "PANTS_COVERAGE_PY_FAIL_UNDER",
- "fromfile": false,
- "help": "Fail if the total combined coverage percentage for all tests is less than this number.\n\nUse this instead of setting `fail_under` in a coverage.py config file, as the config will apply to each test separately, while you typically want this to apply to the combined coverage for all tests run.\n\nNote that you must generate at least one (non-raw) coverage report for this check to trigger.\n\nNote also that if you specify a non-integral value, you must also set `[report] precision` properly in the coverage.py config file to make use of the decimal places. See https://coverage.readthedocs.io/en/latest/config.html.",
- "removal_hint": null,
- "removal_version": null,
- "scoped_cmd_line_args": ["--coverage-py-fail-under"],
- "target_field_name": null,
- "typ": "float",
- "unscoped_cmd_line_args": ["--fail-under"],
- "value_history": {
- "ranked_values": [
+ },
{
"details": null,
- "rank": "NONE",
- "value": null
+ "rank": "HARDCODED",
+ "value": ""
}
]
}
},
- "PANTS_COVERAGE_PY_FILTER": {
+ "PANTS_CC_INCLUDE_DIRECTORIES": {
"choices": null,
"comma_separated_choices": null,
- "comma_separated_display_args": "--coverage-py-filter=\"['', '', ...]\"",
- "config_key": "filter",
+ "comma_separated_display_args": "--cc-include-directories=\"['', '', ...]\"",
+ "config_key": "include_directories",
"default": [],
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--coverage-py-filter=\"['', '', ...]\""],
- "env_var": "PANTS_COVERAGE_PY_FILTER",
+ "display_args": [
+ "--cc-include-directories=\"['', '', ...]\""
+ ],
+ "env_var": "PANTS_CC_INCLUDE_DIRECTORIES",
"fromfile": false,
- "help": "A list of Python modules or filesystem paths to use in the coverage report, e.g. `['helloworld_test', 'helloworld/util/dirutil']`.\n\nBoth modules and directory paths are recursive: any submodules or child paths, respectively, will be included.\n\nIf you leave this off, the coverage report will include every file in the transitive closure of the address/file arguments; for example, `test ::` will include every Python file in your project, whereas `test project/app_test.py` will include `app_test.py` and any of its transitive dependencies.",
+ "help": "A list of include directories passed to the compiler. Will be prefixed by -I at the command line. These flags are merged with the target-level includes, with the target-level includes taking precedence.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--coverage-py-filter"],
+ "scoped_cmd_line_args": [
+ "--cc-include-directories"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--filter"],
+ "unscoped_cmd_line_args": [
+ "--include-directories"
+ ],
"value_history": {
"ranked_values": [
{
@@ -2781,27 +3283,32 @@
]
}
},
- "PANTS_COVERAGE_PY_GLOBAL_REPORT": {
+ "PANTS_CC_INFER_INCLUDES": {
"choices": null,
"comma_separated_choices": null,
- "comma_separated_display_args": "--[no-]coverage-py-global-report",
- "config_key": "global_report",
- "default": false,
+ "comma_separated_display_args": "--[no-]cc-infer-includes",
+ "config_key": "includes",
+ "default": true,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--[no-]coverage-py-global-report"],
- "env_var": "PANTS_COVERAGE_PY_GLOBAL_REPORT",
+ "display_args": [
+ "--[no-]cc-infer-includes"
+ ],
+ "env_var": "PANTS_CC_INFER_INCLUDES",
"fromfile": false,
- "help": "If true, Pants will generate a global coverage report.\n\nThe global report will include all Python source files in the workspace and not just those depended on by the tests that were run.",
+ "help": "Infer a target's dependencies by parsing #include statements from sources.",
"removal_hint": null,
"removal_version": null,
"scoped_cmd_line_args": [
- "--coverage-py-global-report",
- "--no-coverage-py-global-report"
+ "--cc-infer-includes",
+ "--no-cc-infer-includes"
],
"target_field_name": null,
"typ": "bool",
- "unscoped_cmd_line_args": ["--global-report", "--no-global-report"],
+ "unscoped_cmd_line_args": [
+ "--includes",
+ "--no-includes"
+ ],
"value_history": {
"ranked_values": [
{
@@ -2812,59 +3319,78 @@
{
"details": null,
"rank": "HARDCODED",
- "value": false
+ "value": true
}
]
}
},
- "PANTS_COVERAGE_PY_INSTALL_FROM_RESOLVE": {
+ "PANTS_CC_INFER_INCLUDE_FROM_SOURCE_ROOTS": {
"choices": null,
"comma_separated_choices": null,
- "comma_separated_display_args": "--coverage-py-install-from-resolve=",
- "config_key": "install_from_resolve",
- "default": null,
+ "comma_separated_display_args": "--[no-]cc-infer-include-from-source-roots",
+ "config_key": "include_from_source_roots",
+ "default": true,
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--coverage-py-install-from-resolve="],
- "env_var": "PANTS_COVERAGE_PY_INSTALL_FROM_RESOLVE",
+ "display_args": [
+ "--[no-]cc-infer-include-from-source-roots"
+ ],
+ "env_var": "PANTS_CC_INFER_INCLUDE_FROM_SOURCE_ROOTS",
"fromfile": false,
- "help": "If specified, install the tool using the lockfile for this named resolve.\n\nThis resolve must be defined in `[python].resolves`, as described in https://www.pantsbuild.org/v2.19/docs/python-third-party-dependencies#user-lockfiles.\n\nThe resolve's entire lockfile will be installed, unless specific requirements are listed via the `requirements` option, in which case only those requirements will be installed. This is useful if you don't want to invalidate the tool's outputs when the resolve incurs changes to unrelated requirements.\n\nIf unspecified, and the `lockfile` option is unset, the tool will be installed using the default lockfile shipped with Pants.\n\nIf unspecified, and the `lockfile` option is set, the tool will use the custom `coverage-py` \"tool lockfile\" generated from the `version` and `extra_requirements` options. But note that this mechanism is deprecated.",
+ "help": "Infer a target's dependencies by trying to include relative to source roots.\n\nAn example where this may be useful is if you have a a file at `root/include/mylib/foo.h` which may be referenced via `#include \"mylib/foo.h\"`. This option will allow you to correctly infer dependencies if you have a source root at `root/{include}` and searching for `mylib/foo.h` relative to the that source root.\n\nThe inferred files take part in compilation, and the source root is added to the compilation include search path (https://clang.llvm.org/docs/ClangCommandLineReference.html#include-path-management) with command line arguments prefixed by the '-I' flag.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--coverage-py-install-from-resolve"],
+ "scoped_cmd_line_args": [
+ "--cc-infer-include-from-source-roots",
+ "--no-cc-infer-include-from-source-roots"
+ ],
"target_field_name": null,
- "typ": "str",
- "unscoped_cmd_line_args": ["--install-from-resolve"],
+ "typ": "bool",
+ "unscoped_cmd_line_args": [
+ "--include-from-source-roots",
+ "--no-include-from-source-roots"
+ ],
"value_history": {
"ranked_values": [
{
"details": null,
"rank": "NONE",
"value": null
+ },
+ {
+ "details": null,
+ "rank": "HARDCODED",
+ "value": true
}
]
}
},
- "PANTS_COVERAGE_PY_INTERPRETER_CONSTRAINTS": {
+ "PANTS_CC_SEARCH_PATHS": {
"choices": null,
"comma_separated_choices": null,
- "comma_separated_display_args": "--coverage-py-interpreter-constraints=\"['', '', ...]\"",
- "config_key": "interpreter_constraints",
- "default": ["CPython>=3.7,<4"],
+ "comma_separated_display_args": "--cc-search-paths=\"['', '', ...]\"",
+ "config_key": "search_paths",
+ "default": [
+ ""
+ ],
"deprecated_message": null,
"deprecation_active": false,
"display_args": [
- "--coverage-py-interpreter-constraints=\"['', '', ...]\""
+ "--cc-search-paths=\"['', '', ...]\""
],
- "env_var": "PANTS_COVERAGE_PY_INTERPRETER_CONSTRAINTS",
+ "env_var": "PANTS_CC_SEARCH_PATHS",
"fromfile": false,
- "help": "Python interpreter constraints for this tool.",
+ "help": "A list of paths to search for CC toolchain binaries.\n\nSpecify absolute paths to directories, e.g. `/usr/bin`. Earlier entries will be searched first.\n\nThe following special strings are supported:\n\n * ``, the contents of the PATH environment variable",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--coverage-py-interpreter-constraints"],
+ "scoped_cmd_line_args": [
+ "--cc-search-paths"
+ ],
"target_field_name": null,
"typ": "list",
- "unscoped_cmd_line_args": ["--interpreter-constraints"],
+ "unscoped_cmd_line_args": [
+ "--search-paths"
+ ],
"value_history": {
"ranked_values": [
{
@@ -2875,29 +3401,84 @@
{
"details": "",
"rank": "HARDCODED",
- "value": ["CPython>=3.7,<4"]
+ "value": [
+ ""
+ ]
}
]
}
},
- "PANTS_COVERAGE_PY_OUTPUT_DIR": {
- "choices": null,
- "comma_separated_choices": null,
- "comma_separated_display_args": "--coverage-py-output-dir=",
- "config_key": "output_dir",
- "default": "{distdir}/coverage/python",
+ "PANTS_CHANGED_DEPENDEES": {
+ "choices": [
+ "none",
+ "direct",
+ "transitive"
+ ],
+ "comma_separated_choices": "none, direct, transitive",
+ "comma_separated_display_args": "--changed-dependees=",
+ "config_key": "dependees",
+ "default": "none",
+ "deprecated_message": "Deprecated, is scheduled to be removed in version: 2.23.0.dev0.",
+ "deprecation_active": true,
+ "display_args": [
+ "--changed-dependees="
+ ],
+ "env_var": "PANTS_CHANGED_DEPENDEES",
+ "fromfile": false,
+ "help": "Include direct or transitive dependents of changed targets.",
+ "removal_hint": "Use --dependents instead",
+ "removal_version": "2.23.0.dev0",
+ "scoped_cmd_line_args": [
+ "--changed-dependees"
+ ],
+ "target_field_name": null,
+ "typ": "DependentsOption",
+ "unscoped_cmd_line_args": [
+ "--dependees"
+ ],
+ "value_history": {
+ "ranked_values": [
+ {
+ "details": null,
+ "rank": "NONE",
+ "value": null
+ },
+ {
+ "details": null,
+ "rank": "HARDCODED",
+ "value": "none"
+ }
+ ]
+ }
+ },
+ "PANTS_CHANGED_DEPENDENTS": {
+ "choices": [
+ "none",
+ "direct",
+ "transitive"
+ ],
+ "comma_separated_choices": "none, direct, transitive",
+ "comma_separated_display_args": "--changed-dependents=",
+ "config_key": "dependents",
+ "default": "none",
"deprecated_message": null,
"deprecation_active": false,
- "display_args": ["--coverage-py-output-dir="],
- "env_var": "PANTS_COVERAGE_PY_OUTPUT_DIR",
+ "display_args": [
+ "--changed-dependents="
+ ],
+ "env_var": "PANTS_CHANGED_DEPENDENTS",
"fromfile": false,
- "help": "Path to write the Pytest Coverage report to. Must be relative to the build root.",
+ "help": "Include direct or transitive dependents of changed targets.",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--coverage-py-output-dir"],
+ "scoped_cmd_line_args": [
+ "--changed-dependents"
+ ],
"target_field_name": null,
- "typ": "str",
- "unscoped_cmd_line_args": ["--output-dir"],
+ "typ": "DependentsOption",
+ "unscoped_cmd_line_args": [
+ "--dependents"
+ ],
"value_history": {
"ranked_values": [
{
@@ -2908,66 +3489,103 @@
{
"details": null,
"rank": "HARDCODED",
- "value": "{distdir}/coverage/python"
+ "value": "none"
}
]
}
},
- "PANTS_COVERAGE_PY_REPORT": {
- "choices": ["console", "xml", "html", "raw", "json", "lcov"],
- "comma_separated_choices": "console, xml, html, raw, json, lcov",
- "comma_separated_display_args": "--coverage-py-report=\"[, , ...]\"",
- "config_key": "report",
- "default": ["console"],
+ "PANTS_CHANGED_DIFFSPEC": {
+ "choices": null,
+ "comma_separated_choices": null,
+ "comma_separated_display_args": "--changed-diffspec=",
+ "config_key": "diffspec",
+ "default": null,
"deprecated_message": null,
"deprecation_active": false,
"display_args": [
- "--coverage-py-report=\"[, , ...]\""
+ "--changed-diffspec="
],
- "env_var": "PANTS_COVERAGE_PY_REPORT",
+ "env_var": "PANTS_CHANGED_DIFFSPEC",
"fromfile": false,
- "help": "Which coverage report type(s) to emit.",
+ "help": "Calculate changes contained within a given Git spec (commit range/SHA/ref).",
"removal_hint": null,
"removal_version": null,
- "scoped_cmd_line_args": ["--coverage-py-report"],
+ "scoped_cmd_line_args": [
+ "--changed-diffspec"
+ ],
"target_field_name": null,
- "typ": "list",
- "unscoped_cmd_line_args": ["--report"],
+ "typ": "str",
+ "unscoped_cmd_line_args": [
+ "--diffspec"
+ ],
"value_history": {
"ranked_values": [
{
- "details": "",
+ "details": null,
"rank": "NONE",
- "value": []
- },
+ "value": null
+ }
+ ]
+ }
+ },
+ "PANTS_CHANGED_SINCE": {
+ "choices": null,
+ "comma_separated_choices": null,
+ "comma_separated_display_args": "--changed-since=",
+ "config_key": "since",
+ "default": null,
+ "deprecated_message": null,
+ "deprecation_active": false,
+ "display_args": [
+ "--changed-since="
+ ],
+ "env_var": "PANTS_CHANGED_SINCE",
+ "fromfile": false,
+ "help": "Calculate changes since this Git spec (commit range/SHA/ref).",
+ "removal_hint": null,
+ "removal_version": null,
+ "scoped_cmd_line_args": [
+ "--changed-since"
+ ],
+ "target_field_name": null,
+ "typ": "str",
+ "unscoped_cmd_line_args": [
+ "--since"
+ ],
+ "value_history": {
+ "ranked_values": [
{
- "details": "",
- "rank": "HARDCODED",
- "value": ["console"]
+ "details": null,
+ "rank": "NONE",
+ "value": null
}
]
}
},
- "PANTS_COVERAGE_PY_REQUIREMENTS": {
+ "PANTS_CHECK_ONLY": {
"choices": null,
"comma_separated_choices": null,
- "comma_separated_display_args": "--coverage-py-requirements=\"['', '', ...]\"",
- "config_key": "requirements",
+ "comma_separated_display_args": "--check-only=\"['