You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2020/12/10 12:41:48 UTC
[GitHub] [pulsar] Huanli-Meng commented on a change in pull request #8892: [developer docs] Improve instructions to setup Pulsar development in IntelliJ
Huanli-Meng commented on a change in pull request #8892:
URL: https://github.com/apache/pulsar/pull/8892#discussion_r540132443
##########
File path: README.md
##########
@@ -86,8 +86,9 @@ components in the Pulsar ecosystem, including connectors, adapters, and other la
## Build Pulsar
Requirements:
- * Java JDK 1.8 or Java JDK 11
- * Maven 3.3.9+
+ * Java 8 JDK (for building Pulsar)
+ * When building on newer than Java 8, the resulting artifacts are not compatible with Java 8 runtime because of issues such as https://github.com/apache/pulsar/issues/8445.
Review comment:
```suggestion
* When building Pulsar on a higher version (higher than Java 8), the resulting artifacts are not compatible with Java 8 runtime because of some issues, such as [issue 8445](https://github.com/apache/pulsar/issues/8445).
```
##########
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
Review comment:
use "Maven" instead of ""maven.Please check through the whole updates.
##########
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".
Review comment:
```suggestion
* Sometimes it might help to mark a specific project ignored in IntelliJ Maven UI by right-clicking the project name and select **Ignore Projects** from the drop-down list.
```
##########
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:
```suggestion
* Currently, it is impossible to run all unit tests directly from the IDE because of the compilation issues. As a workaround, individual test classes can be run by using the `mvn test -Dtest=TestClassName` command.
```
##########
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.
Review comment:
```suggestion
* Run the "Reload All Maven Projects" action from the Maven UI toolbar. You can also find the action by the name in the IntelliJ "Search Everywhere" window that gets activated by pressing the **Shift** key twice.
```
##########
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.
Review comment:
```suggestion
* In the case of compilation errors with missing Protobuf classes, ensure to run the "Generate Sources and Update Folders For All Projects" action.
```
##########
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.
Review comment:
```suggestion
* Run the "Generate Sources and Update Folders For All Projects" action from the Maven UI toolbar. You can also find the action by the 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.
```
----------------------------------------------------------------
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:
users@infra.apache.org