geode-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [geode] branch develop updated: Adding IntelliJ setup instructions to (#2456)
Date Wed, 12 Sep 2018 21:37:54 GMT
This is an automated email from the ASF dual-hosted git repository.

mcmellawatt pushed a commit to branch develop
in repository

The following commit(s) were added to refs/heads/develop by this push:
     new bafaeff  Adding IntelliJ setup instructions to (#2456)
bafaeff is described below

commit bafaeffe701a45bdf032a08763ea4fe437f885ab
Author: Ryan McMahon <>
AuthorDate: Wed Sep 12 14:37:48 2018 -0700

    Adding IntelliJ setup instructions to (#2456)
    Adding IntelliJ setup instructions to
--- | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)

diff --git a/ b/
index 1086bdd..b9d396e 100644
--- a/
+++ b/
@@ -30,3 +30,60 @@ v1.1.0
 Note: on Windows invoke the `gfsh.bat` script to print the version string.
+## Setting up IntelliJ
+The following steps have been tested with:
+* **IntelliJ IDEA 2018.2.2**
+1. Run `./gradlew --parallel devBuild` from Geode repository root to create compiler generated
+2. Import project into IntelliJ IDEA
+   From the **Welcome to IntelliJ IDEA** window:
+   1. **Import Project ->** select *build.gradle* file from Geode repository root and
press **Open**.
+   2. Enable **Use auto-import**
+   3. Enable **Create separate module per source set**
+   4. Select **Use Project JDK 1.8.0_*nnn*** where *nnn* is latest build required for Geode
+3. Change Code Style Scheme to GeodeStyle
+   Navigate to **IntelliJ IDEA -> Preferences... -> Editor -> Code Style**. Select
*GeodeStyle* in Scheme drop-down box if it already exists.
+   To define the *GeodeStyle* in **Scheme**, select the gear icon next to the drop-down box,
click **Import Scheme ->** and select **IntelliJ IDEA code style XML**. Select *etc/intellij-java-modified-google-style.xml*
from Geode repository root, enter **To:** *GeodeStyle*, check **Current scheme** and press
+4. Make Apache the default Copyright
+   Navigate to **IntelliJ IDEA -> Preferences... -> Editor -> Copyright**. Select
*Apache* in drop-down box **Default project copyright**.
+   To define *Apache* in **Copyright**, navigate to **IntelliJ IDEA -> Preferences...
-> Editor -> Copyright -> Copyright Profiles**. Click **+** to add a new project.
Enter *Apache* as the **Name** and enter the following block without asterisks or leading
+   ```text
+   Licensed to the Apache Software Foundation (ASF) under one or more contributor license
+   agreements. See the NOTICE file distributed with this work for additional information
+   copyright ownership. The ASF licenses this file to You under the Apache License, Version
2.0 (the
+   "License"); you may not use this file except in compliance with the License. You may obtain
+   copy of the License at
+   Unless required by applicable law or agreed to in writing, software distributed under
the License
+   or implied. See the License for the specific language governing permissions and limitations
+   the License.
+   ```
+   ...then return to **Copyright** and select *Apache* in drop-down box **Default project
+   Navigate to **IntelliJ IDEA -> Preferences... -> Editor -> Copyright -> Formatting**.
Uncheck **Add blank line after** and press **OK**.
+5. Rebuild Project
+   Navigate to **Build -> Rebuild Project** and the full project should compile without
+   Some optional sanity tests to make sure things are working properly:
+   * Try looking up classes using **Navigate -> Class...**
+   * Open and run a distributed test such as BasicDistributedTest in geode-core.
+   * Create a new java class and ensure the Apache license is automatically added to the
top of the file with no blank line before the package line.

View raw message