Skip to content

Commit 40c7e7a

Browse files
authored
Prepare docs for 1.5.0 release (#351)
1 parent 0ca13a5 commit 40c7e7a

2 files changed

Lines changed: 16 additions & 7 deletions

File tree

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
11
## Conforming Java Packages
22

3-
In various places in our Bazel Eclipse Feature documentation, we reference the term **Conforming Java Packages**.
4-
This page defines that term.
3+
In the early days of Bazel Eclipse, we had a number of restrictions for the file structure of each Bazel package.
4+
We required it to conform to the Maven standards of storing source code in _src/main/java_ and _src/test/java_.
55

6-
### Link to the Bazel Java SDK
6+
As of Bazel Eclipse 1.5, these restrictions have been lifted.
7+
We believe BEF properly handles any reasonable file system layout for Java packages.
78

8-
Under the covers BEF uses the separately managed [Bazel Java SDK](../dev/bazeljavasdk.md) for all interactions with Bazel.
9-
For more information about conforming Java packages, please see the documentation in the SDK:
9+
The only caveat is for test source files.
10+
We mark a class as being on the Eclipse project test classpath if it lives within a directory that starts with the word 'test'.
11+
For example, these files would be considered test classes:
1012

11-
- [Conforming Java Packages (SDK)](https://github.com/salesforce/bazel-java-sdk/blob/master/conforming_java_packages.md)
13+
- src/test/java/com/salesforce/foo/FooTest.java
14+
- source/test/com/salesforce/foo/FooTest.java
15+
- src/tests/bar/com/salesforce/foo/FootTest.java
16+
- my/blue/testsAndUtils/com/salesforce/foo/Foo.java
17+
18+
In Eclipse, test classes are placed on a test classpath, which is distinct from the main classpath of a project.

docs/bef/install.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,9 @@ If you want to install the latest version of BEF, follow these steps to install
6868
<!-- markdown-link-check-disable-next-line -->
6969
- For the location, enter: **https://opensource.salesforce.com/bazel-eclipse/update-site**
7070
- Give the location a name, like *Bazel-Eclipse updatesite*
71-
- Check the box next to the *Bazel Eclipse* item, then hit *Next*
71+
- In the tree control area, open the *Bazel Eclipse* node
72+
- Check the box next to the *Bazel Eclipse Feature* item, then hit *Next*
73+
- Note: BEF users do not need the *BJLS Feature*. You should leave that unchecked.
7274
- Click *Next/Agree/Finish* until it completes.
7375
- Restart Eclipse
7476

0 commit comments

Comments
 (0)