Skip to content

Commit

Permalink
undo those last 2 commits
Browse files Browse the repository at this point in the history
  • Loading branch information
thejcannon committed Jan 3, 2024
1 parent 85d1ac4 commit b44b437
Show file tree
Hide file tree
Showing 416 changed files with 23,876 additions and 11,098 deletions.
25 changes: 14 additions & 11 deletions docs/reference/global-options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,17 @@ import styles from "@site/src/components/reference/styles.module.css";

---

Options to control the overall behavior of Pants.

Backend: <span className="color--primary">`pants.core`</span>
Options to control the overall behavior of Pants.

Config section: <span className="color--primary">`[GLOBAL]`</span>
Backend: <span className="color--primary">pants.core</span>
Config section: <span className="color--primary">[GLOBAL]</span>

<span className={styles.options}>

## Basic options


### `level`

<Option
Expand Down Expand Up @@ -212,6 +213,7 @@ Run goals continuously as file changes are detected.

## Advanced options


### `backend_packages`

<Option
Expand Down Expand Up @@ -297,7 +299,6 @@ Whether to show/hide logging done by 3rdparty Rust crates used by the Pants engi
Ignore logs and warnings matching these strings.

Normally, Pants will look for literal matches from the start of the log/warning message, but you can prefix the ignore with `$regex$` for Pants to instead treat your string as a regex pattern. For example:

```
ignore_warnings = [
"DEPRECATED: option 'config' in scope 'flake8' will be removed",
Expand Down Expand Up @@ -388,7 +389,9 @@ The directory to use for tracking subprocess metadata. This should live outside
<Option
cli_repr={`--pants-config-files="['<str>', '<str>', ...]"`}
env_repr='PANTS_CONFIG_FILES'
default_repr={`[\n "<buildroot>/pants.toml"\n]`}
default_repr={`[
"/tmp/tmp.TG08L3iBWC/pants.toml"
]`}
>

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`.
Expand Down Expand Up @@ -448,10 +451,12 @@ Verify that all config file values correspond to known options.
<Option
cli_repr={`--stats-record-option-scopes="['<str>', '<str>', ...]"`}
env_repr='PANTS_STATS_RECORD_OPTION_SCOPES'
default_repr={`[\n "*"\n]`}
default_repr={`[
"*"
]`}
>

Option scopes to record in stats on run completion. Options may be selected by joining the scope and the option with a ^ character, i.e. to get option `pantsd` in the GLOBAL scope, you&#x27;d pass `GLOBAL^pantsd`. Add a &#x27;\*&#x27; to the list to capture all known scopes.
Option scopes to record in stats on run completion. Options may be selected by joining the scope and the option with a ^ character, i.e. to get option `pantsd` in the GLOBAL scope, you&#x27;d pass `GLOBAL^pantsd`. Add a &#x27;*&#x27; to the list to capture all known scopes.

</Option>

Expand Down Expand Up @@ -1298,6 +1303,7 @@ If you are using the `remote_environment` target mechanism, set this value as a

## Deprecated options


### `process_cleanup`

<Option
Expand Down Expand Up @@ -1328,8 +1334,5 @@ If specified, Pants will add a header in the format `authorization: Bearer <toke

</Option>

## Related subsystems

None

</span>
</span>
6 changes: 2 additions & 4 deletions docs/reference/goals/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,5 @@
"label": "Goals",
"link": {
"type": "generated-index",
"slug": "/reference/goals",
"title": "Goals"
}
}
"slug": "/reference/goals", "title": "Goals"
}}
12 changes: 4 additions & 8 deletions docs/reference/goals/check.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ pants check [args]

Run type checking or the lightest variant of compilation available for a language.

Backend: <span className="color--primary">`pants.core`</span>

Config section: <span className="color--primary">`[check]`</span>
Backend: <span className="color--primary">pants.core</span>
Config section: <span className="color--primary">[check]</span>

<span className={styles.options}>

## Basic options


### `only`

<Option
Expand All @@ -45,9 +45,5 @@ None

None

## Related subsystems

- [environments-preview](../subsystems/environments-preview.mdx)
- [filter](../subsystems/filter.mdx)

</span>
</span>
14 changes: 3 additions & 11 deletions docs/reference/goals/count-loc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,8 @@ pants count-loc [args]

Count lines of code.

Backend: <span className="color--primary">`pants.backend.project_info`</span>

Config section: <span className="color--primary">`[count-loc]`</span>
Backend: <span className="color--primary">pants.backend.project_info</span>
Config section: <span className="color--primary">[count-loc]</span>

<span className={styles.options}>

Expand All @@ -31,12 +30,5 @@ None

None

## Related subsystems

- [environments-preview](../subsystems/environments-preview.mdx)
- [filter](../subsystems/filter.mdx)
- [python-bootstrap](../subsystems/python-bootstrap.mdx)
- [scc](../subsystems/scc.mdx)
- [system-binaries](../subsystems/system-binaries.mdx)

</span>
</span>
13 changes: 4 additions & 9 deletions docs/reference/goals/dependees.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ pants dependees [args]

List all targets that depend on any of the input files/targets.

Backend: <span className="color--primary">`pants.backend.project_info`</span>

Config section: <span className="color--primary">`[dependees]`</span>
Backend: <span className="color--primary">pants.backend.project_info</span>
Config section: <span className="color--primary">[dependees]</span>

<span className={styles.options}>

## Basic options


### `output_file`

<Option
Expand Down Expand Up @@ -77,10 +77,5 @@ None

None

## Related subsystems

- [dependents](../goals/dependents.mdx)
- [environments-preview](../subsystems/environments-preview.mdx)
- [filter](../subsystems/filter.mdx)

</span>
</span>
12 changes: 4 additions & 8 deletions docs/reference/goals/dependencies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ pants dependencies [args]

List the dependencies of the input files/targets.

Backend: <span className="color--primary">`pants.backend.project_info`</span>

Config section: <span className="color--primary">`[dependencies]`</span>
Backend: <span className="color--primary">pants.backend.project_info</span>
Config section: <span className="color--primary">[dependencies]</span>

<span className={styles.options}>

## Basic options


### `output_file`

<Option
Expand Down Expand Up @@ -77,9 +77,5 @@ None

None

## Related subsystems

- [environments-preview](../subsystems/environments-preview.mdx)
- [filter](../subsystems/filter.mdx)

</span>
</span>
12 changes: 4 additions & 8 deletions docs/reference/goals/dependents.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ pants dependents [args]

List all targets that depend on any of the input files/targets.

Backend: <span className="color--primary">`pants.backend.project_info`</span>

Config section: <span className="color--primary">`[dependents]`</span>
Backend: <span className="color--primary">pants.backend.project_info</span>
Config section: <span className="color--primary">[dependents]</span>

<span className={styles.options}>

## Basic options


### `output_file`

<Option
Expand Down Expand Up @@ -77,9 +77,5 @@ None

None

## Related subsystems

- [environments-preview](../subsystems/environments-preview.mdx)
- [filter](../subsystems/filter.mdx)

</span>
</span>
18 changes: 9 additions & 9 deletions docs/reference/goals/experimental-bsp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ pants experimental-bsp [args]

Setup repository for Build Server Protocol (https://build-server-protocol.github.io/).

Backend: <span className="color--primary">`pants.core`</span>

Config section: <span className="color--primary">`[experimental-bsp]`</span>
Backend: <span className="color--primary">pants.core</span>
Config section: <span className="color--primary">[experimental-bsp]</span>

<span className={styles.options}>

## Basic options


### `groups_config_files`

<Option
Expand All @@ -34,7 +34,6 @@ A list of config files that define groups of Pants targets to expose to IDEs via
Pants generally uses fine-grained targets to define the components of a build (in many cases on a file-by-file basis). Many IDEs, however, favor coarse-grained targets that contain large numbers of source files. To accommodate this distinction, the Pants BSP server will compute a set of BSP build targets to use from the groups specified in the config files set for this option. Each group will become one or more BSP build targets.

Each config file is a TOML file with a `groups` dictionary with the following format for an entry:

```
# The dictionary key is used to identify the group. It must be unique.
[groups.ID1]:
Expand All @@ -49,6 +48,7 @@ addresses = [
resolve = "jvm:jvm-default"
display_name = "Display Name" # (Optional) Name shown to the user in the IDE.
base_directory = "path/from/build/root" # (Optional) Hint to the IDE for where the build target should "live."
```

Pants will merge the contents of the config files together. If the same ID is used for a group definition, in multiple config files, the definition in the latter config file will take effect.
Expand All @@ -57,6 +57,7 @@ Pants will merge the contents of the config files together. If the same ID is us

## Advanced options


### `server`

<Option
Expand All @@ -74,7 +75,9 @@ Run the Build Server Protocol server. Pants will receive BSP RPC requests via th
<Option
cli_repr={`--experimental-bsp-runner-env-vars="['<str>', '<str>', ...]"`}
env_repr='PANTS_EXPERIMENTAL_BSP_RUNNER_ENV_VARS'
default_repr={`[\n "PATH"\n]`}
default_repr={`[
"PATH"
]`}
>

Environment variables to set in the BSP runner script when setting up BSP in a repository. Entries are either strings in the form `ENV_VAR=value` to set an explicit value; or just `ENV_VAR` to copy the value from Pants&#x27; own environment when the experimental-bsp goal was run.
Expand All @@ -89,8 +92,5 @@ Note: The environment variables passed to the Pants BSP server will be those set

None

## Related subsystems

None

</span>
</span>
11 changes: 3 additions & 8 deletions docs/reference/goals/experimental-deploy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,8 @@ pants experimental-deploy [args]

Perform a deployment process.

Backend: <span className="color--primary">`pants.core`</span>

Config section: <span className="color--primary">`[experimental-deploy]`</span>
Backend: <span className="color--primary">pants.core</span>
Config section: <span className="color--primary">[experimental-deploy]</span>

<span className={styles.options}>

Expand All @@ -31,9 +30,5 @@ None

None

## Related subsystems

- [environments-preview](../subsystems/environments-preview.mdx)
- [filter](../subsystems/filter.mdx)

</span>
</span>
11 changes: 4 additions & 7 deletions docs/reference/goals/experimental-explorer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ pants experimental-explorer [args]

Run the Pants Explorer Web UI server.

Backend: <span className="color--primary">`pants.goal`</span>

Config section: <span className="color--primary">`[experimental-explorer]`</span>
Backend: <span className="color--primary">pants.goal</span>
Config section: <span className="color--primary">[experimental-explorer]</span>

<span className={styles.options}>

## Basic options


### `address`

<Option
Expand Down Expand Up @@ -53,8 +53,5 @@ None

None

## Related subsystems

None

</span>
</span>
11 changes: 3 additions & 8 deletions docs/reference/goals/export-codegen.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,8 @@ pants export-codegen [args]

Write generated files to `dist/codegen` for use outside of Pants.

Backend: <span className="color--primary">`pants.core`</span>

Config section: <span className="color--primary">`[export-codegen]`</span>
Backend: <span className="color--primary">pants.core</span>
Config section: <span className="color--primary">[export-codegen]</span>

<span className={styles.options}>

Expand All @@ -31,9 +30,5 @@ None

None

## Related subsystems

- [environments-preview](../subsystems/environments-preview.mdx)
- [filter](../subsystems/filter.mdx)

</span>
</span>
Loading

0 comments on commit b44b437

Please sign in to comment.