Skip to content

Commit

Permalink
Prepare docs for 1.5.0 release (#351)
Browse files Browse the repository at this point in the history
  • Loading branch information
plaird authored Oct 14, 2021
1 parent 0ca13a5 commit 40c7e7a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 7 deletions.
19 changes: 13 additions & 6 deletions docs/bef/conforming_java_packages.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
## Conforming Java Packages

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

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

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

- [Conforming Java Packages (SDK)](https://github.com/salesforce/bazel-java-sdk/blob/master/conforming_java_packages.md)
- src/test/java/com/salesforce/foo/FooTest.java
- source/test/com/salesforce/foo/FooTest.java
- src/tests/bar/com/salesforce/foo/FootTest.java
- my/blue/testsAndUtils/com/salesforce/foo/Foo.java

In Eclipse, test classes are placed on a test classpath, which is distinct from the main classpath of a project.
4 changes: 3 additions & 1 deletion docs/bef/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ If you want to install the latest version of BEF, follow these steps to install
<!-- markdown-link-check-disable-next-line -->
- For the location, enter: **https://opensource.salesforce.com/bazel-eclipse/update-site**
- Give the location a name, like *Bazel-Eclipse updatesite*
- Check the box next to the *Bazel Eclipse* item, then hit *Next*
- In the tree control area, open the *Bazel Eclipse* node
- Check the box next to the *Bazel Eclipse Feature* item, then hit *Next*
- Note: BEF users do not need the *BJLS Feature*. You should leave that unchecked.
- Click *Next/Agree/Finish* until it completes.
- Restart Eclipse

Expand Down

0 comments on commit 40c7e7a

Please sign in to comment.