Skip to content

Commit 7a2d2ce

Browse files
authored
Drop Eclipse instructions (#53667)
Hacking Elasticsearch with Eclipse is fairly broken. Some things work, but we can't in good concience point contributors to Eclipse. This drops the instrucions for Eclipse from CONTRIBUTING.md. We *do* want to fix Eclipse. But we don't see that happening in the next few months. Once we *have* fixed Eclipse we'll rewrite the instructions. Relates #53664
1 parent d63cda1 commit 7a2d2ce

File tree

1 file changed

+6
-21
lines changed

1 file changed

+6
-21
lines changed

CONTRIBUTING.md

+6-21
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,9 @@ using the wrapper via the `gradlew` script on Unix systems or `gradlew.bat`
111111
script on Windows in the root of the repository. The examples below show the
112112
usage on Unix.
113113

114-
We support development in the Eclipse and IntelliJ IDEs.
115-
For Eclipse, the minimum version that we support is [4.13][eclipse].
116-
For IntelliJ, the minimum version that we support is [IntelliJ 2017.2][intellij].
114+
We support development in IntelliJ versions [IntelliJ 2017.2][intellij] and
115+
onwards. We would like to support Eclipse, but few of us use it and has fallen
116+
into [disrepair][eclipse].
117117

118118
[Docker](https://docs.docker.com/install/) is required for building some Elasticsearch artifacts and executing certain test suites. You can run Elasticsearch without building all the artifacts with:
119119

@@ -125,11 +125,6 @@ You can access Elasticsearch with:
125125

126126
### Configuring IDEs And Running Tests
127127

128-
Eclipse users can automatically configure their IDE: `./gradlew eclipse`
129-
then `File: Import: Gradle : Existing Gradle Project`.
130-
Additionally you will want to ensure that Eclipse is using 2048m of heap by modifying
131-
`eclipse.ini` accordingly to avoid GC overhead and OOM errors.
132-
133128
IntelliJ users can automatically configure their IDE: `./gradlew idea`
134129
then `File->New Project From Existing Sources`. Point to the root of
135130
the source directory, select
@@ -154,16 +149,13 @@ The Elasticsearch codebase makes heavy use of Java `assert`s and the
154149
test runner requires that assertions be enabled within the JVM. This
155150
can be accomplished by passing the flag `-ea` to the JVM on startup.
156151

157-
For IntelliJ, go to
152+
You can enable these in IntelliJ by going to
158153
`Run->Edit Configurations...->Defaults->JUnit->VM options` and input
159154
`-ea`.
160155

161-
For Eclipse, go to `Preferences->Java->Installed JREs` and add `-ea` to
162-
`VM Arguments`.
163-
164156
Some tests related to locale testing also require the flag
165157
`-Djava.locale.providers` to be set. Set the VM options/VM arguments for
166-
IntelliJ or Eclipse like describe above to use
158+
IntelliJ like describe above to use
167159
`-Djava.locale.providers=SPI,COMPAT`.
168160

169161
### REST Endpoint Conventions
@@ -213,9 +205,6 @@ Please follow these formatting guidelines:
213205
of the code, while keeping lines to maximum length of 76 characters.
214206
* Wildcard imports (`import foo.bar.baz.*`) are forbidden and will cause
215207
the build to fail. This can be done automatically by your IDE:
216-
* Eclipse: `Preferences->Java->Code Style->Organize Imports`. There are
217-
two boxes labeled "`Number of (static )? imports needed for .*`". Set
218-
their values to 99999 or some other absurdly high value.
219208
* IntelliJ: `Preferences/Settings->Editor->Code Style->Java->Imports`.
220209
There are two configuration options: `Class count to use import with
221210
'*'` and `Names count to use static import with '*'`. Set their values
@@ -234,9 +223,6 @@ Please follow these formatting guidelines:
234223

235224
#### Editor / IDE Support
236225

237-
Eclipse IDEs can import the file [.eclipseformat.xml]
238-
directly.
239-
240226
IntelliJ IDEs can
241227
[import](https://blog.jetbrains.com/idea/2014/01/intellij-idea-13-importing-code-formatter-settings-from-eclipse/)
242228
the same settings file, and / or use the [Eclipse Code
@@ -608,6 +594,5 @@ Finally, we require that you run `./gradlew check` before submitting a
608594
non-documentation contribution. This is mentioned above, but it is worth
609595
repeating in this section because it has come up in this context.
610596

611-
[eclipse]: https://download.eclipse.org/eclipse/downloads/drops4/R-4.13-201909161045/
612597
[intellij]: https://blog.jetbrains.com/idea/2017/07/intellij-idea-2017-2-is-here-smart-sleek-and-snappy/
613-
[shadow-plugin]: https://github.com/johnrengelman/shadow
598+
[eclipse]: https://github.com/elastic/elasticsearch/issues/53664

0 commit comments

Comments
 (0)