Skip to content

Commit

Permalink
docs: Improve the help string for the global option 'PANTS_CONCURRENT…
Browse files Browse the repository at this point in the history
…'. (#19822)

Previously the text made it seem as if enabling PANTS_CONCURRENT would
force the use of pantsd and make concurrent invocations blocking, when
in reality it's the other way around.

Co-authored-by: Morten Hauge <[email protected]>
  • Loading branch information
2 people authored and WorkerPants committed Sep 12, 2023
1 parent 68d6979 commit a9eeeb3
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/python/pants/option/global_options.py
Original file line number Diff line number Diff line change
Expand Up @@ -961,9 +961,10 @@ class BootstrapOptions:
default=False,
help=softwrap(
"""
Enable concurrent runs of Pants. Without this enabled, Pants will
Enable concurrent runs of Pants. With this enabled, Pants will
start up all concurrent invocations (e.g. in other terminals) without pantsd.
Enabling this option requires parallel Pants invocations to block on the first.
As a result, enabling this option will increase the per-run startup cost, but
will not block subsequent invocations.
"""
),
)
Expand Down

0 comments on commit a9eeeb3

Please sign in to comment.