Review InterProcessLogging.md for linguistic and formatting bugs #1786
Conversation
This file contains hidden or 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
olganaumenko
added
ctg-documentation
Domonion
requested changes
Feb 21, 2023
docs/InterProcessLogging.md
Outdated
| When UtBot is used as IDEA plugin - [`utbot-intellij/log4j2.xml`](../utbot-intellij/src/main/resources/log4j2.xml) | ||
| is used as configuration file. | ||
| In other cases(`ContestEstimator`, `Gradle/Maven` tasks, `CLI`, tests) it searches for the first `log4j2.xml` in resources in classpath. | ||
| The UnitTestBot Java logging system relies on `log4j2` utility. |
There was a problem hiding this comment.
Log4j2 is not utility - it is separate library.
docs/InterProcessLogging.md
Outdated
|
|
||
| To store log data, the UnitTestBot Java plugin creates a directory: | ||
| `org.utbot.intellij.plugin.process.EngineProcessKt.engineProcessLogDirectory`. | ||
| The IDE process writes logging information to `idea.log` files and puts them into this directory. |
There was a problem hiding this comment.
Idea.log file is not in that directory. It is deafult IDEA log file.
docs/InterProcessLogging.md
Outdated
|
|
||
| #### Engine process started separately | ||
|
|
||
| This is the case for `ContestEstimator`, `Gradle/Maven` tasks, `CLI`, tests, etc. | ||
| Configuration is taken from `log4j2.xml` in resources from the first `log4j2.xml` in resources in classpath. | ||
| When used as Contest estimator or the Gradle/Maven plugins, via CLI or for testing purposes, |
There was a problem hiding this comment.
for testing purposes
I think this will cause misunderstating. Not for testing purposes, in our tests. Tests run are running in our CI
Domonion
approved these changes
Feb 22, 2023
sofurihafe
pushed a commit
that referenced
this pull request
Feb 27, 2023
* InterProcessLogging.md reviewed for linguistic and formatting bugs * Fixed info about directories and minor wordings
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.
Description
Linguistic bugs fixed, document structure optimized.
How to test
The PR introduces no code changes.
Manual scenario: the text itself has been previewed in the IntelliJ IDEA viewer.
Self-check list
Check off the item if the statement is true. Hint: [x] is a marked item.
Please do not delete the list or its items.