fix pants.log location in docs #20547
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AlexTereshenkov
added
category:new feature
category:documentation
and removed
category:new feature
labels
There was a problem hiding this comment.
Many thanks for this! Shall we update another reference to the file? I believe that's the last reference to the old locaiton.
diff --git a/src/python/pants/engine/streaming_workunit_handler.py b/src/python/pants/engine/streaming_workunit_handler.py
index 947f30fef2..e21ac61e89 100644
--- a/src/python/pants/engine/streaming_workunit_handler.py
+++ b/src/python/pants/engine/streaming_workunit_handler.py
@@ -178,7 +178,7 @@ class WorkunitsCallback(ABC):
completed?
The main reason to `return False` is if your callback logs in its final call, when
- `finished=True`, as it may end up logging to `.pantsd.d/pants.log` instead of the console,
+ `finished=True`, as it may end up logging to `.pantsd.d/workdir/pants.log` instead of the console,
which is harder for users to find. Otherwise, most callbacks should return `True` to avoid
slowing down Pants from finishing the run.
"""
~
chris-smith-zocdoc
force-pushed
the
cs_docs
branch
from
76d1325 to
e5de145
Compare
|
Updated |
AlexTereshenkov
approved these changes
Feb 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update the
pants.logfile location after the changes in #19911