From 40c7e7a01b555d5eb84896a63d3a0024080e72a8 Mon Sep 17 00:00:00 2001 From: Peter Laird Date: Thu, 14 Oct 2021 01:28:26 -0600 Subject: [PATCH] Prepare docs for 1.5.0 release (#351) --- docs/bef/conforming_java_packages.md | 19 +++++++++++++------ docs/bef/install.md | 4 +++- 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/docs/bef/conforming_java_packages.md b/docs/bef/conforming_java_packages.md index 547a9360..5afd35ed 100644 --- a/docs/bef/conforming_java_packages.md +++ b/docs/bef/conforming_java_packages.md @@ -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. diff --git a/docs/bef/install.md b/docs/bef/install.md index e9524d14..2ce787a9 100644 --- a/docs/bef/install.md +++ b/docs/bef/install.md @@ -68,7 +68,9 @@ If you want to install the latest version of BEF, follow these steps to install - 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