[jena] branch main updated: GH-1528: Add IDE section

[an...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

andy pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/jena.git


The following commit(s) were added to refs/heads/main by this push:
     new 2c119df986 GH-1528: Add IDE section
     new 019387c578 Merge pull request #1544 from afs/build-doc
2c119df986 is described below

commit 2c119df986080cadf2785b59c749a47a46765b49
Author: Andy Seaborne <an...@apache.org>
AuthorDate: Sun Sep 18 09:08:35 2022 +0100

    GH-1528: Add IDE section
---
 BUILD.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/BUILD.md b/BUILD.md
index a59565a7e2..b2fc5f4836 100644
--- a/BUILD.md
+++ b/BUILD.md
@@ -71,6 +71,28 @@ Also useful:
 
 `-Drat.skip` Skips checking for license headers; useful during development.
 
+## IDE setup
+
+### Avoid multiple imports
+
+To work with the Jena source in an IDE, it is only necessary to import modules
+of interest.
+
+When importing modules, avoid including modules twice. This happens when
+including both a module and also its parent POM because the parent POM includes
+the module within its directory tree.
+
+This happens if the top level POM is included, as well as `jena-db` and
+`jena-fuseki2` as well as `jena-extras` and `jena-jdbc`.
+
+### Avoid output modules
+
+Artifacts that provide shaded jars should not normally be imported, especially
+`jena-shaded-guava`. Other shared jars included `jena-fuseki-server` and
+`jena-fuseki-fulljar`.
+
+`jena-shaded-guava` will be obtained from a maven repository or from a local run
+of mvn.
 
 ## Build Notes