lhotari commented on a change in pull request #8892:
URL: https://github.com/apache/pulsar/pull/8892#discussion_r540196459
##########
File path: README.md
##########
@@ -153,6 +154,26 @@ To configure annotation processing in IntelliJ:
5. Install the lombok plugin in intellij.
+#### Further configuration in IntelliJ
+
+* When working on the Pulsar core modules in IntelliJ, reduce the number of
active projects in IntelliJ to speed up IDE actions and reduce unrelated IDE
warnings.
+ * In IntelliJ's Maven UI's tree view under "Profiles"
+ * Activate "core-modules" maven profile
+ * De-activate "main" maven profile
+ * Run "Reload All Maven Projects" action from the Maven UI toolbar. You
can also find the action by name in the IntelliJ "Search Everywhere" window
that gets activated by pressing the shift key twice.
+
+* Run "Generate Sources and Update Folders For All Projects" from the Maven UI
toolbar. You can also find the action by name in the IntelliJ "Search
Everywhere" window that gets activated by pressing the shift key twice. Running
the action takes about 10 minutes for all projects. This is faster when the
"core-modules" profile is the only active profile.
+
+
+#### IntelliJ usage tips
+
+* In the case of compilation errors with missing Protobuf classes, make sure
to run "Generate Sources and Update Folders For All Projects" action.
+
+* All of the Pulsar source code doesn't compile properly in IntelliJ and there
are compilation errors.
+ * Use the "core-modules" profile if working on the Pulsar core modules since
the source code for those modules can be compiled in IntelliJ.
+ * Sometimes it might help to mark a specific project ignored in IntelliJ
Maven UI by right clicking the project name and choosing "Ignore Projects".
+ * Because of the compilation issues, it's not currently possible to run all
unit tests directly from the IDE. As a workaround, individual test classes can
be run from the command line using "mvn test -Dtest=TestClassName" command.
Review comment:
Thank you for the review and suggestions @Huanli-Meng . I made a slight
change to the wording since "impossible" is a bit too strong word in this
context. I used "not always possible" instead. Please review the latest changes.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
